diff options
Diffstat (limited to 'data/help')
| -rw-r--r-- | data/help/automap.yaml | 13 | ||||
| -rw-r--r-- | data/help/color.yaml | 13 | ||||
| -rw-r--r-- | data/help/depletion.yaml | 11 | ||||
| -rw-r--r-- | data/help/description.yaml | 15 | ||||
| -rw-r--r-- | data/help/exits.yaml | 12 | ||||
| -rw-r--r-- | data/help/left-tinymap.yaml | 11 | ||||
| -rw-r--r-- | data/help/map.yaml | 23 | ||||
| -rw-r--r-- | data/help/mapheight.yaml | 10 | ||||
| -rw-r--r-- | data/help/mappadding.yaml | 13 | ||||
| -rw-r--r-- | data/help/mapwidth.yaml | 10 | ||||
| -rw-r--r-- | data/help/mobenter.yaml | 10 | ||||
| -rw-r--r-- | data/help/mobleave.yaml | 10 | ||||
| -rw-r--r-- | data/help/mobspawn.yaml | 10 | ||||
| -rw-r--r-- | data/help/option.yaml | 20 | ||||
| -rw-r--r-- | data/help/reserve.yaml | 11 | ||||
| -rw-r--r-- | data/help/tinymap.yaml | 11 | ||||
| -rw-r--r-- | data/help/toggle.yaml | 18 | ||||
| -rw-r--r-- | data/help/xpdrops.yaml | 10 |
18 files changed, 201 insertions, 30 deletions
diff --git a/data/help/automap.yaml b/data/help/automap.yaml new file mode 100644 index 0000000..32b84cb --- /dev/null +++ b/data/help/automap.yaml @@ -0,0 +1,13 @@ +name: "automap" +category: "Options" +description: | + Show the full map automatically after each movement. + + Type: boolean (on/off) + Default: off + + When enabled, the map command output is printed after each + room movement, so you always know where you are. + + Map size and padding are controlled by the mapwidth, + mapheight, and mappadding options. diff --git a/data/help/color.yaml b/data/help/color.yaml new file mode 100644 index 0000000..8171ab9 --- /dev/null +++ b/data/help/color.yaml @@ -0,0 +1,13 @@ +name: "color" +category: "Options" +description: | + Color output mode. + + Type: string + Default: none + Values: none, ansi, xterm256 + + Controls the color output format used by the game. + none - No color output + ansi - Standard 16-color ANSI codes + xterm256 - 256-color xterm codes diff --git a/data/help/depletion.yaml b/data/help/depletion.yaml new file mode 100644 index 0000000..d4d8390 --- /dev/null +++ b/data/help/depletion.yaml @@ -0,0 +1,11 @@ +name: "depletion" +category: "Options" +description: | + Show depletion and despawn timers on objects. + + Type: boolean (on/off) + Default: off + + When enabled, resource objects (rocks, trees, etc.) + show their remaining despawn or respawn timers in + the room look output. diff --git a/data/help/description.yaml b/data/help/description.yaml index ab6afa1..3436c5b 100644 --- a/data/help/description.yaml +++ b/data/help/description.yaml @@ -1,11 +1,12 @@ name: "description" -category: "Character" +category: "Options" description: | - View or change your character description. + Show full room descriptions when moving between rooms. - Usage: description, desc + Type: boolean (on/off) + Default: on - Shows your current description (if any) and prompts you to enter a new - one. Other players can see your description by looking at you with - "look <name>". Press enter without typing anything to keep your - current description. + When enabled, moving into a new room shows the full + room look output including description, mobs, objects, + items, and exits. + When disabled, only the room name is shown on move. diff --git a/data/help/exits.yaml b/data/help/exits.yaml index 673e789..fbfe3a6 100644 --- a/data/help/exits.yaml +++ b/data/help/exits.yaml @@ -1,9 +1,11 @@ name: "exits" -category: "Exploration" +category: "Options" description: | - List exits from the current room. + Show exit destinations in look output. - Usage: exits + Type: boolean (on/off) + Default: on - Shows each exit and the name of the room it leads to. Also toggleable - via "toggle exits" to show destinations inline in the look output. + When enabled, look shows each exit direction and the + name of the room it leads to. + When disabled, only the exit directions are listed. diff --git a/data/help/left-tinymap.yaml b/data/help/left-tinymap.yaml new file mode 100644 index 0000000..689aa89 --- /dev/null +++ b/data/help/left-tinymap.yaml @@ -0,0 +1,11 @@ +name: "left-tinymap" +category: "Options" +description: | + Show the mini-map on the left side of room descriptions. + + Type: boolean (on/off) + Default: off + + When both tinymap and left-tinymap are enabled, the + mini-map appears on the left side of the room description + rather than the right. 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 diff --git a/data/help/mapheight.yaml b/data/help/mapheight.yaml new file mode 100644 index 0000000..ee3920b --- /dev/null +++ b/data/help/mapheight.yaml @@ -0,0 +1,10 @@ +name: "mapheight" +category: "Options" +description: | + Height of the full map display in characters. + + Type: integer + Default: 20 + + Controls how many rows tall the map command + output is. Must be at least 5. diff --git a/data/help/mappadding.yaml b/data/help/mappadding.yaml new file mode 100644 index 0000000..201ef53 --- /dev/null +++ b/data/help/mappadding.yaml @@ -0,0 +1,13 @@ +name: "mappadding" +category: "Options" +description: | + Controls how the map command trims its output. + + Type: string + Default: none + Values: none, x, y, xy + + none - Strip blank rows and left-trim whitespace + x - Strip blank rows only (horizontal trim) + y - Left-trim whitespace only (vertical trim) + xy - No trimming (raw output) diff --git a/data/help/mapwidth.yaml b/data/help/mapwidth.yaml new file mode 100644 index 0000000..7e372ef --- /dev/null +++ b/data/help/mapwidth.yaml @@ -0,0 +1,10 @@ +name: "mapwidth" +category: "Options" +description: | + Width of the full map display in characters. + + Type: integer + Default: 30 + + Controls how many columns wide the map command + output is. Must be at least 5. diff --git a/data/help/mobenter.yaml b/data/help/mobenter.yaml new file mode 100644 index 0000000..529a5a5 --- /dev/null +++ b/data/help/mobenter.yaml @@ -0,0 +1,10 @@ +name: "mobenter" +category: "Options" +description: | + Show messages when mobs enter the room. + + Type: boolean (on/off) + Default: on + + When enabled, you are notified when a mob wanders + into your current room. diff --git a/data/help/mobleave.yaml b/data/help/mobleave.yaml new file mode 100644 index 0000000..06ddeab --- /dev/null +++ b/data/help/mobleave.yaml @@ -0,0 +1,10 @@ +name: "mobleave" +category: "Options" +description: | + Show messages when mobs leave the room. + + Type: boolean (on/off) + Default: on + + When enabled, you are notified when a mob wanders + out of your current room. diff --git a/data/help/mobspawn.yaml b/data/help/mobspawn.yaml new file mode 100644 index 0000000..d6c096f --- /dev/null +++ b/data/help/mobspawn.yaml @@ -0,0 +1,10 @@ +name: "mobspawn" +category: "Options" +description: | + Show messages when mobs spawn in the area. + + Type: boolean (on/off) + Default: on + + When enabled, you are notified when a mob respawns + anywhere in the area. diff --git a/data/help/option.yaml b/data/help/option.yaml new file mode 100644 index 0000000..1948b7a --- /dev/null +++ b/data/help/option.yaml @@ -0,0 +1,20 @@ +name: "option" +category: "General" +description: | + View or change character settings. + + Usage: option - List all options and their current values + options - Same as option + option <name> - Show details for a specific option + option <name> <val> - Set an option to a value + + Boolean options accept on/off, true/false, yes/no, or 1/0. + String options show available choices with option <name>. + Numeric options accept any integer. + + Examples: + option tinymap off + option color ansi + option mapwidth 50 + + Use help <option> for details on a specific option. diff --git a/data/help/reserve.yaml b/data/help/reserve.yaml new file mode 100644 index 0000000..e7308fd --- /dev/null +++ b/data/help/reserve.yaml @@ -0,0 +1,11 @@ +name: "reserve" +category: "Options" +description: | + Show full reserved item details in look. + + Type: boolean (on/off) + Default: on + + When enabled, reserved ground items show the player + name and remaining ticks. + When disabled, reserved items just show "(reserved)". diff --git a/data/help/tinymap.yaml b/data/help/tinymap.yaml new file mode 100644 index 0000000..cbff629 --- /dev/null +++ b/data/help/tinymap.yaml @@ -0,0 +1,11 @@ +name: "tinymap" +category: "Options" +description: | + Show the mini-map alongside room descriptions in look. + + Type: boolean (on/off) + Default: on + + When enabled, a 3x3 mini-map is displayed next to room + descriptions. Your current room is shown as @, with + surrounding rooms and connections. diff --git a/data/help/toggle.yaml b/data/help/toggle.yaml deleted file mode 100644 index 27080be..0000000 --- a/data/help/toggle.yaml +++ /dev/null @@ -1,18 +0,0 @@ -name: "toggle" -category: "General" -description: | - Toggle character settings on or off. - - Usage: toggle - List all toggles and their current status - toggle <name> - Toggle a setting on or off - - Toggles: - description - Long room descriptions when moving between rooms - tinymap - Mini-map display (not yet implemented) - xpdrops - Show XP gained in gather, crafting, and combat messages - exits - Show exit destinations in look output - mobenter - Notify when a mob enters the room - mobleave - Notify when a mob leaves the room - mobspawn - Notify when a mob spawns in the area - reserve - Show full reserved item details in look - depletion - Show depletion and despawn timers on objects diff --git a/data/help/xpdrops.yaml b/data/help/xpdrops.yaml new file mode 100644 index 0000000..f873a85 --- /dev/null +++ b/data/help/xpdrops.yaml @@ -0,0 +1,10 @@ +name: "xpdrops" +category: "Options" +description: | + Show XP gained in gather, crafting, and combat messages. + + Type: boolean (on/off) + Default: on + + When enabled, XP gains are appended to action messages. + For example: "You get some copper ore. (+10xp min)" |