Skip to content

docs(vehicleframework): move train setup and driving notes from the README - #98

Merged
ryanbarlow97 merged 1 commit into
mainfrom
docs/vehicleframework-readme-move
Oct 3, 2026
Merged

ryanbarlow97 merged 1 commit into
mainfrom
docs/vehicleframework-readme-move

Conversation

@ryanbarlow97

@ryanbarlow97 ryanbarlow97 commented Oct 3, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Merges the VehicleFramework README's technical sections (locomotive overdrive, train wheel animations, laying curves, junctions in reverse, track ends, bogies and skins, walkable decks) into projects/VehicleFramework/docs/using-trains.md, rewritten as current behaviour and checked against main.
  • Adds a behaviour.train key table and an Upgrading section (minimum release per key, the 2.9.0 downgrade warning) in place of the README's install-order notes.
  • Fixes stale text: the Trains guide said "Reverse clears the arm" (no such code path; the switch moves at once and stays locked while occupied) and that every stroke is straight (extensions curve per curve-radius). Engine speed is the speed at 100% throttle, not at full (max) throttle.
  • Adds curve-radius to the spline guide and wheel/bogie bone notes to the model guide.

Paired source PR: TF-Minecraft/VehicleFramework#58. This PR should merge first or together with it.

Checks

  • python3 -m unittest discover -s scripts -p 'test_*.py'
  • python3 scripts/check-indexes.py (701 local links and anchors, 180 pages)

🤖 Generated with Claude Code

…EADME

Merge the source README's locomotive overdrive, wheel animation, curve
laying, reverse junction, track end, bogie and walkable deck sections into
the Trains user guide as current behaviour, with an Upgrading section for
minimum releases and the downgrade warning. Correct the stale "reverse
clears the arm" junction text, note that extensions curve, and add
curve-radius, wheel and bogie bone notes to the spline and model guides.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@ryanbarlow97
ryanbarlow97 merged commit 052f729 into main Oct 3, 2026
1 check passed
@ryanbarlow97
ryanbarlow97 deleted the docs/vehicleframework-readme-move branch October 3, 2026 22:43
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