How dong-awa/howtogo works
HowToGo is a client-side Minecraft mapping and navigation mod. Players mark roads and places on Xaero’s World Map, choose a destination, travel mode and route preference, preview a route, then start navigation with HUD guidance and optional voice announcements. The graph preserves the documented Create rail and station layer, transit planning, map editing/rendering and phone integration. Some subsystem links rely on README descriptions because their implementations were not sampled; those links are identified by README evidence rather than implying source inspection.
Main entry points: HowToGo.java Mod Events · DestinationScreen.java Destination Picker · RoadRouter.java Road Router · Navigation.java Navigation State
Components 29
Road Mapping
- Mod Events
src/main/java/bili/dongsz/howtogo/HowToGo.java - Road Editing
src/main/java/bili/dongsz/howtogo/client/RoadEditSession.java - Road Snapping
src/main/java/bili/dongsz/howtogo/client/RoadSnapper.java - World Map Rendering
src/main/java/bili/dongsz/howtogo/client/RoadLayer.java
Map Data
- Network Editor
src/main/java/bili/dongsz/howtogo/road/RoadEditor.java - Road Network
src/main/java/bili/dongsz/howtogo/road/RoadNetwork.java - Road Persistence
src/main/java/bili/dongsz/howtogo/client/RoadStore.java - Road Storage Format
src/main/java/bili/dongsz/howtogo/road/RoadStorage.java - Create Rail Layer
src/main/java/bili/dongsz/howtogo/client/RailTrackStore.java - Rail Names
src/main/java/bili/dongsz/howtogo/client/RailNameStore.java - Transit Lines
src/main/java/bili/dongsz/howtogo/transit/TransitLine.java - Transit Persistence
src/main/java/bili/dongsz/howtogo/transit/TransitLineStorage.java
Trip Planning
- Destination Sources
src/main/java/bili/dongsz/howtogo/client/Destinations.java - POI Destinations
src/main/java/bili/dongsz/howtogo/client/PoiDestinationSource.java - Station Destinations
src/main/java/bili/dongsz/howtogo/client/CreateStationSource.java - Road Router
src/main/java/bili/dongsz/howtogo/route/RoadRouter.java - Transit Planner
src/main/java/bili/dongsz/howtogo/route/TransitPlanner.java - Route Preferences
src/main/java/bili/dongsz/howtogo/route/RoutePreferences.java - Preference Storage
src/main/java/bili/dongsz/howtogo/store/RoutePreferenceStore.java - Client Configuration
src/main/java/bili/dongsz/howtogo/RoadConfig.java
Navigation UI
- Destination Picker
src/main/java/bili/dongsz/howtogo/client/DestinationScreen.java - Navigation State
src/main/java/bili/dongsz/howtogo/client/Navigation.java - Navigation HUD
src/main/java/bili/dongsz/howtogo/client/NavHudRenderer.java - Voice Guidance
src/main/java/bili/dongsz/howtogo/client/Narration.java - Phone Picker
src/main/java/bili/dongsz/howtogo/compat/mcphone/DestinationPickerPage.java
Other components
- Player
- Xaero World Map
- Create Mod
- McPhone
Connections 34
- Player → Road Editing: edits roads
- Xaero World Map → World Map Rendering: hosts map layer
- World Map Rendering → Road Network: renders network
- Mod Events → Road Editing: registers input
src/main/java/bili/dongsz/howtogo/HowToGo.java - Mod Events → Navigation State: ticks navigation
src/main/java/bili/dongsz/howtogo/HowToGo.java - Mod Events → Create Rail Layer: ticks rail layer
src/main/java/bili/dongsz/howtogo/HowToGo.java - Mod Events → Road Persistence: ticks storage
src/main/java/bili/dongsz/howtogo/HowToGo.java - Road Editing → Road Snapping: snaps placement
src/main/java/bili/dongsz/howtogo/client/RoadEditSession.java - Road Editing → Network Editor: applies edits
src/main/java/bili/dongsz/howtogo/client/RoadEditSession.java - Network Editor → Road Network: mutates graph
src/main/java/bili/dongsz/howtogo/road/RoadEditor.java - Road Persistence → Road Storage Format: serializes network
src/main/java/bili/dongsz/howtogo/road/RoadStorage.java - Road Persistence → Road Network: loads and saves
src/main/java/bili/dongsz/howtogo/client/RoadStore.java - Create Mod → Create Rail Layer: supplies track data
- Create Rail Layer → Rail Names: stores names separately
src/main/java/bili/dongsz/howtogo/client/RailTrackStore.java - Create Rail Layer → Station Destinations: provides stations
- Player → Destination Picker: chooses trip
- Destination Sources → POI Destinations: includes POIs
- Destination Sources → Station Destinations: includes stations
- Destination Picker → Destination Sources: lists destinations
- Destination Picker → Road Router: previews route
- Destination Picker → Route Preferences: sets route options
- Road Router → Road Network: routes on graph
src/main/java/bili/dongsz/howtogo/route/RoadRouter.java - Road Router → Route Preferences: uses preferences
src/main/java/bili/dongsz/howtogo/route/RoadRouter.java - Transit Planner → Road Router: plans walk legs
- Transit Planner → Transit Lines: uses transit lines
- Destination Picker → Navigation State: starts navigation
- Navigation State → Navigation HUD: drives HUD
- Navigation State → Voice Guidance: announces turns
src/main/java/bili/dongsz/howtogo/HowToGo.java - Route Preferences → Preference Storage: persists choices
src/main/java/bili/dongsz/howtogo/store/RoutePreferenceStore.java - Mod Events → Preference Storage: loads preferences
src/main/java/bili/dongsz/howtogo/HowToGo.java - Player → Phone Picker: selects destination
- Phone Picker → Navigation State: starts trip
src/main/java/bili/dongsz/howtogo/compat/mcphone/DestinationPickerPage.java - Client Configuration → Road Router: configures routing
src/main/java/bili/dongsz/howtogo/RoadConfig.java - Client Configuration → Voice Guidance: configures voice