SxBattlePass Documentation
━━━━━━━━━━━━━━━━━━━━
PLUGIN INFORMATION
━━━━━━━━━━━━━━━━━━━━
Name: SxBattlePass
Author: Silent Dev
Minecraft Version: 1.21+
Folia Support: Yes
Paper Support: Yes
Spigot Support: Yes
Soft Dependencies:
• PlaceholderAPI
• Vault
━━━━━━━━━━━━━━━━━━━━
INSTALLATION
━━━━━━━━━━━━━━━━━━━━
1. Download SxBattlePass.jar
2. Place the jar into your plugins folder.
3. Restart your server.
4. Configure the plugin files.
5. Use /bpa reload after making changes.
━━━━━━━━━━━━━━━━━━━━
PERMISSIONS
━━━━━━━━━━━━━━━━━━━━
battlepass.use
Regular player access.
battlepass.admin
Full administrative access.
battlepass.editor
Access to the in-game editor.
battlepass.debug.id
Displays quest and week IDs.
sxbattlepass.block
Blocks a player from using SxBattlePass.
━━━━━━━━━━━━━━━━━━━━
PLAYER COMMANDS
━━━━━━━━━━━━━━━━━━━━
Aliases:
/sxpass
/sxbp
/sxbattlep
/pass
/bp
/bp open
Open the main menu.
/bp menu
Open the main menu.
/bp open week <week>
Open a specific week.
/bp open event <event>
Open an event menu.
/bp booster
View active boosters.
/bp leaderboard
Open leaderboard menu.
/bp leaderboard quests
Open quest leaderboard.
/bp leaderboard tier
Open tier leaderboard.
/bp stats
View personal statistics.
/bp help
Show help menu.
━━━━━━━━━━━━━━━━━━━━
ADMIN COMMANDS
━━━━━━━━━━━━━━━━━━━━
Aliases:
/sxbpa
/bpa
/sxbattlepassa
/bpa reload
Reload the plugin.
/bpa editor
Open editor menu.
/bpa open week <week>
Open week menu as admin.
/bpa set pass <player> <pass-id>
Set a player's pass.
/bpa set pass all <pass-id>
Set pass for all players.
/bpa set pass online <pass-id>
Set pass for all online players.
/bpa set points <player> <points>
Set player points.
/bpa set balance <player> <amount>
Set player balance.
/bpa give points <player> <points>
Give points.
/bpa give balance <player> <amount>
Give balance.
/bpa giveall points <points>
Give points to everyone.
/bpa giveall balance <amount>
Give balance to everyone.
/bpa remove balance <player> <amount>
Remove balance.
/bpa boosters add <player/all> <type> <percent> <hours> <affects>
Add a booster.
/bpa boosters clear <player/all>
Clear boosters.
/bpa progress quest <player> <week> <quest-id> <amount>
Progress a quest.
/bpa progress daily quest <player> <quest-id> <amount>
Progress a daily quest.
/bpa quest ids
Display week quest IDs.
/bpa daily quest ids
Display daily quest IDs.
/bpa new season
Start a new season.
/bpa delete user <player>
Delete player data.
/bpa close menu <player>
Force close menu.
/bpa material item
Get item identifier.
/bpa material block
Get targeted block identifier.
/bpa material b64
Get Base64 data of held item.
/bpa migrate storage <newType>
Migrate storage.
/bpa bypass locked quests <player>
Toggle locked quest bypass.
━━━━━━━━━━━━━━━━━━━━
PLACEHOLDERAPI
━━━━━━━━━━━━━━━━━━━━
All placeholders begin with:
%battlepass_%
Player Data:
%battlepass_points%
%battlepass_experience%
%battlepass_tier%
%battlepass_pass_type%
%battlepass_pass_id%
%battlepass_balance%
%battlepass_completed_quests%
Time:
%battlepass_time_to_daily_reset%
%battlepass_time_to_next_week%
%battlepass_time_to_season_end%
Leaderboards:
%battlepass_top_tier_<place>_name%
%battlepass_top_tier_<place>_value%
%battlepass_top_quests_<place>_name%
%battlepass_top_quests_<place>_value%
━━━━━━━━━━━━━━━━━━━━
FEATURES OVERVIEW
━━━━━━━━━━━━━━━━━━━━
✔ Battle Pass Progression
✔ Free & Premium Passes
✔ Daily Quests
✔ Weekly Quests
✔ Seasons
✔ Experience System
✔ Tier Rewards
✔ Quest Rewards
✔ Leaderboards
✔ Boosters
✔ In-Game Editor
✔ PlaceholderAPI Support
✔ Vault Integration
✔ Folia Support
━━━━━━━━━━━━━━━━━━━━
❓ SUPPORT
━━━━━━━━━━━━━━━━━━━━
Discord:
https://discord.gg/y6V4yh4RBM
For support, bug reports, feature requests, and updates, join the official Discord server.