Skip to content

Commit bb8e081

Browse files
authored
docs: update customization guide about player.job (#5984)
1 parent 1c9f0b7 commit bb8e081

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

docs/CactbotCustomization.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ This has options for things like:
2828

2929
- setting triggers to tts
3030
- disabling triggers
31-
- changing the output of triggers
31+
- changing the output text of triggers
32+
- changing triggers to say a player's job instead of name
3233
- changing your cactbot language
3334
- volume settings
3435
- getting rid of that cheese icon
@@ -67,6 +68,23 @@ You cannot add additional parameters.
6768
If you want to do any of these more complicated overrides,
6869
then you will want to look at the [Overriding Raidboss Triggers](#overriding-raidboss-triggers) section.
6970

71+
Any parameter that refers to a player (usually called `${player}` but not always)
72+
can also be further modified in each individual output string:
73+
74+
- `${player.job}`: job abbreviation, e.g. WHM
75+
- `${player.jobFull}`: job full name, e.g. White Mage
76+
- `${player.role}`: role, e.g. support
77+
- `${player.name}`: player's full name, e.g. Tini Poutini
78+
- `${player.nick}`: player's nickname / first name, e.g. Tini
79+
- `${player.id}`: a player's id (for testing purposes), e.g. 1000485F
80+
81+
If there are bugs or a player is not in your party or you use an invalid suffix,
82+
it may fall back to a default nickname just so something can be printed.
83+
84+
By default, `${player}` implies `${player.nick}`,
85+
however you can set this default with the "Default Player Label" option
86+
in the cactbot config UI under the raidboss section.
87+
7088
## User Directory Overview
7189

7290
If the cactbot UI doesn't have the option you are looking for,

0 commit comments

Comments
 (0)