Documentation
Economy and progressComplete

Battle pass

A seasonal pass with free and premium reward tracks, shared by your whole network.

The Battle pass module gives your players a season long goal. They earn pass XP by playing, unlock tiers, and claim a reward on the free track at each tier. Players with premium also claim the premium track. When a season ends, the next one starts by itself and everyone starts again from tier 0.

Note

This module requires the complete edition. See editions.

Features

  • Automatic seasons. Each season lasts the number of days you choose. A new one starts on its own, with its number in the name ("Season 3").
  • Up to 200 tiers, each with a free reward and a premium reward.
  • Rewards made of anything: money in any currency, items, console commands, and items you capture in game with their enchantments and custom names.
  • Pass XP from normal play. Every activity tracked by Progression can give pass XP, and so can each finished daily or weekly quest.
  • Premium. Players buy it in game with money, or you grant it with a permission or a command (handy for store purchases).
  • Safe delivery. Rewards go through the mailbox: anything that does not fit in the inventory waits there instead of being lost.
  • Unclaimed rewards. Optionally, rewards reached but not claimed at the end of a season are given at the player's next login.
  • One pass for the whole network. XP, premium and claims follow the player on every server.

Setting it up

Open the Battle pass module in the web editor and go to the Editor tab. It has four sections: Season, Rewards, Pass XP and Players.

Season

The top of the page shows the current season, the number of players, premium players and rewards claimed.

  • Start of the season: move the current season to another date. Its end follows the season length. You cannot pick a date that would make the season already over.
  • End the season now: starts a new season right away. Every player starts again from tier 0.
  • Season name: {season} becomes the season number. Default: Season {season}.
  • Season length (days): default 30, up to 365. Changing it also moves the end of the current season.
  • Give unclaimed rewards: when a season ends, rewards reached but not claimed are given at the next login. Otherwise they are lost. Default: off.
  • Announce each new season: message to every online player when a season starts. Default: on.

In the Premium panel:

  • Price in game: what players pay to unlock premium for the current season. 0 means it is not for sale in game. Default: 30,000.
  • Premium currency: empty uses your main currency.

Selling premium and giving money rewards need the Economy module.

The Placeholders panel lists every placeholder of the module.

Rewards

In Tier track, set:

  • Tiers: number of tiers, up to 200. Default: 30.
  • XP per tier: XP needed for each tier. Default: 1,000.
  • Growth per tier (%): each tier needs this much more XP than the previous one. 0 keeps the same XP for every tier. Default: 0.

The editor shows the XP of the full pass and an estimate in hours of play. Add 10 tiers, Fill empty tiers and Remove the last tier help you build the track quickly.

Click any free or premium slot to edit its reward:

  • Name shown: leave it empty for an automatic name, such as the money amount or the first item.
  • Icon shown in the menu.
  • Money, with its currency.
  • Items: pick items and amounts.
  • Commands: one per line, run from the console. {player} and {tier} are replaced.
  • Items captured in game: for items with enchantments, custom names or other details, put them in your inventory and type /pass setitems <tier> <free|premium> in game. Your whole inventory is saved for that reward. Remove the captured items clears them.

A tier with no reward on a track simply has nothing to claim on that track.

Pass XP

  • XP per daily quest and XP per weekly quest: pass XP for each finished quest. Defaults: 150 and 500.
  • Activities: pass XP for each activity, on top of the level XP of Progression.
Activity Default pass XP
Break blocks 0.5 per block
Place blocks 0.2 per block
Defeat mobs 3 per mob
Defeat players 10 per player
Fish 5 per catch
Craft 0.2 per item
Eat 1 per meal
Walk 0.01 per block
Playtime 10 per active minute
Chat 0
Breed animals 3 per birth
Enchant 8 per enchant
Trade with villagers 3 per trade
Daily reward 100 per claim
Warning

Activities and quests only give pass XP when the Progression module is on. Without it, only active playtime counts.

Players

Search a player, even offline, to Give, Take or Set pass XP, Give premium or Remove premium, or Reset their pass for this season (XP, premium bought and claimed rewards). Top players lists the 10 players with the most pass XP this season.

How players use it

/pass opens the pass menu. It shows the season and the time left, the player's tier and XP, the free and premium tracks page by page, a premium button and a claim all button. Reaching a tier shows a title and plays a sound. Rewards can be claimed while the season is running.

Premium can be unlocked in three ways:

  • buying it in game, for the current season only;
  • the permission inglis.battlepass.premium, which gives premium in every season;
  • the command /pass premium give <player>, from the console or a store, for the current season.

Commands

Command What it does Permission
/pass (also /battlepass, /bp) Opens the pass menu. From the console, shows season info. inglis.battlepass.use (everyone)
/pass claim Claims every reward you have reached. inglis.battlepass.use (everyone)
/pass buy Buys premium for the current season. inglis.battlepass.use (everyone)
/pass info Shows the season, the time left, your tier, XP and premium status. inglis.battlepass.use (everyone)
/pass xp <give|take|set> <player> <amount> Changes a player's pass XP, even offline. inglis.battlepass.admin (operators)
/pass premium <give|take> <player> Gives or removes premium for the current season, even offline. inglis.battlepass.admin (operators)
/pass reset <player> Resets a player's pass for this season. inglis.battlepass.admin (operators)
/pass setitems <tier> <free|premium> Saves your inventory as the items of that reward. inglis.battlepass.admin (operators)
/pass clearitems <tier> <free|premium> Removes the captured items of that reward. inglis.battlepass.admin (operators)

Permissions

Permission Grants Default
inglis.battlepass.use Using /pass. Everyone
inglis.battlepass.premium Premium in every season, without buying it. Nobody
inglis.battlepass.admin The admin subcommands. Operators

Placeholders

Placeholder Shows
%ingliscore_pass_tier% Current tier
%ingliscore_pass_tiers% Number of tiers
%ingliscore_pass_xp% XP earned inside the current tier
%ingliscore_pass_xp_needed% XP needed to finish the current tier
%ingliscore_pass_xp_total% Total pass XP this season
%ingliscore_pass_progress% Progress toward the next tier, in percent
%ingliscore_pass_premium% Whether the player has premium (Yes or No, in their language)
%ingliscore_pass_season% Season number
%ingliscore_pass_season_name% Season name
%ingliscore_pass_ends% Time left in the season

See placeholders for how to use them.

Tips

  • To sell premium on your web store, have the store run /pass premium give {player} from the console. It works even if the player is offline.
  • Use the hour estimate under Tier track to size your season: a full pass that takes far longer than the season length will discourage players.
  • Pass XP earned during a season stays in that season. When the next one starts, everyone starts again from tier 0.