Veilrunner Help · Map — Early Access

Map — Early Access

The map is Veilrunner's automapper. In the Mac App Store version, it's an optional one-time in-app purchase called Map — Early Access.

Early Access means:

  • The map is fully usable today.
  • New map features keep coming in free updates.
  • Early supporters keep everything they bought, including future map features.

The map is not part of the planned iPhone and iPad version.

Unlocking the map

If the map is locked, opening it shows the purchase sheet with Buy and Restore Purchases. Any of these opens it: Map › Show Mapper, ⌘⇧M, #map, #path or Arm Automap.

  • Restore Purchases is also in the Veilrunner menu and at the top of Settings.
  • #purchase (or #unlock) opens the purchase sheet. #purchase restore restores an earlier purchase.
  • Your map files are never deleted while the map is locked. They are only hidden, and they come back the moment the map is unlocked.
  • Veilrunner remembers the last purchase check, so the map keeps working offline.

Drawing the map as you walk

  1. Show the mapper: Map › Show Mapper (⌘⇧M) or #map show.
  2. Arm automap: Map › Arm Automap, the Arm switch on the mapper toolbar, or #map arm.
  3. Walk. Each room and the exits between rooms appear as you go. Each MUD has one map, organized into zones.

Rooms come from GMCP Room.Info when the MUD sends it, or from the room text otherwise. When rooms are drawn:

  • Rooms you've visited are drawn normally. Rooms you've only seen through an exit are dimmed (fog of war).
  • One-way exits are found when you walk back, and are drawn dashed with an arrow. Exits you haven't walked yet are dotted.
  • Floor thumbnails show nearby levels. Click one to jump to it.

#map disarm stops recording.

Speedwalk

  • Click a room to walk there, across zones if needed.
  • #path {room} builds a route from where you are and shows it in gold. Nothing is sent. #path run (or #path go) walks it.
  • #map find {text} searches room names, labels, notes and descriptions in every zone, and previews the route in gold. It doesn't walk.
  • #map copy copies the current route as a speedwalk string, such as 3n2e.

Each step waits for you to arrive before the next one is sent. A walk stops on any of these:

  • a failure message such as "You can't go that way"
  • an 8-second timeout
  • arriving somewhere off the route

To stop a walk early, press Esc, use #speedwalk stop, or choose Map › Stop Speedwalk. To continue from where you are, use #speedwalk resume or Map › Resume Speedwalk. Clear Route on the toolbar (or #map clear path) drops the gold route.

#path {Temple of the Dawn}     build a route (not sent)
#path run                      walk it
#speedwalk                     status and steps left
#speedwalk stop                stop after the current step
#speedwalk resume              continue to the same room from here
#map find {fountain}           preview a route to the best match
#map copy                      copy the route as a speedwalk string
#7 e;#6 n                      hash-repeat speedwalk

Editing by hand

Right-click a room to choose Walk Here, Properties, Move, Merge, Link Exit, Unlink, One-Way or Delete. ⌥-click selects a room. The same actions are in the Map menu:

  • Room Properties… (⌥⌘I)
  • Link Exit…, Move Room…, Merge Room Into…
  • Delete Room (⌥⌘⌫)
#map room                      details, exits and one-way marks
#map set {name} {Old Harbor}   rename the current room
#map label {Inn}               short label
#map note {Ask for Mira}       notes
#map color {shop}              tag: shop, safe, danger, quest, water, or a hex color
#map link {enter portal} {Tower Top}   a command exit
#map oneway {n}                mark an exit one-way
#map zone new {Harbor}         file new rooms in a new zone

Undo, snapshots and Clear Map

  • Every map change can be undone and redone, up to 100 steps: ⌥⌘Z / ⇧⌥⌘Z, the ↶ ↷ toolbar buttons, or #map undo / #map redo.
  • Snapshots. Dated snapshots are saved before risky changes (Clear Map, delete, merge, import, restore) and once a day. The newest 20 per MUD are kept.
    • #map snapshot [reason] saves one now.
    • #map snapshots lists them.
    • #map restore N brings one back, and can be undone.
    • Map › Restore Snapshot… and the clock button on the toolbar show the same list.
  • Clear Map. The trash Clear Map button on the toolbar, Map › Clear Map… or #map clear asks first, then empties this MUD's map. A snapshot is saved first, so #map undo or #map restore 1 brings it back. Automap stays armed, and other MUDs' maps are untouched.

Fixing room names: #map relabel (new in 1.0.2)

On some MUDs, older versions could name a room after a line of description or the lighting line, such as "It is very bright." Veilrunner now reads the title correctly. A room with a misread name fixes itself the next time you walk into it or type look there: same room, same exits and notes, no duplicate.

  • #map relabel (or #map fixnames) fixes every misread name it can right away, using each room's saved text. A snapshot is saved first, and #map undo reverts it.
  • #map relabel list shows names that still look misread.
  • Names you set yourself are kept, unless they look like description text.

Import, export and other MUDs

  • Export or import as JSON (#map export, #map import) or as a readable text file (#map export text, #map import text). The same commands are in the Map menu.
  • With no path, the standard Open or Save panel appears. This is needed because Veilrunner runs in the App Sandbox.
  • #map config teaches the mapper a MUD's own direction words, exit-line patterns and failure phrases.

Type #map help or #help map in the app for every map command.

Still stuck? Email contact@pwr.industries with your Veilrunner version (Veilrunner › About Veilrunner), your macOS version and the MUD you were connected to, or report a bug.