Skip to main content

Configuration

The main configuration file is located at configs/kyuubisoft_seasonpass/config.json.

Config Reference

General Settings

FieldTypeDefaultDescription
languagestring"en-US"Active language file (en-US, de-DE)
debugbooleanfalseEnable debug logging
enabledbooleantrueEnable/disable the mod
timezonestring"UTC"Timezone for daily/weekly resets
autoSaveIntervalSecondsint300Auto-save interval in seconds
trackerHudEnabledbooleantrueEnable HUD tracker globally
activeSeasonIdstringnullCurrently active season ID (set via admin command)
seasonPausedbooleanfalseWhether the current season is paused

Item Config

The item section controls the Season Pass Book item:

FieldTypeDefaultDescription
item.enabledbooleantrueEnable the Season Pass Book item
item.itemIdstring"SeasonPass"Item ID for the book
item.giveOnFirstJoinbooleantrueGive book on first join (if not in inventory)
item.giveOnEveryJoinbooleanfalseRe-give book on every join
item.hotbarSlotint8Hotbar slot to place the book (0-8)
item.giveDelaySecondsint3Delay before giving item (allows world load)
giveOnFirstJoin vs giveOnEveryJoin
  • giveOnFirstJoin: Gives the book once if the player doesn't have it. If a player drops/destroys it, they won't get a new one until next login.
  • giveOnEveryJoin: Always gives the book on login, even if the player already has one. Useful if players frequently lose items.

Full Example

{
"language": "en-US",
"debug": false,
"enabled": true,
"timezone": "UTC",
"autoSaveIntervalSeconds": 300,
"trackerHudEnabled": true,
"activeSeasonId": null,
"seasonPaused": false,
"item": {
"enabled": true,
"itemId": "SeasonPass",
"giveOnFirstJoin": true,
"giveOnEveryJoin": false,
"hotbarSlot": 8,
"giveDelaySeconds": 3
}
}

Folder Structure

configs/kyuubisoft_seasonpass/
├── config.json # This file
├── seasons/ # Season definitions (one per file)
│ └── season_1.json
├── localization/
│ ├── en-US.json # English (default)
│ └── de-DE.json # German
└── players/ # Player data (file mode only)
└── {uuid}.json
MySQL Support

When MySQL is configured in the Core mod, player data is stored in the ks_seasonpass_players table instead of the players/ folder. Existing file-based data is automatically migrated on first load.

Reload

Reload the configuration in-game without restart:

/spadmin reload

This reloads config.json, all season definitions, and localization files.