diff options
Diffstat (limited to 'data/help/map.yaml')
| -rw-r--r-- | data/help/map.yaml | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/data/help/map.yaml b/data/help/map.yaml new file mode 100644 index 0000000..3b4917a --- /dev/null +++ b/data/help/map.yaml @@ -0,0 +1,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 |