aboutsummaryrefslogtreecommitdiff
path: root/data/help/prompt.yaml
blob: 95d852becc73f850c6d8aa6769f81d2d8a573edf (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
name: "prompt"
category: "Options"
description: |
  Customize your command prompt.

  Set via: option prompt <string>

  Your prompt string can include variables and color blocks.

  Variables:
    %h           Current HP
    %H           Maximum HP
    %c           Credits
    %m           Current mob HP (blank unless in combat)
    %M           Mob max HP (blank unless in combat)
    %s           Attack style shorthand (acc, agg, def, bal)
    %S           Attack style longform (accurate, aggressive, defensive, balanced)
    %i           Free inventory slots
    %x_<skill>   XP to next level for a skill (e.g. %x_mining)
    %X_<skill>   Total XP for a skill (e.g. %X_attack)

  Use %% for a literal % sign.

  Color blocks use the same format as the color command:
    {fg=green bold}text{/}

  A color block starts with {color_string} and ends with {/}.

  Examples:
    option prompt "> "
    option prompt "{fg=cyan}%h/%Hhp $%c %s{/} >"
    option prompt "<{fg=green}%h{/}/{fg=red}%H{/}hp> "

  To reset to the default "> ":
    option prompt "> "