Skip to content
KyuubiSoft Wiki
News & Patchnotes

Getting Started

Getting Started

Section titled “Getting Started”

This guide walks you through installing and configuring the Season Pass system.

Installation

Section titled “Installation”

Step 1: Prerequisites

Section titled “Step 1: Prerequisites”

Make sure you have the Core mod installed:

your-server/
├── mods/
│   └── KyuubiSoftCore-X.X.X.jar    ← Required dependency

Step 2: Install

Section titled “Step 2: Install”

Download and place the Season Pass JAR in your server’s mods/ directory:

your-server/
├── mods/
│   ├── KyuubiSoftCore-X.X.X.jar
│   └── KyuubiSoftSeasonPass-X.X.X.jar    ← Place here

Step 3: Start Server

Section titled “Step 3: Start Server”

Start or restart your Hytale server. The plugin will automatically generate the config folder:

configs/kyuubisoft_seasonpass/
├── config.json              # Main configuration
├── seasons/
│   └── season_1.json        # Default season definition
├── localization/
│   ├── en-US.json
│   ├── de-DE.json
│   └── ... (9 languages total)
└── players/                 # Created when players join

Step 4: Verify Installation

Section titled “Step 4: Verify Installation”

Check the server console for:

[KyuubiSoft SeasonPass] Season Pass system loaded
[KyuubiSoft SeasonPass] Loaded language: en-US
[KyuubiSoft SeasonPass] Loaded 1 season definition(s)

First Steps

Section titled “First Steps”

Open the Season Pass UI

Section titled “Open the Season Pass UI”

As a player, type /sp (or /ksseasonpass) to open the Season Pass book:

  • Tiers Tab — View your progression through the tier tracks
  • Challenges Tab — See your daily and weekly challenges
  • Shop Tab — Browse the daily token shop
  • History Tab — View past season summaries

Start a Season

Section titled “Start a Season”

By default, no season is active. An admin must start one:

Terminal window
# Start the default season
/spadmin start season_1


# Check season status
/spadmin info

:::info No Season = No Progress Players cannot earn XP, complete challenges, or access the shop until a season is started. The Season Pass Book item is also only given when a season is active. :::

Quick Admin Test

Section titled “Quick Admin Test”
Terminal window
# Start a season
/spadmin start season_1


# Grant yourself some XP
/spadmin grantxp YourName 5000


# Grant premium pass
/spadmin grantpremium YourName


# Check player status
/sp info

Quick Configuration

Section titled “Quick Configuration”

The most important settings in config.json:

{
  "language": "en-US",
  "enabled": true,
  "trackerHudEnabled": true,
  "autoSaveIntervalSeconds": 300,
  "item": {
    "enabled": true,
    "giveOnFirstJoin": true,
    "hotbarSlot": 8
  }
}
SettingDescription
languageLanguage file to use (en-US, de-DE)
enabledEnable/disable the entire mod
trackerHudEnabledShow HUD tracker globally
item.enabledEnable Season Pass Book item
item.giveOnFirstJoinAuto-give book on first join

See Configuration for all options.

Season Customization

Section titled “Season Customization”

Edit seasons/season_1.json to customize:

  • Tier rewards (items, commands, lootbags, tokens)
  • XP sources and amounts
  • Challenge definitions
  • Shop items and costs
  • Premium pass settings

Then reload in-game:

Terminal window
/spadmin reload

See Seasons for the full season definition reference.

Next Steps

Section titled “Next Steps”