UI & HUD
The Season Pass provides a multi-tab UI accessible via the Season Pass Book item or the /sp command, plus a persistent HUD tracker on screen.
Season Pass Book Item
The Season Pass Book is a physical in-game item (Spellbook model, Rare quality) that opens the Season Pass UI on right-click.
Item Configuration
Configured in config.json under the item section:
| Setting | Default | Description |
|---|---|---|
enabled | true | Enable the Season Pass Book item |
itemId | "SeasonPass" | Item ID |
giveOnFirstJoin | true | Auto-give on first login |
giveOnEveryJoin | false | Re-give on every login |
hotbarSlot | 8 | Hotbar slot (0-8) |
giveDelaySeconds | 3 | Delay before giving (allows world load) |
The item is only given when a season is active. Duplicate protection prevents multiple copies in inventory.
Season Pass UI Tabs
Tiers Tab
The main progression view showing the free and premium reward tracks.
- 6 tiers per page with pagination (left/right arrows)
- Free Track — Top row, rewards available to all players
- Premium Track — Bottom row, requires premium pass
- Tier Badge — Shows tier number; turns green with "Claim now" text when rewards are claimable
- Lock Overlay — Displayed on tiers not yet reached or premium-only tiers
- Bonus Tiers — Tiers 31-40 shown after the standard 30 tiers
Claiming Rewards:
- Reach the required tier through XP progression
- Click the green "Claim now" badge on the tier
- Rewards are automatically granted (items, commands, lootbags, tokens)
- Badge returns to showing the tier number after claim
- Claim All button appears when 2+ rewards are claimable — claims all at once
Prestige Badge:
- After reaching max tier with
prestigeEnabled, a prestige badge shows the current level - Prestige level and XP boost percentage displayed
If the player doesn't have premium, premium rewards show a lock overlay. Purchasing premium retroactively unlocks all earned premium tiers for claiming.
Challenges Tab
Displays active daily and weekly challenges with progress tracking.
- 3 Daily Challenges — Reset at midnight
- 3 Weekly Challenges — Reset every Monday
- Each challenge shows: name, progress bar,
X/Ycount, XP reward, token reward - Completed challenges display a green checkmark
- Reset countdown per section ("Resets in: Xh Ym")
Premium Challenges:
- 2 extra daily + 1 extra weekly challenge below the regular challenges
- Non-premium players see a lock box with hint text instead
- Premium challenges show the same progress tracking UI
Shop Tab
Daily rotating token shop with purchasable items.
- 4 Item Cards per day
- Each card shows: icon, name, description, token cost, buy button
- Token Balance displayed in the header
- Refresh Timer — Countdown until next rotation
- SOLD Badge — Dark overlay on already-purchased items
- Buy button disabled when insufficient tokens
Premium Shop:
- 2 extra shop slots below the regular items
- Non-premium players see a lock box with hint text
History Tab
Archive of past season progress.
- Up to 5 entries from previous seasons
- Each entry shows: season name, max tier reached, total XP earned, tokens earned, premium status
- Displayed when no season is active or for reference
Settings Page
Accessible from the Season Pass UI via a settings button.
Available Settings
| Setting | Options | Default | Description |
|---|---|---|---|
| HUD Enabled | On / Off | On | Toggle the HUD tracker |
| HUD Position | 4 presets | Top Right | Position preset selection |
| XP Notifications | All / Large / Off | Large | Chat notification mode |
| Tier-Up Notifications | On / Off | On | Chat notification on tier-up |
| Challenge Notifications | On / Off | On | Chat notification on challenge complete |
XP Notification Modes
| Mode | Description |
|---|---|
| All | Show every XP gain in chat |
| Large | Only show XP gains above threshold (default: 50 XP) |
| Off | No XP notifications in chat |
HUD Tracker
A persistent on-screen display showing season progress at a glance.
Display Information
- Season name
- Current tier / Max tier
- XP progress toward next tier
- Season Token balance
Position Presets
| Preset | X | Y |
|---|---|---|
top_left | 16 | 100 |
top_right | 1580 | 100 |
middle_right | 1580 | 430 |
bottom_right | 1580 | 700 |
Features
- Auto-hide when the world map is opened
- MHUD Compatible — Works alongside other mods using the MHUD system
- Real-time Updates — Refreshes on XP gain, tier-up, and token changes
- Per-Player Toggle — Each player can enable/disable via settings
- Global Toggle — Server admin can disable for all players in
config.json
All HUD element IDs use the #SP prefix (e.g., #SPTier, #SPXp) to avoid conflicts with other mods' HUDs. This follows the global HUD element ID convention.
Premium Info Page
A modal page shown when clicking the premium button (if not already premium):
- Lists premium benefits (1.5x XP boost, exclusive rewards, premium badge)
- Shows current premium status (owned or not)
- Displays premium cost and currency
- Directs players to use
/sp buyfor purchase
The premium button opens an info page instead of directly purchasing. Players must explicitly use /sp buy to complete the purchase. This prevents accidental premium purchases.