docs(sdk): add a headless usage quickstart to the README - #102
Merged
Conversation
The README documented only the extension (iframe) workflow, while the factories and exporters also work from plain Node.js since the ESM fix (#99) and the factory fixes (#100, #101). Add a copy-paste runnable example that builds a lane + driving path + vehicle and exports OpenDRIVE / OpenSCENARIO / Lanelet2, notes the 0.17.0 requirement, and points scenario logic (triggers, speed profiles) to the editor.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README documented only the extension (iframe) workflow, while the factories and exporters also work from plain Node.js since #99 / #100 / #101.
This adds a copy-paste runnable headless section (EN + JA):
parseOpenDriveXml→odrToShapes)The example is the exact scene verified against the merged fixes (1 moving entity with a 5-vertex timed polyline, coordinates 0..29.99 m).
Note: merge after the 0.17.0 release — the npm-published 0.16.0 predates the ESM fix, so the example fails on it with
ERR_MODULE_NOT_FOUND.