🌟 AuricPass

The Ultimate Battle Pass Experience

AuricPass is a lightweight, highly customizable, and independent Battle Pass plugin for your Minecraft server. Reward your players with an engaging progression system, featuring both Free and Premium tracks, custom GUI designs, and a unique Prestige system!

Download on Modrinth Discord Support YouTube Channel

✨ Key Features

Free & Premium Tracks: Offer a standard reward line for everyone and an exclusive premium line to monetize your server.

Prestige System (Extra Rewards): The grind never stops! Players who reach the max level enter an infinite loop, earning "Extra Rewards" for every specific amount of XP they gather.

Smart 6-Row GUI: Fully customizable menus with intelligent math-based pagination. Design your layout exactly how you want it.

Standalone XP Economy: AuricPass uses its own XP system via commands (/auricpass xp give). This means you can integrate it with ANY other plugin (Quests, MythicMobs, Crates) just by running a console command!

Advanced Command Execution: Rewards can trigger multiple actions. Use tags like [console], [player], [message], or [close] to execute exactly what you need.

Hex Colors & MiniMessage: Create stunning visuals with RGB gradients and modern formatting.

No Hard Dependencies: PlaceholderAPI is completely optional. AuricPass has its own internal placeholder engine!

Multi-language: Comes with English (en.yml) and Spanish (es.yml) by default.

⚙️ Commands

Below is the list of available commands for AuricPass:

/auricpass open [player] - Opens the GUI.
/auricpass xp give <player> <amount> - Gives XP to a player.
/auricpass xp remove <player> <amount> - Removes XP from a player.
/auricpass xp reset <player> - Resets a player's XP.
/auricpass premium [player] - Grants the premium battle pass to the user.
/auricpass reload - Reloads config and languages.

👑 Permissions

You can manage who has access to certain features using these permissions nodes:

Note: You can also grant the premium pass with the permission auricpass.premium, so administrators will have it by default.

auricpass.premium - The user who has it will have the premium pass.
auricpass.commands.open - Access to the command that opens the selected player's inventory.
auricpass.commands.premium - Access to the command to activate premium mode.
auricpass.commands.reload - Access to the command that reloads the settings.
auricpass.commands.xp - Access to the pass's XP command with all its variants.

🔗 Placeholders

Use these placeholders in your scoreboards, chat formats, or other plugins:

%auricpass_level% - Displays the player's current level.
%auricpass_xp% - Shows the amount of experience (XP) the player has earned at their current level.
%auricpass_required% - Shows the total amount of XP required for the current level to advance to the next one.
%auricpass_xp_left% - Shows the XP needed for the next level.
%auricpass_premium_status% - Displays player status (premium or free).

📄 Configuration Guide

The config.yml file in AuricPass is highly customizable. It supports MiniMessage for hex colors and gradients and allows you to structure the GUI and rewards exactly as you need.

Action Tags (Commands)

When setting up rewards or interactive items in the GUI, you can trigger multiple actions using our advanced tag system. You can stack as many commands as you want!

[console] command - Executes the command via the console (Default).
[player] command - Forces the player to execute the command.
[message] <text> - Sends a direct chat message to the player.
[close] - Automatically closes the inventory when clicked.

Click to view Action Tags Example

commands:
  - "[console] give %player% diamond 1"
  - "[message] <green>You claimed your daily diamond!</green>"
  - "[player] spawn"
  - "[close]"

Custom Items (Row 1)

The first row of the menu (Slots 0 to 8) is completely empty by default. This is the row-1-custom section, where you can create custom items to display information, links to your store, or open other menus!

Click to view Custom Item Example

row-1-custom:
  info-item:
    enabled: true
    slot: 4
    material: "BOOK"
    name: "<yellow><bold>Information</bold></yellow>"
    lore:
      - "<gray>Welcome to the Battle Pass!</gray>"
      - "<gray>Complete missions to earn XP.</gray>"
    commands:
      - "[message] <green>!Welcome to the Battle Pass!</green>"
    sound: "ENTITY_EXPERIENCE_ORB_PICKUP;1.0;1.0"

Adding Sounds

You can assign sounds to practically any item click or reward claim. The system uses the format SOUND_NAME;VOLUME;PITCH. If you do not want a sound, simply use "none".

🎵 Tip: Need to find the perfect sound? You can browse and listen to all Minecraft sounds at Spigotmc.

Click to view Sound Example

# Example of a level up sound:
sound: "ENTITY_PLAYER_LEVELUP;1.0;1.0"

# Example with no sound:
sound: "none"

Adding Rewards (Free & Premium)

You can create as many levels as you want under the rewards: (Free) and premium-rewards: sections. Make sure the node name follows the format level-X.

Click to view Reward Example

rewards:
  level-10:
    material: "DIAMOND_SWORD"
    name: "<aqua><bold>Level 10</bold></aqua>"
    lore:
      - "<yellow>Reward:</yellow>"
      - "<white>- 1x Epic Sword</white>"
      - "<gray>Missing <aqua>%auricpass_xp_left% XP</aqua> for level up!</gray>"
    commands:
      - "[console] give %player% diamond_sword 1"
    sound: "ENTITY_PLAYER_LEVELUP;1.0;1.0"

Custom Player Heads (Base64)

If you want to display a player's head in the GUI, you can set the material to PLAYER_HEAD self. But you can ALSO use a custom Base64 string directly in the material field to load custom decorative heads (like a treasure chest or a star).

Click to view Custom Head Example

player-info:
  slot: 49
  material: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvYmFkYzA0OGE3Y2U3OGY3ZGFkNzJhMDdkYTI3ZDg1YzA5MTY4ODFlNTUyMmVlZWQxZTNkYWYyMTdhMzhjMWEifX19"
  name: "<green><bold>Bonus Chest</bold></green>"
  lore:
    - "<gray>This item uses a Base64 texture!</gray>"
  commands: []
  sound: "none"

XP & Level Settings

You can define the maximum level of your battle pass and the required XP per level using ranges. This saves you from writing every single level manually!

Click to view XP Settings Example

settings:
  max-level: 54
  xp-for-level:
    "1-10": 10
    "11-20": 15
    "21-30": 25

Prestige System (Extra Rewards)

Once a player reaches the maximum level, you can enable the extra-rewards system to give them a repeating prize for every X amount of XP they earn. Set the limit: -1 to make it infinite!

Click to view Prestige Example

extra-rewards:
  enabled: true
  slot: 53
  xp-required: 50
  limit: -1
  material: "NETHER_STAR"
  name: "<aqua><bold>Prestige Rewards</bold></aqua>"
  commands:
    - "[console] give %player% diamond 1"