aboutsummaryrefslogtreecommitdiff
path: root/data/help/color.yaml
blob: e56512a59978e6c98b38f83bcee901f0fc63c7dc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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, 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>.