Documentation

Configuration

Every config option in mtrsurveyor.toml, with types, defaults, and what they do.

MTR Surveyor stores its config in a Forge config file at:

.minecraft/config/mtrsurveyor.toml

It’s generated on first launch. You can edit it while the game is closed, or change the most common options at runtime via /mtrsurveyor config commands (changes persist to the same file).

The file has two sections: top-level options, and a [visibility] table.

Top-level options

KeyTypeDefaultDescription
formalInitLogboolfalseUse a more formal startup log line instead of the default playful one.
debugLogboolfalseLog every landmark sync event to the console. Useful for troubleshooting.
enabledbooltrueMaster switch for automatic waypoint sync. When false, nothing syncs.
waypointModestring"station"Display mode: "station" (one waypoint per station) or "platform" (one per platform with route info).

[visibility] options

KeyTypeDefaultDescription
showStationLandmarksbooltrueAdd waypoints for MTR stations.
showDepotLandmarksboolfalseAdd waypoints for MTR depots (prefixed [MTR] Depot:).
showEmptyStationboolfalseAdd waypoints for stations that have no routes.
showHiddenRouteboolfalseInclude MTR routes marked as hidden in station descriptions.

Example file

#Change the mod initialization log message to be something more formal
formalInitLog = false

#Log all landmark sync events to the console
debugLog = false

#Whether waypoints should be automatically created & synced when an MTR-related change occurs
enabled = true

#Waypoint display mode: 'station' shows one waypoint per station, 'platform' shows one waypoint per platform with route info
waypointMode = "station"

[visibility]
    #Whether station waypoints should be added to the map
    showStationLandmarks = true
    #Whether depot waypoints should be added to the map
    showDepotLandmarks = false
    #Whether empty stations (with no routes) should be added to the map
    showEmptyStation = false
    #Whether MTR routes marked as hidden should be appended to the station description
    showHiddenRoute = false

Notes

  • waypointMode accepts only "station" or "platform". Anything else falls back to station-mode behavior.
  • enabled = false completely pauses syncing; existing [MTR] waypoints are not removed until you re-enable and trigger a sync.
  • debugLog = true is noisy — turn it on only when investigating issues, then turn it back off.
  • The three runtime-toggleable options (enabled, showStationLandmarks, showDepotLandmarks) are exposed as /mtrsurveyor config commands. The other four are file-edit-only.