Documentation

Commands

All MTR Surveyor client-side commands and what they do.

All MTR Surveyor commands are client-side. They’re registered through Minecraft’s client command dispatcher, so they work on any server — including ones that don’t have the mod installed. They’re available in single-player too.

The root command is /mtrsurveyor. Type /mtrsurveyor in chat (no prefix needed beyond the slash).

Reference

CommandDescription
/mtrsurveyor syncWaypointsForce an immediate waypoint sync.
/mtrsurveyor modeShow the current display mode.
/mtrsurveyor mode stationSwitch to station mode — one waypoint per station.
/mtrsurveyor mode platformSwitch to platform mode — one waypoint per platform with route info.
/mtrsurveyor config enabled <true|false>Enable or disable automatic waypoint sync. With no arg, show the current value.
/mtrsurveyor config showStations <true|false>Show or hide station waypoints.
/mtrsurveyor config showDepots <true|false>Show or hide depot waypoints.

Details

/mtrsurveyor syncWaypoints

Forces a sync pass on the next client tick (throttled to once every ~5 seconds / 100 ticks). Useful after big MTR edits or if waypoints look stale.

  • If Xaero’s Minimap isn’t installed, this fails with a red message: Xaero's Minimap is not installed!
  • On success: Waypoint sync requested! Waypoints will update shortly.

/mtrsurveyor mode

With no sub-argument, prints the current mode in aqua:

Current waypoint mode: station

/mtrsurveyor mode station / mode platform

Sets waypointMode in the config and immediately requests a sync. Responses:

  • Waypoint mode set to: station (one waypoint per station)
  • Waypoint mode set to: platform (one waypoint per platform with route info)

See Display modes for what each looks like.

/mtrsurveyor config <key> <true|false>

A generic boolean toggle. The three exposed keys are:

  • enabled — master switch for automatic waypoint sync.
  • showStations — toggles the showStationLandmarks config option.
  • showDepots — toggles the showDepotLandmarks config option.

Calling a key without an argument prints the current value, e.g.:

Waypoint sync is currently set to true

Calling it with true or false sets the value, persists it to mtrsurveyor.toml, and shows a green confirmation.

Commands not exposed

A few config options — formalInitLog, debugLog, showEmptyStation, showHiddenRoute — are not available as commands. Edit them directly in .minecraft/config/mtrsurveyor.toml. See Configuration.