Content generated with AI — it may contain mistakes.

ExyliaRewards/GuidesUpdated in v1.0.0

Run a battle pass

Run seasons where players earn XP from missions and playtime, climb tiers and claim a free and a premium track of rewards.

Page 10 of 226 min read

Run timed seasons where players earn XP from missions, playtime, votes and rewards, climb numbered tiers and claim a free track of rewards, plus a premium track for those who have it. You build everything from /battlepassadmin.

Before you start#

  • Players open the pass with /battlepass, which everyone can use by default (exyliarewards.battlepass.use). Staff need exyliarewards.battlepass.admin (operators by default).
  • Selling premium or tier skips needs an economy plugin. Without a price set, neither is for sale.
  • Only one season can be live at a time.

Steps#

Open the admin and create a season

Run /battlepassadmin and click Battle pass ▸ Seasons, then Seasons ▸ Create season. Or type /battlepassadmin season create <id> [name]. A new season is a draft: nobody sees it yet.

Fill it from a preset, or build it by hand

Open the season and click Season ▸ Presets to load a ready-made set of tiers and missions (PvP 30 tiers or Skyblock 40 tiers). It replaces the season's tiers and missions and asks you to confirm. To build by hand, use Season ▸ Tiers and Season ▸ Missions.

Set what each tier gives

In Season ▸ Tiers, click Tier N ▸ Rewards for a tier. Each tier has a free track and a premium track, each an ExyliaLib reward list. Use Season ▸ XP per tier to change what a tier costs.

Add missions

In Season ▸ Missions, click Missions ▸ Create mission. Give it a name and icon with Mission ▸ Name & icon, pick what players must do with Mission ▸ Objective, set the amount and XP with Mission ▸ Target & XP, and choose Mission ▸ Kind: daily, weekly or season.

Start the season

Click Season ▸ Start (or /battlepassadmin season start <id>), or set a start and end with Season ▸ Dates so it opens by itself. Players are told when it begins.

Check that it works#

As a player, run /battlepass: you see the season's tiers. Do a mission from /battlepass missions (for example mine some stone) and watch the XP. When you reach a tier, /battlepass claim collects what is ready. To skip the wait, staff can run /battlepassadmin xp give <player> <amount>.

Going further#

Tiers and missions#

  • Tiers: a new season has 50 tiers of 1000 XP, and every 10th is a highlight shown as the next goal. Change them under Battle pass ▸ Settings.
  • Missions: each player gets 3 daily missions drawn every day; weekly and season missions are always shown. The objective is what the mission counts (break blocks, kill mobs, fish, craft, smelt, eat, run a command, chat, talk to an NPC, playtime). Several targets can be separated by commas, and * means anything.
  • Swapping: a player can swap one unfinished daily mission a day (3 a day with premium).
  • Other XP: playtime gives 10 XP per minute played (idle minutes do not count). Votes, claimed rewards and referrals can give XP too, set to 0 by default.

Sell premium and skips#

Set a price in the pass settings and players buy from Premium ▸ Buy or /battlepass buy. Every tier they already reached becomes claimable. They can also gift it with /battlepass gift [player], and pay to skip tiers with /battlepass skip [tiers] (capped per season). Staff grant it with /battlepassadmin premium give <player> [season], and take it back with premium take. The permission exyliarewards.battlepass.premium gives premium on every season without a grant.

Boosters and catch-up#

  • /battlepassadmin booster give <player> <factor> <duration> [label] gives one player a timed XP multiplier, for example x2 2h. booster network does it for everyone on the network group.
  • Boosters multiply with each other and with catch-up (x1.5 for players well behind the season), up to a cap of x3.

Bonus tiers and prestige#

  • Season ▸ Bonus tiers adds repeatable tiers past the last one, paid from a pool, with an optional weekly limit per player.
  • Prestige lets a player at the last tier start over (free track again, premium pays once, on the first run). After a prestige premium cannot be bought or gifted to that player any more. It is off by default. New in v1.0.0

After the season#

When a season ends it enters its grace days (7 by default): players can still claim what they earned, and what is left over is delivered to them when the grace ends. Staff can end it early with Season ▸ End now, pause XP with Season ▸ Pause XP, or copy a season with Season ▸ Clone. Players see a recap with their tier and rank.

Feed it from other plugins#

/battlepassadmin progress <player> <objective> <thing> [amount] counts progress for a custom objective, so a store command or another plugin can complete missions.

Settings, states and commands

Settings (config.yml, battle-pass:; most also under Battle pass ▸ Settings):

KeyDefaultWhat it does
networkdefaultWhich servers share one pass. Restart to apply.
season-days60Length of a new season.
grace-days7Days to claim after the end.
deliver-unclaimedtrueDeliver unclaimed rewards when grace ends.
auto-claimfalseClaim each tier as it is reached.
default-tiers / default-tier-xp50 / 1000Size of a new season.
highlight-every10Every how many tiers is a highlight.
playtime-xp10XP per minute played.
daily-missions3Daily missions per player.
spawner-mobsfalseWhether spawner mobs count.
same-victim-minutes10Cooldown before the same victim counts again.
flush-seconds30How often progress is saved.
catch-up1.5Boost for players behind (1 = off).
daily-rerolls / premium-rerolls1 / 3Daily swaps.
bonus-tier-xp / bonus-weekly-cap2500 / 7Bonus tiers.
skip-price / skip-cap0 / 20Skipping tiers for money.
premium-price00 = not for sale.
booster-cap3.0Highest combined multiplier.
prestigefalseAllow starting over.
vote-xp / reward-xp / referral-xp0XP from other modules.

Prices use the currency of the same file. A season is a draft, scheduled, live or ended. Placeholders are on the Placeholders page and every command on Commands.

Something missing on this page? Tell us on Discord