Season Pass

Season Pass

A full battle pass system for Hytale servers with tiered progression, daily and weekly challenges, a season shop, prestige system, XP boosters, and premium track support.

---

Features

Tiered Progression

• 30 Standard Tiers with increasing XP requirements
• 10 Bonus Tiers for dedicated players after completing the main track
• XP-based progression with configurable scaling per tier
• Tier-up toast notifications with queue system

Free + Premium Track

• Free Track available to all players with rewards at every tier
• Premium Track with exclusive rewards, unlockable via server currency or admin command
• Retroactive premium unlock grants all previously earned premium rewards
• Premium info page prevents accidental purchases
• premiumEnabled config flag to completely hide the premium track if desired
• premiumCommandOnly mode to restrict premium purchases to admin commands only

XP Sources

Earn XP from 12 configurable gameplay activities:

• Block breaking and placing
• Mob kills and PvP kills
• Block harvesting and flower picking
• Zone discovery and exploration
• Playtime (per minute)
• Quest completions
• Achievement completions
• Daily login bonus and login streak
• Challenge completions

Daily / Weekly Challenges

• 3 daily and 3 weekly challenges from weighted random rotation
• Premium players get extra challenge slots (2 daily + 1 weekly, configurable)
• Challenge type deduplication ensures variety within each category
• Challenges award both XP and Season Tokens
• premiumOnly flag for premium-exclusive challenges

Season Tokens

• Secondary currency earned proportionally to XP gains
• Used to purchase items in the Season Shop
• Displayed in challenge rewards (e.g., “+25 XP | +5 T”)

Configurable Currency System

• 3 currency modes: internal (default tokens), item (inventory items), economy (VaultUnlocked)
• Dynamic currency name and icon displayed everywhere in the UI
• Currency configured per season for maximum flexibility

Rarity System

• Rewards and shop items have rarity tiers: Common, Uncommon, Rare, Epic, Legendary
• Visual rarity color tinting on reward and shop cards
• Backward-compatible — defaults to Common if not specified

Full In-Game Admin Panel

• Complete admin panel with 11 tabs via /spadmin panel
• CONFIG: General, Season, Currency, Premium, XP Sources, Prestige
• CONTENT: Tiers, Challenges, Shop — create, edit, and delete content in-game
• MANAGEMENT: Player management + Events (Double XP, season lifecycle)

Season Shop

• 4 daily rotating shop slots with token-based purchases
• Premium players get extra shop slots (2 slots, configurable)
• “SOLD” badge on purchased items with visual tint
• Header shows token balance and countdown to next rotation
• Shop purchases display chat feedback messages

HUD Tracker

• Compact on-screen display showing current tier, XP progress, and active challenges
• MHUD-compatible with configurable position
• Auto-hides when the map is open
• Toggleable via player settings

Prestige System

• Repeatable prestige after reaching max tier
• Permanent XP boost per prestige level (up to 10 levels)
• Prestige badge displayed in the Tiers tab
• Admin management via /spadmin setprestige

XP Boosters

• Personal XP boosters with configurable multiplier and duration
• Grantable via admin command or as tier/shop rewards
• New booster reward type for tier and shop configurations
• Double XP Events — Server-wide XP multiplier via /spadmin doublexp

Season Pass Book

• Physical in-game item (Spellbook model, Rare quality) that opens the Season Pass UI on right-click
• Configurable auto-give on first join or every join
• Customizable hotbar slot and give delay
• Duplicate protection via inventory check
• Only given when a season is active

Season Pass UI

4 tabs accessible via the book or command:

Tab	Description
Tiers	Visual tier progression with free/premium rewards and claim buttons
Challenges	Active daily and weekly challenges with progress bars
Shop	Token shop with rotating inventory
History	Past season summaries and statistics

Player Settings

• HUD tracker toggle
• XP notification toggle
• Tier-up notification toggle
• Challenge completion notification toggle

Daily XP Cap

• Configurable soft cap (warning) and hard cap (stop earning)
• Prevents excessive XP farming while keeping the game fair
• Login streak tracking with first login bonus

---

Commands

Command	Alias	Description
/ksseasonpass	sp, seasonpass, battlepass	Open the Season Pass UI
/ksseasonpassadmin	spadmin	Admin commands (grant, reset, manage seasons)

Admin Subcommands

• spadmin grantbooster <player> <multiplier> <minutes> — Give a personal XP booster
• spadmin doublexp <minutes> — Start a server-wide double XP event
• spadmin stopdoublexp — End the current double XP event
• spadmin setprestige <player> <level> — Set a player’s prestige level

---

Requirements

• Hytale Server with plugin support
• KyuubiSoft Core (for TrackingService, RewardGrantHelper, CurrencyProvider, ShopService, ModMenuRegistry)

---

Configuration

• config.json — Season settings (duration, XP scaling, caps, premium options)
• seasons/ — Season definitions with tier rewards
• Localization: 9 languages bundled (en-US, de-DE, fr-FR, es-ES, pt-BR, ru-RU, pl-PL, tr-TR, it-IT)

---

Documentation

• Getting Started — Installation and first steps
• Configuration — Main config reference
• Seasons — Season definitions, XP system, prestige
• Rewards — Reward types and examples
• Challenges — Challenge system details
• Token Shop — Shop items and daily rotation
• UI & HUD — Season Pass UI pages and HUD tracker
• Commands — Full command reference
• Permissions — Permission nodes
• Admin Panel — In-game admin panel guide (11 tabs)
• API Reference — Public API for mod integration
• Localization — Translation system and i18n keys
• FAQ & Troubleshooting — Common questions and solutions
• Changelog — Version history