aboutsummaryrefslogtreecommitdiff
path: root/data/help/color.yaml
diff options
context:
space:
mode:
authorhistoria <[not public]>2026-06-15 02:57:35 -0400
committerhistoria <[not public]>2026-06-15 02:58:50 -0400
commit4cc1ddcd185509080b4b3e15d1646567edd51c9d (patch)
tree2a564846ad4fd159a2d7e55451bfa9569fe8c0b8 /data/help/color.yaml
parent445c4612cc5cf2c226f85894b6ad1e2419a374e2 (diff)
downloadthehouseoficarus-4cc1ddcd185509080b4b3e15d1646567edd51c9d.tar.gz
removed game speed for being broken and an antifeature anyway. added color support.
Diffstat (limited to 'data/help/color.yaml')
-rw-r--r--data/help/color.yaml24
1 files changed, 21 insertions, 3 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>.