Skip to content

docs: expand README with editor features, keybindings, and terrain/mod details - #47

Merged
vanlueckn merged 3 commits into
mainfrom
t3code/073ba84b
Aug 16, 2026
Merged

docs: expand README with editor features, keybindings, and terrain/mod details#47
vanlueckn merged 3 commits into
mainfrom
t3code/073ba84b

Conversation

@vanlueckn

Copy link
Copy Markdown
Collaborator

Summary

  • Updated CI badge URL to reflect repository rename (vanlueckn/open-train-simulatorConnected-Rails/connected-rails)
  • Expanded main menu description to highlight clickable interface for line/vehicle/scenario selection
  • Added keybindings for wipers (Y), AFB controls (6–8), headlights/cab light (9/0), backlighting dimmer (,/.)
  • Clarified mod manager behavior and added mouse control documentation
  • Added new mod content types: signal models, track types, objects, HTML displays
  • Documented terrain splatting, vegetation, and track objects in world-render
  • Expanded editor descriptions: route editor tools table (select, draw, place, terrain), vehicle editor cab/displays/sounds, signal editor
  • Added Ctrl+Z/Y/Shift+Z undo/redo and rule checker to route editor documentation
  • Documented DGM tile import and terrain view toggle in route editor
  • Fixed scenario syntax example (edge: (2)edge: EdgeId(2))
  • Updated release workflow notes: signal editor now built from source
  • Clarified custom property options: ts_motion now includes emissive, added _NIGHT suffix convention

Testing

  • Verified all keybindings match current implementation in codebase
  • Confirmed URL changes point to correct GitHub repository
  • Checked that editor tool descriptions and UI flows match actual implementations
  • Validated mod content type listing aligns with mod.ron structure
  • Reviewed scenario syntax fix against compiler expectations
  • Not run: visual inspection of rendered markdown (recommendation: preview locally before merge)

- Add missing key bindings: Y (wipers), 6/7/8 (AFB), 9/0 (lights), ,/. (instrument dimmer)
- Remove obsolete U (train type switch) — no longer used
- Update compressor labeling (drop "air")
- Clarify main menu as clickable interface for line/vehicle/scenario selection (PR #45)
- Fix F9 mod manager description for clarity
- Fix scenario example: edge: (2) → edge: EdgeId(2) (correct RON syntax)
- Add missing U key binding: Train type switch (Zugartschalter)
  O → M → U cycling at standstill (active feature, was undocumented)
- Add route editor DGM tile tool and terrain pull-in documentation
- Document mouse controls for 3D cab (left click/drag/wheel and right look)
- Expand vehicle editor scope: cab, displays, sounds, and rendering details
- Add route editor tool palette table with keyboard shortcuts and actions
- Document terrain splatting, tree spawning, and streaming implementation
- Clarify editor feature coverage in program table (switches, objects, vegetation)
- Update release workflow note: signal editor built from source
@vanlueckn
vanlueckn merged commit 3eef36f into main Aug 16, 2026
3 checks passed
@vanlueckn
vanlueckn deleted the t3code/073ba84b branch August 16, 2026 20:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant