aboutsummaryrefslogtreecommitdiff
path: root/data/help/map.yaml
blob: def57dc7834afb62279c8854e84b5fdd95ebc41c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
name: "map"
category: "Exploration"
description: |
  Display a full map of the surrounding area.

  Usage: map

  The map shows all explored rooms and their connections,
  centered on your current location. You are shown as @.

  Link legend:
    - or |              two-way connection
    ← ↑ → ↓ (or < ^ > v) one-way connection, pointing the way you
                        can travel along it
    X                   the path is blocked in every direction from here

  Rooms are tinted by their builder-set color; the links between two
  rooms blend their colors into a gradient. Set your own per-room
  symbol and color with "symbol" (see "help symbol"). Customize the @
  marker and the blocked X via "color map_at" and "color map_blocked".

  Map size is controlled by:
    option map_width <num>   (default 30)
    option map_height <num>  (default 20)

  Padding/trimming is controlled by:
    option map_padding <mode>
    none  - strip blank lines + left-trim (default)
    x     - strip blank lines only
    y     - left-trim only
    xy    - no trimming

  To show the map automatically after each move:
    option automap on