aboutsummaryrefslogtreecommitdiff
path: root/data/help
diff options
context:
space:
mode:
Diffstat (limited to 'data/help')
-rw-r--r--data/help/automap.yaml4
-rw-r--r--data/help/hide.yaml15
-rw-r--r--data/help/map.yaml6
-rw-r--r--data/help/map_height.yaml (renamed from data/help/mapheight.yaml)2
-rw-r--r--data/help/map_padding.yaml (renamed from data/help/mappadding.yaml)2
-rw-r--r--data/help/map_width.yaml (renamed from data/help/mapwidth.yaml)2
-rw-r--r--data/help/option.yaml2
-rw-r--r--data/help/safespot.yaml38
8 files changed, 62 insertions, 9 deletions
diff --git a/data/help/automap.yaml b/data/help/automap.yaml
index 32b84cb..3cd1a2f 100644
--- a/data/help/automap.yaml
+++ b/data/help/automap.yaml
@@ -9,5 +9,5 @@ description: |
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.
+ Map size and padding are controlled by the map_width,
+ map_height, and map_padding options.
diff --git a/data/help/hide.yaml b/data/help/hide.yaml
new file mode 100644
index 0000000..eb2d27a
--- /dev/null
+++ b/data/help/hide.yaml
@@ -0,0 +1,15 @@
+name: "hide"
+category: "Skills"
+description: |
+ Hide behind a safespot object to block melee attacks.
+
+ Usage: hide <object>
+ hide behind <object>
+ safespot <object>
+
+ Hiding takes 1 tick out of combat or 4 ticks while fighting. If a mob
+ hits you during repositioning in combat, the hide attempt fails.
+
+ Leave cover with: unhide (or unsafespot)
+
+ See also: help safespot, help combat
diff --git a/data/help/map.yaml b/data/help/map.yaml
index 3b4917a..7ca03a2 100644
--- a/data/help/map.yaml
+++ b/data/help/map.yaml
@@ -9,11 +9,11 @@ description: |
centered on your current location. You are shown as @.
Map size is controlled by:
- option mapwidth <num> (default 30)
- option mapheight <num> (default 20)
+ option map_width <num> (default 30)
+ option map_height <num> (default 20)
Padding/trimming is controlled by:
- option mappadding <mode>
+ option map_padding <mode>
none - strip blank lines + left-trim (default)
x - strip blank lines only
y - left-trim only
diff --git a/data/help/mapheight.yaml b/data/help/map_height.yaml
index ee3920b..32daf0a 100644
--- a/data/help/mapheight.yaml
+++ b/data/help/map_height.yaml
@@ -1,4 +1,4 @@
-name: "mapheight"
+name: "map_height"
category: "Options"
description: |
Height of the full map display in characters.
diff --git a/data/help/mappadding.yaml b/data/help/map_padding.yaml
index 201ef53..7772226 100644
--- a/data/help/mappadding.yaml
+++ b/data/help/map_padding.yaml
@@ -1,4 +1,4 @@
-name: "mappadding"
+name: "map_padding"
category: "Options"
description: |
Controls how the map command trims its output.
diff --git a/data/help/mapwidth.yaml b/data/help/map_width.yaml
index 7e372ef..3957bed 100644
--- a/data/help/mapwidth.yaml
+++ b/data/help/map_width.yaml
@@ -1,4 +1,4 @@
-name: "mapwidth"
+name: "map_width"
category: "Options"
description: |
Width of the full map display in characters.
diff --git a/data/help/option.yaml b/data/help/option.yaml
index 9fdcf7f..75b1794 100644
--- a/data/help/option.yaml
+++ b/data/help/option.yaml
@@ -15,7 +15,7 @@ description: |
Examples:
option tinymap off
option color ansi
- option mapwidth 50
+ option map_width 50
Use help <option> for details on a specific option.
Use 'prompt' to set a custom per-character prompt.
diff --git a/data/help/safespot.yaml b/data/help/safespot.yaml
new file mode 100644
index 0000000..76e1768
--- /dev/null
+++ b/data/help/safespot.yaml
@@ -0,0 +1,38 @@
+name: "safespot"
+category: "Skills"
+description: |
+ Use environmental cover to block melee attacks from mobs while
+ attacking with ranged or science weapons.
+
+ Usage: hide <object>
+ safespot <object>
+
+ Find a safespot: look <object>
+ Leave a safespot: unhide (or unsafespot)
+
+ While in a safespot, melee mobs cannot reach you. Ranged and science
+ mobs can still attack. Attacking with melee while in a safespot forces
+ you out of cover.
+
+ Safespots degrade over time while in use. Each degrade level shows a
+ different message. When fully degraded, the safespot is destroyed.
+ Some safespots respawn after a delay; others require you to re-hide
+ to reset them.
+
+ There is a small per-tick chance of being forced out of cover
+ (unsafe_chance). You can re-hide immediately if the safespot is
+ still intact.
+
+ Hiding out of combat takes 1 tick. Hiding while fighting takes 4
+ ticks — taking a hit during the repositioning aborts the attempt.
+
+ Your effective safespot tier is unlocked by completing quests and
+ combat achievements. Higher-tier safespots require quest flags like
+ "quest_animal_magnetism" or achievement flags like
+ "achieve_medium_combat".
+
+ You can customize the alert shown when you are forced out of a
+ safespot with: option safespot_alert <message>
+ Set to "none" to disable. Uses inline color tags.
+
+ See also: help hide, help combat, help option