# Battle Pass

Battle Pass is an optional feature that provides a battle pass system for players.

Battle Pass settings located in the /ExcellentQuests/battlepass.yml config file.

Battle Pass feature can be disabed in the config.yml -> Features -> BattlePass

# Seasons

Battle Pass works by seasons. This means that you have to start a new season to activate the Battle Pass for players.

To start a new season, use the /bp start command. You can set a custom season name and days duration.

Active or scheduled seasons can be force cancelled using the /bp cancel command. This will permanently remove them from the database.

# Leveling

Players can level up their battle pass by completing Daily Quests to get battle pass XP.

Progression settings located under the Leveling -> Progression section in the battle pass config. Amount of XP required for next level increase in geometric progression, starting from 250 XP on level 1 and ending with 500 XP on level 105.

# Premium Access

You can automatically unlock the Premium battle pass access for players with the excellentquests.battlepass.premium permission.

To do that, enable the GivePremiumByPermission setting in the battle pass config.

Players will get their Premium access as soon as they join the server during an active season or when a new season is launched.

# Rewards

Rewards for Battle Pass levels are configurable under the Levels section in the battle pass config.

# This is where battle pass level rewards starts.
Levels:
  # Battle Pass level.
  # You may list only levels where you give rewards to keep your config clean.
  '3':
    # Default rewards available for all players.
    # Set to '' for no rewards.
    Default_Rewards: bp_cash_low
    # Premium rewards available only for players with the Premium access.
    # Set to '' for no rewards.
    Premium_Rewards: ''
  '6':
    Default_Rewards: bp_cash_high
    Premium_Rewards: ''