@inventure71/paddockjs 1.0.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (190) hide show
  1. package/CHANGELOG.md +52 -0
  2. package/INSTALL_AND_UPDATE.md +4 -3
  3. package/README.md +194 -12
  4. package/docs/architecture.md +119 -44
  5. package/docs/concepts.md +4 -2
  6. package/docs/custom_model_controller.md +329 -0
  7. package/docs/data_contract.md +299 -17
  8. package/docs/index.md +1 -0
  9. package/docs/learnings.md +22 -0
  10. package/docs/rules.md +37 -10
  11. package/docs/system_specs.md +23 -10
  12. package/docs/training.md +272 -30
  13. package/examples/python/README.md +62 -0
  14. package/examples/python/base_policy_server.py +191 -0
  15. package/examples/python/requirements.txt +2 -0
  16. package/package.json +12 -4
  17. package/src/api/PaddockSimulatorController.js +4 -0
  18. package/src/app/BrowserExpertAdapter.js +367 -9
  19. package/src/app/F1SimulatorApp.js +305 -1603
  20. package/src/app/banners/bannerFormatters.js +55 -0
  21. package/src/app/banners/raceDataBannerController.js +141 -0
  22. package/src/app/banners/stewardMessageController.js +99 -0
  23. package/src/app/camera/cameraConstants.js +21 -0
  24. package/src/app/camera/cameraController.js +265 -0
  25. package/src/app/camera/cameraGeometry.js +176 -0
  26. package/src/app/domBindings.js +4 -0
  27. package/src/app/readouts/carOverviewRenderer.js +109 -0
  28. package/src/app/readouts/controlStateRenderer.js +37 -0
  29. package/src/app/readouts/raceStatusRenderer.js +133 -0
  30. package/src/app/readouts/readoutFormatters.js +58 -0
  31. package/src/app/readouts/telemetryRenderer.js +113 -0
  32. package/src/app/readouts/timingTowerRenderer.js +177 -0
  33. package/src/app/rendering/appAssets.js +38 -0
  34. package/src/app/rendering/carRenderer.js +286 -0
  35. package/src/app/rendering/displayUtils.js +22 -0
  36. package/src/app/rendering/drsTrailRenderer.js +90 -0
  37. package/src/app/rendering/expertSensorRenderer.js +126 -0
  38. package/src/app/rendering/pitLaneStatusRenderer.js +50 -0
  39. package/src/app/rendering/replayGhostRenderer.js +124 -0
  40. package/src/app/rendering/trackRenderer.js +25 -0
  41. package/src/app/runtime/frameLoop.js +66 -0
  42. package/src/app/runtime/runtimeTiming.js +34 -0
  43. package/src/app/runtime/runtimeVisibility.js +45 -0
  44. package/src/config/defaultOptions.js +20 -0
  45. package/src/environment/actions.js +13 -5
  46. package/src/environment/controllerLoop.js +246 -0
  47. package/src/environment/episode.js +86 -2
  48. package/src/environment/evaluation.js +54 -32
  49. package/src/environment/index.d.ts +361 -9
  50. package/src/environment/index.js +1 -0
  51. package/src/environment/metrics.js +159 -0
  52. package/src/environment/observationOptions.js +22 -1
  53. package/src/environment/observations.js +325 -40
  54. package/src/environment/options.js +37 -5
  55. package/src/environment/runtime.js +222 -21
  56. package/src/environment/scenarios.js +37 -8
  57. package/src/environment/sensors/bodySenses.js +23 -0
  58. package/src/environment/sensors/boundarySenses.js +17 -0
  59. package/src/environment/sensors/carRays.js +75 -0
  60. package/src/environment/sensors/contactSenses.js +32 -0
  61. package/src/environment/sensors/index.js +157 -0
  62. package/src/environment/sensors/indexedRayBands.js +103 -0
  63. package/src/environment/sensors/nearbyCars.js +52 -0
  64. package/src/environment/sensors/opponentRadar.js +65 -0
  65. package/src/environment/sensors/rayConfig.js +110 -0
  66. package/src/environment/sensors/rayDefaults.js +6 -0
  67. package/src/environment/sensors/rayGeometry.js +60 -0
  68. package/src/environment/sensors/rayGuards.js +19 -0
  69. package/src/environment/sensors/sensorTargets.js +60 -0
  70. package/src/environment/sensors/surfaceRays.js +296 -0
  71. package/src/environment/sensors/trackRays.js +261 -0
  72. package/src/environment/sensors.js +1 -367
  73. package/src/environment/specs.js +100 -5
  74. package/src/environment/workerProtocol.js +13 -1
  75. package/src/index.d.ts +169 -6
  76. package/src/index.js +5 -0
  77. package/src/rendering/proceduralTrackAsset.js +20 -823
  78. package/src/rendering/renderSnapshot.js +38 -12
  79. package/src/rendering/track/finishLineRenderer.js +34 -0
  80. package/src/rendering/track/gridRenderer.js +47 -0
  81. package/src/rendering/track/offsetStrokeSafety.js +136 -0
  82. package/src/rendering/track/pitLaneRenderer.js +248 -0
  83. package/src/rendering/track/trackMaterialRenderer.js +326 -0
  84. package/src/rendering/track/trackRenderConstants.js +38 -0
  85. package/src/rendering/track/trackRenderGeometry.js +94 -0
  86. package/src/simulation/collisionGeometry.js +1 -1
  87. package/src/simulation/driver/driverControlConstants.js +28 -0
  88. package/src/simulation/driver/driverController.js +47 -0
  89. package/src/simulation/driver/driverInput.js +28 -0
  90. package/src/simulation/driver/driverMath.js +6 -0
  91. package/src/simulation/driver/driverPersonality.js +25 -0
  92. package/src/simulation/driver/edgeRecovery.js +48 -0
  93. package/src/simulation/driver/racingControls.js +399 -0
  94. package/src/simulation/driver/racingLinePlan.js +166 -0
  95. package/src/simulation/driver/recoveryDynamics.js +38 -0
  96. package/src/simulation/driver/rejoinControls.js +213 -0
  97. package/src/simulation/driver/safetyCarControls.js +35 -0
  98. package/src/simulation/driver/trafficScan.js +51 -0
  99. package/src/simulation/driverController.js +4 -619
  100. package/src/simulation/participants/participantInteractions.js +120 -0
  101. package/src/simulation/pit/pitFlow.js +234 -0
  102. package/src/simulation/pit/pitIntent.js +92 -0
  103. package/src/simulation/pit/pitOccupancy.js +47 -0
  104. package/src/simulation/pit/pitPenaltyService.js +71 -0
  105. package/src/simulation/pit/pitQueue.js +55 -0
  106. package/src/simulation/pit/pitRouteMovement.js +160 -0
  107. package/src/simulation/pit/pitRouting.js +319 -0
  108. package/src/simulation/pit/pitService.js +41 -0
  109. package/src/simulation/pit/pitServiceConstants.js +21 -0
  110. package/src/simulation/pit/pitServiceProfile.js +45 -0
  111. package/src/simulation/pit/pitSnapshots.js +61 -0
  112. package/src/simulation/pit/pitState.js +113 -0
  113. package/src/simulation/pit/pitTireService.js +92 -0
  114. package/src/simulation/race/classification.js +104 -0
  115. package/src/simulation/race/gridPenalties.js +37 -0
  116. package/src/simulation/race/raceControlState.js +38 -0
  117. package/src/simulation/race/raceDistance.js +32 -0
  118. package/src/simulation/race/raceFinish.js +65 -0
  119. package/src/simulation/race/raceLifecycle.js +71 -0
  120. package/src/simulation/race/raceOrder.js +113 -0
  121. package/src/simulation/race/raceProgress.js +124 -0
  122. package/src/simulation/race/raceSetup.js +93 -0
  123. package/src/simulation/race/raceStep.js +80 -0
  124. package/src/simulation/race/redFlag.js +15 -0
  125. package/src/simulation/race/retirements.js +44 -0
  126. package/src/simulation/race/safetyCar.js +86 -0
  127. package/src/simulation/race/stalledDnf.js +86 -0
  128. package/src/simulation/raceSimulation.js +230 -2817
  129. package/src/simulation/replay/replayGhosts.js +128 -0
  130. package/src/simulation/rules/moduleConfig.js +72 -0
  131. package/src/simulation/rules/penaltyConfig.js +99 -0
  132. package/src/simulation/rules/penaltyEvents.js +18 -0
  133. package/src/simulation/rules/penaltyStats.js +26 -0
  134. package/src/simulation/rules/ruleConfigMerge.js +41 -0
  135. package/src/simulation/rules/ruleDefaults.js +85 -0
  136. package/src/simulation/rules/rulesReview.js +141 -0
  137. package/src/simulation/rules/rulesetPresets.js +47 -0
  138. package/src/simulation/rules/trackLimitsSteward.js +1 -1
  139. package/src/simulation/rulesConfig.js +5 -323
  140. package/src/simulation/snapshots/raceSnapshots.js +192 -0
  141. package/src/simulation/timing/drsTiming.js +87 -0
  142. package/src/simulation/timing/gapEstimation.js +38 -0
  143. package/src/simulation/timing/lapTelemetry.js +182 -0
  144. package/src/simulation/timing/raceTiming.js +15 -0
  145. package/src/simulation/timing/sectorPerformance.js +60 -0
  146. package/src/simulation/timing/timingConstants.js +5 -0
  147. package/src/simulation/timing/timingHistory.js +46 -0
  148. package/src/simulation/timing/timingLines.js +79 -0
  149. package/src/simulation/track/centerlineSpline.js +59 -0
  150. package/src/simulation/track/drsZones.js +67 -0
  151. package/src/simulation/track/pitLaneAccess.js +103 -0
  152. package/src/simulation/track/pitLaneLayout.js +395 -0
  153. package/src/simulation/track/pitLaneState.js +160 -0
  154. package/src/simulation/track/proceduralCenterline.js +237 -0
  155. package/src/simulation/track/sampleGeometry.js +49 -0
  156. package/src/simulation/track/spatialQueries.js +154 -0
  157. package/src/simulation/track/startStraight.js +141 -0
  158. package/src/simulation/track/trackConstants.js +109 -0
  159. package/src/simulation/track/trackGenerationOptions.js +283 -0
  160. package/src/simulation/track/trackMath.js +241 -0
  161. package/src/simulation/track/trackModel.js +240 -0
  162. package/src/simulation/track/trackQueryIndex.js +945 -0
  163. package/src/simulation/track/trackSectors.js +19 -0
  164. package/src/simulation/track/trackStatePolicy.js +24 -0
  165. package/src/simulation/track/trackValidation.js +98 -0
  166. package/src/simulation/trackModel.js +1 -1706
  167. package/src/simulation/vehicle/contactResolution.js +116 -0
  168. package/src/simulation/vehicle/mainTrackWheelSurface.js +82 -0
  169. package/src/simulation/vehicle/pitWheelSurface.js +69 -0
  170. package/src/simulation/vehicle/runoffResponse.js +88 -0
  171. package/src/simulation/vehicle/surfacePriority.js +28 -0
  172. package/src/simulation/vehicle/vehicleGeometry.js +247 -0
  173. package/src/simulation/vehicle/vehiclePhysics.js +363 -0
  174. package/src/simulation/vehicle/vehicleSnapshots.js +316 -0
  175. package/src/simulation/vehicle/vehicleState.js +186 -0
  176. package/src/simulation/vehicle/wheelSurface.js +150 -0
  177. package/src/simulation/vehicleGeometry.js +1 -247
  178. package/src/simulation/vehiclePhysics.js +1 -136
  179. package/src/simulation/warmup/runtimeWarmup.js +224 -0
  180. package/src/simulation/wheelSurface.js +1 -338
  181. package/src/styles.css +42 -0
  182. package/src/ui/cameraControlsTemplate.js +20 -0
  183. package/src/ui/carOverviewTemplate.js +33 -0
  184. package/src/ui/componentTemplates.js +14 -360
  185. package/src/ui/raceCanvasTemplate.js +69 -0
  186. package/src/ui/raceControlsTemplate.js +36 -0
  187. package/src/ui/shellTemplate.js +5 -4
  188. package/src/ui/telemetryDrawerTemplate.js +55 -0
  189. package/src/ui/telemetryTemplates.js +136 -0
  190. package/src/ui/timingTowerTemplate.js +34 -0
