aboutsummaryrefslogtreecommitdiff
path: root/data/help/color.yaml
blob: 777aa07ea8b04d09cfa8fc9952472f1878bd7b47 (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
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> <string>   Set a custom color
    color <target> reset      Reset to server default
    color <target> off        Disable color for this target entirely

  Color string format (space-separated tokens):
    fg=<color>   Foreground color
    bg=<color>   Background color
    bold         Bold text
    dim          Dim text
    italic       Italic text
    underline    Underlined text

  Example: fg=green bg=black bold

  Available color names:
    black, red, green, yellow, blue, magenta, cyan, white,
    bright_black, bright_red, bright_green, bright_yellow,
    bright_blue, bright_magenta, bright_cyan, bright_white

  Color targets:
    room_name      Room name headers
    room_number    Room number display (#id)
    room_desc      Room description text
    direction      Movement direction text ("You walk north")
    exit_direction Exit direction labels (north, south, etc.)
    exit_name      Exit destination room names
    mob_name       Mob names in combat
    friendly_npc   Friendly NPC names (cannot be attacked)
    hostile_npc    Hostile NPC/mob names in room listings
    damage         Damage numbers
    enemy_hp       Enemy HP in combat messages
    character_hp   Your HP in combat messages
    xp             XP gain messages
    level_up       Level-up announcements
    item           Item names on pickup/drop/gather
    player_name    Player names in broadcasts
    death          Death message
    victory        Combat victory message
    miss           Miss messages in combat
    error          Error messages

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

  Auto-colored elements (not configurable):
    - Objects: fishing spots are blue, rocks are earth-toned, trees green
    - Items: ores, logs, fish, gems, and tools have their own colors
    - Mob/player levels: displayed relative to your combat level
      (red if higher, orange if <5 higher, white if equal,
       yellow if <5 lower, green if much lower)

  The "color" option (option color none/ansi/xterm256) controls
  whether ANSI codes are emitted and which mode is used.
  "none" strips all color; the "color" command settings are
  still saved but have no visual effect until color mode is
  enabled.

  You can use color blocks in your prompt using the same format:
    option prompt {fg=green bold}Ready>{/} %h/%Hhp
  See 'help prompt' for full prompt customization.