aboutsummaryrefslogtreecommitdiff
path: root/data/help/map.yaml
blob: 3b4917a4042d59b4f634ea95ca2cd26401c28f1b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
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 @.

  Map size is controlled by:
    option mapwidth <num>   (default 30)
    option mapheight <num>  (default 20)

  Padding/trimming is controlled by:
    option mappadding <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