aboutsummaryrefslogtreecommitdiff
path: root/data/help
diff options
context:
space:
mode:
Diffstat (limited to 'data/help')
-rw-r--r--data/help/color.yaml24
-rw-r--r--data/help/ticks.yaml4
2 files changed, 21 insertions, 7 deletions
diff --git a/data/help/color.yaml b/data/help/color.yaml
index 8171ab9..e56512a 100644
--- a/data/help/color.yaml
+++ b/data/help/color.yaml
@@ -8,6 +8,24 @@ description: |
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
+ none - No color output, tags are stripped.
+ ansi - Standard 16-color ANSI (works in most telnet clients + web client).
+ xterm256 - 256-color xterm codes (works in PuTTY, iTerm, Kitty, etc.,
+ but not in the web client).
+
+ You can embed color tags in your prompt string, character description,
+ and other free-text fields: <red>text</red> <bold>text</bold>
+ Tags are stripped if color mode is "none".
+
+ Available foreground colors:
+ black, red, green, yellow, blue, magenta, cyan, white,
+ bright_black, bright_red, bright_green, bright_yellow,
+ bright_blue, bright_magenta, bright_cyan, bright_white
+
+ Available styles:
+ bold, dim, italic, underline
+
+ Examples:
+ option color ansi
+ option prompt <green>Ready> </green>
+ description <red>A tall warrior</red> with <bright_yellow>golden hair</bright_yellow>.
diff --git a/data/help/ticks.yaml b/data/help/ticks.yaml
index fd128c2..5cd64b6 100644
--- a/data/help/ticks.yaml
+++ b/data/help/ticks.yaml
@@ -16,9 +16,5 @@ description: |
- Search timers
- Depletion and respawn timers
- The game_speed config option scales ALL tick timers proportionally.
- A game_speed of 2.0 makes everything resolve twice as fast; 0.5 makes
- everything twice as slow.
-
Use the "option" command to configure tick-related display settings.
Use "help option" for a list of all player options.