aboutsummaryrefslogtreecommitdiff
path: root/data/help/prompt.yaml
blob: 961b605a1fa3670660813ce23abecc9169f01ca6 (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
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
    %b           Current battery level
    %B           Maximum battery level
    %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
    %e           Open room exits as letters, blocked omitted (e.g. NSD)
    %E           All room exits as letters (e.g. NSD)
    %x_<skill>   XP to next level for a skill (e.g. %x_mining)
    %X_<skill>   Total XP for a skill (e.g. %X_accuracy)

  Use %% for a literal % sign.

  Color blocks:
    {<00-FF> [bold] [dim] [underline]}text{/}
    {g:<a>,<b>[,<c>...]}gradient text{/}

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

  Examples:
    prompt > 
    prompt {06}%h/%Hhp $%c %s{/} >
    prompt <{02}%h{/}/{01}%H{/}hp> 
    prompt {D0 bold}%h/%Hhp{/} >