aboutsummaryrefslogtreecommitdiff
path: root/data/help/color.yaml
blob: b07ab17cf60bfd5a40f7466bc7cf9b7999507677 (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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
name: "color"
category: "Options"
description: |
  Color output customization.

  The "color" command lets you customize the color of various game
  elements on an account-wide basis. Colors are shared by all
  characters on the same account.

  Usage:
    color                     List all targets and their current values
    color <target>            Show current color for a target
    color <target> <spec>     Set a custom color
    color <target> reset      Reset to server default
    color <target> off        Disable color for this target entirely

  Color spec format (space-separated tokens):
    <00-FF>      Foreground color (xterm-256 palette index, hex)
    bg:<00-FF>   Background color
    g:<a>,<b>    Gradient between two or more colors
    bold         Bold text
    dim          Dim text
    underline    Underlined text

  Examples:
    color room_name 06 bold
    color fire D0
    color death 01 bold
    color broadcast D6 bg:00

  Gradients interpolate across characters in RGB space:
    color item g:C4,52           Red to green
    color room_name g:2D,27,3B    Three-stop gradient

  Use 'colortable' to see all 256 colors and their hex codes.

  Colors use the xterm-256 palette (00-FF, hex). When a player's color
  mode is set to "ansi", extended colors (10-FF) automatically
  downgrade to the nearest of the 16 standard ANSI colors.

  Standard colors (00-0F):
    00 black    01 red      02 green    03 yellow
    04 blue     05 magenta  06 cyan     07 white
    08-0F bright variants of the above

  Inline color tags in room descriptions:
    {<spec>}colored text{/}
    {B6 bold}mysterious vase{/}
    {g:C4,52}gradient text{/}

  Color targets:
    room_name      Room name headers
    room_number    Room number display (#id)
    room_desc      Room description text (default for untagged text)
    direction      Movement direction text
    exit_direction Exit direction labels
    exit_name      Exit destination room names
    protected_mob   Protected mob names
    mob             Mob names (combat, room listings, etc.)
    damage_dealt    Damage to enemies
    damage_taken    Damage from enemies/hazards
    xp             XP gain messages
    level_up       Level-up announcements
    item           Item names (default)
    player_name    Player names in broadcasts
    death          Death message
    victory        Combat victory message
    miss           Missed attack messages
    error          Error messages
    say            Player chat text
    dialog         NPC conversation text
    broadcast      Room-wide event messages
    fire           Firemaking messages
    eat_food       Eating/healing messages
    drop_message   Mob loot drops
    currency_pickup Currency/credit/chip messages

  Map colors:
    map_at         The @ marker for your current room on the map
    map_blocked    The 'X' shown where a path is blocked

  Visual tick colors:
    visual_tick      Visual tick marker text (dim blue)
    visual_first_tick First tick in a numbered cycle (bright red)

  Resolution order:
    1. Account override (set via "color" command)
    2. Server default (set in config.yaml)
    3. Built-in fallback

  The "color" option (option color none/ansi/xterm256) controls
  whether ANSI codes are emitted. "none" strips all color.
  In "ansi" mode, extended palette colors (10-FF) are
  automatically downgraded to the nearest ANSI color.

  You can use color blocks in your prompt:
    prompt {02 bold}Ready>{/} %h/%Hhp
  See 'help prompt' for full prompt customization.