The Battle Pass Extension allows you to implement seasonal progression systems. Players can earn XP, level up, and unlock rewards through a configurable pass interface.Documentation Index
Fetch the complete documentation index at: https://docs.borntocraftstudio.net/llms.txt
Use this file to discover all available pages before exploring further.
📚 Entry Library
⚙️ Configuration
Main setting files for the Battle Pass.Messages
Language & Text configuration
📖 Definitions
Core definitions for the Battle Pass structure.Battle Pass Definition
Define seasons, levels, and tracks
📦 Artifacts
Data storage and persisted information.Battle Pass Data
Player progress storage
Open Battle Pass
Action that opens the battle pass menu for the player.
Facts
Quest Active Fact
Fact returning 1 when the configured battle pass week is active (available) for the player.
Commands
| Command | Permission | Description |
|---|---|---|
/battlepass pass <id> xp add <amount> [player] | typewriter.battlepass | Add XP to a player’s battle pass. |
/battlepass pass <id> xp remove <amount> [player] | typewriter.battlepass | Remove XP from a player’s battle pass. |
/battlepass pass <id> xp set <amount> [player] | typewriter.battlepass | Set a player’s battle pass XP. |
/battlepass pass <id> level add <amount> [player] | typewriter.battlepass | Add levels to a player’s battle pass. |
/battlepass pass <id> level remove <amount> [player] | typewriter.battlepass | Remove levels from a player’s battle pass. |
/battlepass pass <id> level set <amount> [player] | typewriter.battlepass | Set a player’s battle pass level. |
/battlepass pass <id> info [player] | typewriter.battlepass | View battle pass progress info. |
Placeholders
| Placeholder | Description |
|---|---|
%battlepass:<id>:name% | The name of the battle pass. |
%battlepass:<id>:active% | 1 if the battle pass is active, 0 otherwise. |
%battlepass:<id>:level% | The player’s current level. |
%battlepass:<id>:xp% | The player’s current XP. |
%battlepass:<id>:xp:max% | The max XP for the current level (or total max). |
%battlepass:<id>:xp:next% | The XP required for the next level. |
%battlepass:<id>:xp:remaining% | The XP remaining until the next level. |
%battlepass:<id>:rewards:total% | Total number of rewards. |
%battlepass:<id>:rewards:claimed% | Number of claimed rewards. |
%battlepass:<id>:rewards:available% | Number of available rewards. |
%battlepass:<id>:rewards:unclaimed% | Number of unclaimed rewards (available - claimed). |
%battlepass:<id>:week:<number>:state% | The state of the week (LOCKED, AVAILABLE, COMPLETED). |
%battlepass:<id>:week:<number>:active% | 1 if the week is active/available, 0 otherwise. |
%battlepass:<id>:week:<number>:title% | The title of the week. |
%battlepass:<id>:week:<number>:description% | The description of the week. |