# Boosters

Boosters are used to temporary increase amount of the job XP and Income players receive from job objectives.

There are 3 types of boosters available:

Global. Server-wide booster applied to all online players and all jobs. Max. 1 global booster.
Personal. Individual booster applied to specific player(s) and specific job(s). Max. 1 booster per each job.
Rank. Rank booster applied to all players with specific rank(s) or permission(s) with no expire time. Max. 1 booster per each player.

Booster's income multiplier applied to all currencies available. You can exclude certain currencies from booster's effect in the Boosters configuration.

Boosters may have "negative" effect by using multipliers less than 1: 0.5 = -50%, 0.1 = -90%.

# Configuration

Boosters configuration located in the boosters.yml config file inside the ExcellentJobs directory.

# Toggle Feature

The whole Boosters feature can be toggled on/off in the config.yml under Features -> Boosters option.

# Global Boosters

Global boosters defined under the BySchedule section. There you set days, local times when boosters will trigger automatically and duration in seconds.

You can force run/stop global boosters using the booster commands.

Example of 6-hour booster with +35% Income and +50% XP multipliers on Saturday and Sunday:

BySchedule:
  weekend:
    Start_Times:
      SATURDAY: '12:00'
      SUNDAY: '12:00'
    Income_Multiplier: 1.35
    XP_Multiplier: 1.5
    Duration: 21600 # In seconds

You can add as many boosters as you want, but only one global booster can be active at the same time.

# Personal Boosters

Personal boosters are given using the booster commands.

# Rank Boosters

Rank boosters defined under the ByRank section. There are two sections: Income and XP for Income and XP boosters accordingly.

Rank boosters are persistent and will work while player has specific rank(s) or permission(s).

Example of Income and XP rank boosters for the vip and pro ranks with +50% and +100% boosts accordingly:

ByRank:
  Income:
    Mode: PERMISSION
    Permission_Prefix: excellentjobs.rankbooster.income.
    Default_Value: 1.0
    Values:
      vip: 1.5
      pro: 2.0
  XP:
    Mode: PERMISSION
    Permission_Prefix: excellentjobs.rankbooster.xp.
    Default_Value: 1.0
    Values:
      vip: 1.5
      pro: 2.0

There are more details about all the options above inside the configuration file.

Permission defined for rank boosters is fully custom and therefore not listed on the permissions page.