Job Settings
The job configuration file is divided into several sections, each containing a group of settings with common features.
Definition
This part of the config is primarily responsible for the visual representation of the job.
Parameters:
Name- Display name.Description- Job description.Icon- Job icon.Menu-Slots- Slot(s) for the Jobs GUI where the job icon will be displayed.Menu-Page- Page in the Jobs GUI where the job will be displayed.
See also our Text Formation Guide.
job_example.yml
Definition:
Name: '<white><sprite:"items":"item/blaze_rod"></white> <gradient:#fc4a1a:#f7b733><b>ALCHEMIST</b></gradient>'
Description:
- <gray>Mix ingredients in a brewing</gray>
- <gray>stand to make potions.</gray>
- <gray></gray>
- <gray>Turn your magical drinks into a</gray>
- <gray>great way to make money.</gray>
Icon:
Material: minecraft:brewing_stand
Lore: []
Menu-Slots: '32'
Menu-Page: 1Behavior
This part is responsible for the "behavior" of the job.
Parameters:
Permission-Required- If enabled, the player must have a permission to use the job.Join-Commands- Commands that will be automatically executed after the player joins the job.Leave-Commands- The same asJoin-Commands, but when the player leaves the job.
Commands Info
You can use all PlaceholderAPI placeholders along with our internal ones:
%player_name%- Real player name.%player_display_name%- Player custom name (or real name if none).%player_prefix%- Player prefix (provided by your permissions plugin if present).%player_suffix%- Player suffix (provided by your permissions plugin if present).%player_world%- The name of the player's world.- Internal job placeholders.
job_example.yml
Behavior:
Permission-Required: false
Join-Commands:
- say Hello %player_name%
Leave-Commands:
- say Goodbye %player_name%Grind
This part is responsible for the grind settings. Effective only if the Grinding module is enabled.
Parameters:
Bar-Color- Color of the grind bar displayed when completing objectives. List of available values.Objective-Ids- List of objective IDs available for the job.
job_example.yml
Grind:
Bar-Color: YELLOW
Objective-Ids:
- alchemist_brew
- alchemist_craftLeveling
This part is responsible for the progression settings. Effective only if the Leveling module is enabled.
Parameters:
Max-Level- Maximum possible job level.Reward-Pool-Ids- List of reward pool IDs given upon reaching levels.
job_example.yml
Leveling:
Max-Level: 100
Reward-Pool-Ids:
- basicContract
This part is responsible for the contract settings. Effective only if the Contracts module is enabled.
Parameters:
Required- If enabled, the player will need to choose a contract to join the job.Allowed-Ids- List of contract IDs available for the job.
job_example.yml
Contract:
Required: true
Allowed-Ids:
- '*'