aboutsummaryrefslogtreecommitdiff
path: root/data/help/prompt.yaml
blob: f3c23f48fd66aaba92ee89d1f9772a2bc3a5d1c8 (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
name: "prompt"
category: "General"
description: |
  Customize your command prompt. Prompts are per-character.

  Usage:
    prompt              Show current prompt
    prompt <value>      Set a custom prompt
    prompt none         Set prompt to blank
    prompt reset        Restore default "> "

  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:
    {<0-255> [bold] [dim] [underline]}text{/}
    {g:<a>,<b>[,<c>...]}gradient text{/}

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

  Examples:
    prompt > 
    prompt {6}%h/%Hhp $%c %s{/} >
    prompt <{2}%h{/}/{1}%H{/}hp> 
    prompt {208 bold}%h/%Hhp{/} >