@@ -0,0 +1,240 @@
1
+ import { normalizeAngle } from '../simMath.js';
2
+ import { CENTERLINE_CONTROLS, TRACK } from './trackConstants.js';
3
+ import { distance } from './trackMath.js';
4
+ import { rawCenterPoint } from './centerlineSpline.js';
5
+ import { generateCenterlineControls, generateFallbackCenterlineControls, generateSafeFallbackCenterlineControls, normalizeSeed } from './proceduralCenterline.js';
6
+ import { isValidProceduralTrackModel } from './trackValidation.js';
7
+ import { recalculateSampleGeometry } from './sampleGeometry.js';
8
+ import { rotateSamplesToStandingStart, straightenStandingStartSamples } from './startStraight.js';
9
+ import { createTrackSectors } from './trackSectors.js';
10
+ import { deriveDrsZones, normalizeDrsZone } from './drsZones.js';
11
+ import { createPitLaneModel } from './pitLaneLayout.js';
12
+ import { attachTrackQueryIndex, createTrackQueryIndex } from './trackQueryIndex.js';
13
+ import { resolveProceduralTrackOptions } from './trackGenerationOptions.js';
14
+
15
+ export { WORLD, TRACK } from './trackConstants.js';
16
+ export { isInDrsZone } from './drsZones.js';
17
+ export { nearestTrackState, offsetTrackPoint, pointAt } from './spatialQueries.js';
18
+
19
+ const PROCEDURAL_TRACK_CACHE = new Map();
20
+ const TRACK_MODEL_CACHE = new WeakMap();
21
+
22
+ export function buildTrackModel(track = TRACK) {
23
+ const canReuseCachedModel = track === TRACK || Object.isFrozen(track);
24
+ const cached = canReuseCachedModel ? TRACK_MODEL_CACHE.get(track) : null;
25
+ if (cached) return cached;
26
+
27
+ const controls = track.centerlineControls ?? CENTERLINE_CONTROLS;
28
+ const base = [];
29
+ for (let index = 0; index <= track.sampleCount; index += 1) {
30
+ base.push(rawCenterPoint(index / track.sampleCount, controls, track.curveInterpolation));
31
+ }
32
+
33
+ let totalLength = 0;
34
+ const samples = base.map((point, index) => {
35
+ if (index > 0) totalLength += distance(base[index - 1], point);
36
+ return { ...point, distance: totalLength, heading: 0, normalX: 0, normalY: 0, curvature: 0 };
37
+ });
38
+ recalculateSampleGeometry(samples);
39
+
40
+ const startStraightOptions = track.generationOptions?.startStraight;
41
+ const rotatedSamples = rotateSamplesToStandingStart(samples, totalLength, startStraightOptions);
42
+ const straightenedTrack = straightenStandingStartSamples(rotatedSamples, totalLength, startStraightOptions);
43
+ const normalizedSamples = straightenedTrack.samples;
44
+ totalLength = straightenedTrack.totalLength;
45
+
46
+ const model = {
47
+ ...track,
48
+ centerlineControls: controls,
49
+ length: totalLength,
50
+ samples: normalizedSamples,
51
+ sectors: createTrackSectors(totalLength),
52
+ drsZones: (track.drsZones ?? deriveDrsZones(normalizedSamples, totalLength))
53
+ .map((zone) => normalizeDrsZone(zone, totalLength)),
54
+ };
55
+ model.pitLane = track.pitLane?.enabled === false || track.generationOptions?.pitLane?.enabled === false
56
+ ? null
57
+ : createPitLaneModel(model);
58
+ attachTrackQueryIndex(model, createTrackQueryIndex(model));
59
+ if (canReuseCachedModel) {
60
+ TRACK_MODEL_CACHE.set(track, freezeTrackModel(model));
61
+ }
62
+ return model;
63
+ }
64
+
65
+ export function createProceduralTrack(seed = Date.now(), options = {}) {
66
+ const normalizedSeed = normalizeSeed(seed);
67
+ const generationOptions = resolveProceduralTrackOptions(options);
68
+ const cacheKey = `${normalizedSeed}:${generationOptions.cacheKey}`;
69
+ const cached = PROCEDURAL_TRACK_CACHE.get(cacheKey);
70
+ if (cached) return cached;
71
+
72
+ for (let attempt = 0; attempt < generationOptions.attempts.primary; attempt += 1) {
73
+ const candidateSeed = (normalizedSeed + Math.imul(attempt, 2654435761)) >>> 0;
74
+ const candidate = {
75
+ ...TRACK,
76
+ name: `Generated GP ${candidateSeed.toString(36).toUpperCase().padStart(6, '0').slice(-6)}`,
77
+ seed: candidateSeed,
78
+ curveInterpolation: 'centripetal',
79
+ centerlineControls: generateCenterlineControls(candidateSeed, generationOptions.shape),
80
+ drsZones: null,
81
+ generationOptions,
82
+ ...(generationOptions.pitLane.enabled === false ? { pitLane: { enabled: false } } : {}),
83
+ };
84
+ const model = buildTrackModel(candidate);
85
+ if (isValidProceduralTrackModel(model, generationOptions)) {
86
+ const trackDefinition = {
87
+ ...candidate,
88
+ drsZones: model.drsZones.map(({ id, startRatio, endRatio }) => ({ id, startRatio, endRatio })),
89
+ };
90
+ return cacheProceduralTrackDefinition(cacheKey, trackDefinition);
91
+ }
92
+ }
93
+
94
+ let fallback = null;
95
+ let fallbackModel = null;
96
+ for (let attempt = 0; attempt < generationOptions.attempts.fallback; attempt += 1) {
97
+ const candidateSeed = (normalizedSeed ^ Math.imul(attempt + 1, 2246822519)) >>> 0;
98
+ const candidate = {
99
+ ...TRACK,
100
+ name: `Generated GP ${normalizedSeed.toString(36).toUpperCase().padStart(6, '0').slice(-6)}`,
101
+ seed: candidateSeed,
102
+ curveInterpolation: 'centripetal',
103
+ centerlineControls: generateFallbackCenterlineControls(candidateSeed, generationOptions.shape),
104
+ drsZones: null,
105
+ generationOptions,
106
+ ...(generationOptions.pitLane.enabled === false ? { pitLane: { enabled: false } } : {}),
107
+ };
108
+ const model = buildTrackModel(candidate);
109
+ if (isValidProceduralTrackModel(model, generationOptions)) {
110
+ fallback = candidate;
111
+ fallbackModel = model;
112
+ break;
113
+ }
114
+ }
115
+
116
+ if (!fallback || !fallbackModel) {
117
+ fallback = {
118
+ ...TRACK,
119
+ name: `Generated GP ${normalizedSeed.toString(36).toUpperCase().padStart(6, '0').slice(-6)}`,
120
+ seed: normalizedSeed,
121
+ curveInterpolation: 'centripetal',
122
+ centerlineControls: generateSafeFallbackCenterlineControls(normalizedSeed, generationOptions.shape),
123
+ drsZones: null,
124
+ generationOptions,
125
+ ...(generationOptions.pitLane.enabled === false ? { pitLane: { enabled: false } } : {}),
126
+ };
127
+ fallbackModel = buildTrackModel(fallback);
128
+ }
129
+ const fallbackDefinition = {
130
+ ...fallback,
131
+ drsZones: fallbackModel.drsZones.map(({ id, startRatio, endRatio }) => ({ id, startRatio, endRatio })),
132
+ };
133
+ return cacheProceduralTrackDefinition(cacheKey, fallbackDefinition);
134
+ }
135
+
136
+ export { normalizeAngle };
137
+
138
+ function cacheProceduralTrackDefinition(cacheKey, trackDefinition) {
139
+ const frozen = deepFreeze(trackDefinition);
140
+ PROCEDURAL_TRACK_CACHE.set(cacheKey, frozen);
141
+ return frozen;
142
+ }
143
+
144
+ function freezeTrackModel(model) {
145
+ freezeArrayItems(model.samples);
146
+ freezeArrayItems(model.centerlineControls);
147
+ freezeArrayItems(model.sectors);
148
+ freezeArrayItems(model.drsZones);
149
+ deepFreeze(model.pitLane);
150
+ freezeTrackQueryIndex(model.queryIndex);
151
+ return Object.freeze(model);
152
+ }
153
+
154
+ function freezeArrayItems(items) {
155
+ if (!Array.isArray(items)) return;
156
+ items.forEach((item) => deepFreeze(item));
157
+ Object.freeze(items);
158
+ }
159
+
160
+ function deepFreeze(value) {
161
+ if (!value || typeof value !== 'object' || Object.isFrozen(value)) return value;
162
+ Object.freeze(value);
163
+ Object.values(value).forEach((child) => {
164
+ deepFreeze(child);
165
+ });
166
+ return value;
167
+ }
168
+
169
+ function freezeTrackQueryIndex(index) {
170
+ if (!index || typeof index !== 'object') return index;
171
+ deepFreeze(index.bands);
172
+ freezeCenterlineSegments(index.centerline);
173
+ freezeSpatialGrid(index.grid);
174
+ freezeSpatialGrid(index.segmentGrid);
175
+ freezeArcBuckets(index.arcBuckets);
176
+ freezePitQueryIndex(index.pit);
177
+ return Object.freeze(index);
178
+ }
179
+
180
+ function freezeCenterlineSegments(centerline) {
181
+ if (!centerline || typeof centerline !== 'object') return centerline;
182
+ Object.entries(centerline).forEach(([key, value]) => {
183
+ if (ArrayBuffer.isView(value)) {
184
+ centerline[key] = Object.freeze(Array.from(value));
185
+ }
186
+ });
187
+ return Object.freeze(centerline);
188
+ }
189
+
190
+ function freezeSpatialGrid(grid) {
191
+ if (!grid || typeof grid !== 'object') return grid;
192
+ deepFreeze(grid.bounds);
193
+ if (grid.cells instanceof Map) {
194
+ for (const cell of grid.cells.values()) Object.freeze(cell);
195
+ grid.cells = readonlyMap(grid.cells);
196
+ }
197
+ return Object.freeze(grid);
198
+ }
199
+
200
+ function freezeArcBuckets(arcBuckets) {
201
+ if (!arcBuckets || typeof arcBuckets !== 'object') return arcBuckets;
202
+ if (Array.isArray(arcBuckets.buckets)) {
203
+ arcBuckets.buckets.forEach((bucket) => Object.freeze(bucket));
204
+ Object.freeze(arcBuckets.buckets);
205
+ }
206
+ return Object.freeze(arcBuckets);
207
+ }
208
+
209
+ function freezePitQueryIndex(pit) {
210
+ if (!pit || typeof pit !== 'object') return pit;
211
+ freezeSpatialGrid(pit.roadGrid);
212
+ freezeSpatialGrid(pit.boxGrid);
213
+ deepFreeze(pit.routes);
214
+ freezeArrayItems(pit.roadSegments);
215
+ freezeArrayItems(pit.boxCandidates);
216
+ return Object.freeze(pit);
217
+ }
218
+
219
+ function readonlyMap(map) {
220
+ return new Proxy(map, {
221
+ get(target, property) {
222
+ if (property === 'set' || property === 'delete' || property === 'clear') {
223
+ return () => {
224
+ throw new TypeError('Cannot mutate a cached track query index');
225
+ };
226
+ }
227
+ const value = Reflect.get(target, property, target);
228
+ return typeof value === 'function' ? value.bind(target) : value;
229
+ },
230
+ set() {
231
+ throw new TypeError('Cannot mutate a cached track query index');
232
+ },
233
+ deleteProperty() {
234
+ throw new TypeError('Cannot mutate a cached track query index');
235
+ },
236
+ defineProperty() {
237
+ throw new TypeError('Cannot mutate a cached track query index');
238
+ },
239
+ });
240
+ }