# Localization

**Version:** 2.0.7 · **Localization version:** 23

Season Pass ships 9 languages with 917 keys each: English (`en-US`), German (`de-DE`), French (`fr-FR`), Spanish (`es-ES`), Portuguese (Brazil, `pt-BR`), Russian (`ru-RU`), Polish (`pl-PL`), Turkish (`tr-TR`) and Italian (`it-IT`). Version 16 added the texts of the new book, its windows, the HUD (`seasonpass.book.*`) and the admin panel (`seasonpass.ap.*`) in all 9 languages; version 17 added the season-end delivery notes (`seasonpass.season_end.*`) and `seasonpass.cmd.disabled`; version 18 reworded the admin hint for missing XP sources; version 20 (2.0.1 and 2.0.2) added the reward queue message and the texts of the KS settings page; version 21 (2.0.3) added the hints for locked command rewards; version 23 (2.0.4) rewrote about 650 Russian texts in proper Cyrillic, brought back the special letters of the other languages (for example German umlauts and ß, Polish and Turkish letters), translated English leftovers in the admin texts and shortened texts that did not fit their box. No key was added or removed.

## Files

```
mods/kyuubisoft_seasonpass/localization/
  en-US.json
  de-DE.json
  ...
  en-US.json.backup-v16      created when a newer version replaced the file
```

Each file is a flat JSON object of `"key": "text"` plus `"_localization_version": "23"`. Placeholders are `{0}`, `{1}`, ...

## Which language a player sees

| Text | Language |
|------|----------|
| The book, its windows, the HUD, the admin panel, replies to `/sp` | The player's language: the choice made with `/kslang` or in the KS settings window (if the server lets players choose), otherwise the server's default player language, otherwise the game client's language, otherwise `en-US` |
| Replies to `/spadmin`, and chat messages that are not a reply to the player's own click (XP gains, tier ups and challenge messages from play, booster and event broadcasts, season end warnings) | The server language (`language` in `config.json`) |

A key missing in the chosen language falls back to `en-US`; a key missing there shows the key itself. Item names in rewards come from the game and follow the client language.

`/kslang` is shared by all KyuubiSoft mods: `/kslang` alone answers in chat with your current language, the available codes and how to change it, `/kslang de-DE` sets a language, `/kslang auto` goes back to the client language. The language row in the book's settings window opens the language page of the KS settings window (`/kssettings`), which sets the same choice, see [UI & HUD](./ui#settings-window). The server's default player language and the "players may choose" switch are set in the Language tab of KyuubiSoft Core's `/ksadmin` hub and apply to every KyuubiSoft mod.

Dates in the History tab use the format of the language (`seasonpass.book.date_format`, `MM/dd/yyyy` in English), numbers are grouped the way the language writes them.

## Updates and your edits

On every start (and on every reload) the plugin compares each bundled language with the file on disk:

1. A missing file is written from the jar.
2. A file with an older `_localization_version` is copied to `<lang>.json.backup-v<old version>` and replaced by the new file from the jar.
3. A file with the current version is left alone, so your edits stay.

When an update replaces a file you edited, your old texts are in the backup; copy them back into the new file.

## Changing texts

1. Edit `localization/<lang>.json` (keep the keys and the `{0}` placeholders).
2. Run `/spadmin reload` (or the admin panel's **Reload**).

## Adding a language

Copy `en-US.json` to a new file named after the language code (for example `nl-NL.json`), translate the values and reload. Every `<code>.json` in the folder is loaded (files starting with `custom_` or containing `.backup` or `.example` are ignored). The language is used for players whose `/kslang` or client language has that code; set `language` in `config.json` to make it the server language too. A new file is never overwritten by updates, because no bundled file has its name.

## Key groups

| Prefix | Keys | Used for |
|--------|------|----------|
| `seasonpass.book.*` | 174 | The book, the premium, settings and prestige windows, the HUD and its toasts |
| `seasonpass.ap.*` | 278 | The admin panel |
| `seasonpass.admin.*` | 291 | Admin command replies, admin panel status messages, dropdown labels |
| `seasonpass.cmd.*` | 14 | Player command replies (`/sp info`, `/sp buy`, "The Season Pass is currently disabled.") |
| `seasonpass.season_end.*` | 2 | Chat notes about season-end rewards delivered or waiting for inventory space |
| `seasonpass.rewards.*` | 1 | Chat note when rewards could not be handed out and wait in the reward queue |
| `seasonpass.tier.*`, `seasonpass.challenge.*`, `seasonpass.shop.*`, `seasonpass.toast.*` | | Chat messages for tier ups, finished challenges, purchases and XP gains |
| `seasonpass.booster.*`, `seasonpass.event.*`, `seasonpass.prestige.*` | | Booster, XP event and prestige messages |
| `seasonpass.error.*` | 6 | Error messages |
| `seasonpass.ui.*`, `seasonpass.settings.*`, `seasonpass.hud.*`, `seasonpass.xp.*`, `seasonpass.season.*`, ... | | Texts of the old windows before 2.0.0; most are no longer shown |

### Selected keys (en-US)

| Key | Text |
|-----|------|
| `seasonpass.cmd.season_info` | Season: {0} \| Tier: {1}/{2} \| XP: {3}/{4} \| Tokens: {5} |
| `seasonpass.cmd.premium_purchased` | Premium Pass purchased! All reached premium rewards are now available. |
| `seasonpass.cmd.premium_insufficient` | Not enough currency! Cost: {0} {1} |
| `seasonpass.cmd.premium_no_currency` | Currency '{0}' not found. Check your season config. |
| `seasonpass.tier.tier_up` | Tier Up! You reached Tier {0}! |
| `seasonpass.challenge.complete` | Challenge complete! +{0} XP, +{1} Tokens |
| `seasonpass.toast.xp_gained` | +{0} Season XP |
| `seasonpass.toast.tokens_gained` | +{0} Tokens |
| `seasonpass.shop.purchased` | Purchased '{0}'! |
| `seasonpass.shop.not_enough_tokens` | Not enough tokens! You have {0}, need {1}. |
| `seasonpass.booster.activated` | XP Booster activated! {0}x for {1} minutes. |
| `seasonpass.event.started` | DOUBLE XP EVENT! {0}x XP for {1} minutes! |
| `seasonpass.ui.season_ends_in` | Season ends in {0} days |
| `seasonpass.book.status_inventory_full` | Inventory full - make room first |
| `seasonpass.book.contact_admin` | Ask the server team about the premium pass. |
| `seasonpass.book.hud_tier_up_hint` | Claim it in the Season Pass (/sp) |

The chat messages above always say "Tokens", whatever `currencyName` is; change them in the language files if your currency has another name. The book and the HUD use `currencyName`.