aboutsummaryrefslogtreecommitdiff
path: root/data/help/prompt.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'data/help/prompt.yaml')
-rw-r--r--data/help/prompt.yaml35
1 files changed, 35 insertions, 0 deletions
diff --git a/data/help/prompt.yaml b/data/help/prompt.yaml
new file mode 100644
index 0000000..95d852b
--- /dev/null
+++ b/data/help/prompt.yaml
@@ -0,0 +1,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 "> "