@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,19 @@
1
+ export function createTrackSectors(totalLength) {
2
+ return Array.from({ length: 3 }, (_, index) => {
3
+ const startRatio = index / 3;
4
+ const endRatio = (index + 1) / 3;
5
+ const start = totalLength * startRatio;
6
+ const end = totalLength * endRatio;
7
+
8
+ return {
9
+ index: index + 1,
10
+ id: `s${index + 1}`,
11
+ label: `S${index + 1}`,
12
+ start,
13
+ end,
14
+ startRatio,
15
+ endRatio,
16
+ length: end - start,
17
+ };
18
+ });
19
+ }
@@ -0,0 +1,24 @@
1
+ import { nearestTrackState } from './trackModel.js';
2
+
3
+ export function pitOverrideAllowedForCar(car) {
4
+ if (!car?.environmentControlled) return true;
5
+ const status = car.pitStop?.status ?? null;
6
+ const pitRouteActive = status != null && status !== 'pending' && status !== 'completed';
7
+ const pitIntentCommitted = Number(car.pitStop?.intent ?? car.pitIntent ?? 0) >= 2;
8
+ return pitRouteActive || pitIntentCommitted;
9
+ }
10
+
11
+ export function nearestTrackStateForCar(
12
+ track,
13
+ car,
14
+ position = car,
15
+ progressHint = car?.progress ?? null,
16
+ options = {},
17
+ ) {
18
+ const resolvedAllowPitOverride = options.allowPitOverride ?? pitOverrideAllowedForCar(car);
19
+ return nearestTrackState(track, position, progressHint, {
20
+ indexMode: options.indexMode ?? 'legacy',
21
+ ...options,
22
+ allowPitOverride: resolvedAllowPitOverride,
23
+ });
24
+ }
@@ -0,0 +1,98 @@
1
+ import { normalizeAngle } from '../simMath.js';
2
+ import { GENERATED_TRACK_MAX_LENGTH, GENERATED_TRACK_MIN_LENGTH, MAX_LOCAL_TURN_RADIANS, MAX_SAMPLE_HEADING_DELTA_RADIANS, MIN_NON_ADJACENT_ARC_DISTANCE, MIN_TRACK_CLEARANCE_MULTIPLIER, MIN_TRACK_SHAPE_VARIATION, TRACK_BOUNDARY_PADDING, WORLD } from './trackConstants.js';
3
+ import { distance, segmentsIntersect } from './trackMath.js';
4
+
5
+ export function hasSelfIntersections(samples) {
6
+ const points = samples.slice(0, -1).filter((_, index) => index % 12 === 0);
7
+ for (let first = 0; first < points.length - 1; first += 1) {
8
+ for (let second = first + 2; second < points.length - 1; second += 1) {
9
+ const sharesLoopClosure = first === 0 && second >= points.length - 3;
10
+ if (sharesLoopClosure) continue;
11
+ if (segmentsIntersect(points[first], points[first + 1], points[second], points[second + 1])) return true;
12
+ }
13
+ }
14
+ return false;
15
+ }
16
+
17
+ export function samplesStayInsideWorld(samples) {
18
+ return samples.every((sample) => (
19
+ sample.x >= TRACK_BOUNDARY_PADDING &&
20
+ sample.x <= WORLD.width - TRACK_BOUNDARY_PADDING &&
21
+ sample.y >= TRACK_BOUNDARY_PADDING &&
22
+ sample.y <= WORLD.height - TRACK_BOUNDARY_PADDING
23
+ ));
24
+ }
25
+
26
+ export function hasEnoughTrackClearance(samples, totalLength, minimumClearance, minimumNonAdjacentArcDistance = MIN_NON_ADJACENT_ARC_DISTANCE) {
27
+ const points = samples.slice(0, -1).filter((_, index) => index % 24 === 0);
28
+ const minimumClearanceSquared = minimumClearance * minimumClearance;
29
+ for (let first = 0; first < points.length; first += 1) {
30
+ for (let second = first + 1; second < points.length; second += 1) {
31
+ const arcDistance = Math.abs(points[second].distance - points[first].distance);
32
+ const loopDistance = Math.min(arcDistance, totalLength - arcDistance);
33
+ if (loopDistance < minimumNonAdjacentArcDistance) continue;
34
+ const dx = points[first].x - points[second].x;
35
+ const dy = points[first].y - points[second].y;
36
+ if (dx * dx + dy * dy < minimumClearanceSquared) return false;
37
+ }
38
+ }
39
+ return true;
40
+ }
41
+
42
+ export function hasReasonableTurnSharpness(samples, options = {}) {
43
+ const maxSampleHeadingDeltaRadians = options.maxSampleHeadingDeltaRadians ?? MAX_SAMPLE_HEADING_DELTA_RADIANS;
44
+ const maxLocalTurnRadians = options.maxLocalTurnRadians ?? MAX_LOCAL_TURN_RADIANS;
45
+ const usableSamples = samples.slice(0, -1);
46
+ const windows = [30, 36];
47
+ const step = 6;
48
+
49
+ for (let index = 0; index < usableSamples.length; index += 1) {
50
+ const current = usableSamples[index];
51
+ const next = usableSamples[(index + 1) % usableSamples.length];
52
+ if (Math.abs(normalizeAngle(next.heading - current.heading)) > maxSampleHeadingDeltaRadians) {
53
+ return false;
54
+ }
55
+ }
56
+
57
+ for (let index = 0; index < usableSamples.length; index += step) {
58
+ for (const window of windows) {
59
+ let accumulatedTurn = 0;
60
+ for (let offset = 0; offset < window; offset += step) {
61
+ const current = usableSamples[(index + offset) % usableSamples.length];
62
+ const next = usableSamples[(index + offset + step) % usableSamples.length];
63
+ accumulatedTurn += Math.abs(normalizeAngle(next.heading - current.heading));
64
+ }
65
+ if (accumulatedTurn > maxLocalTurnRadians) return false;
66
+ }
67
+ }
68
+
69
+ return true;
70
+ }
71
+
72
+ export function hasEnoughShapeVariation(controls, minimumVariation = MIN_TRACK_SHAPE_VARIATION) {
73
+ const center = { x: WORLD.width / 2, y: WORLD.height / 2 };
74
+ const radii = controls.map((point) => distance(point, center));
75
+ const mean = radii.reduce((total, radius) => total + radius, 0) / Math.max(1, radii.length);
76
+ if (mean <= 0) return false;
77
+ const variance = radii.reduce((total, radius) => total + (radius - mean) ** 2, 0) / Math.max(1, radii.length);
78
+ return Math.sqrt(variance) / mean > minimumVariation;
79
+ }
80
+
81
+ export function isValidProceduralTrackModel(model, options = {}) {
82
+ const length = options.length ?? {};
83
+ const validation = options.validation ?? {};
84
+ return (
85
+ model.length >= (length.min ?? GENERATED_TRACK_MIN_LENGTH) &&
86
+ model.length <= (length.max ?? GENERATED_TRACK_MAX_LENGTH) &&
87
+ hasEnoughShapeVariation(model.centerlineControls, validation.minShapeVariation ?? MIN_TRACK_SHAPE_VARIATION) &&
88
+ samplesStayInsideWorld(model.samples) &&
89
+ hasEnoughTrackClearance(
90
+ model.samples,
91
+ model.length,
92
+ model.width * (validation.minClearanceMultiplier ?? MIN_TRACK_CLEARANCE_MULTIPLIER),
93
+ validation.minNonAdjacentArcDistance ?? MIN_NON_ADJACENT_ARC_DISTANCE,
94
+ ) &&
95
+ hasReasonableTurnSharpness(model.samples, validation) &&
96
+ !hasSelfIntersections(model.samples)
97
+ );
98
+ }