# Commands

**Version:** 2.0.7

| Command | Aliases | Used by | Permission |
|---------|---------|---------|------------|
| `/ksseasonpass` | `sp`, `seasonpass`, `battlepass` | players | `ks.seasonpass.user.use` (allowed by default) |
| `/ksseasonpassadmin` | `spadmin` | players and console | `ks.seasonpass.admin`, see [Permissions](./permissions) |
| `/kslang` | none | players | none; registered by the first KyuubiSoft mod that loads |

Both Season Pass commands are command groups: run without a subcommand they only print their list of subcommands. Details on the windows are on [UI & HUD](./ui) and [Admin Panel](./admin-panel).

---

## Player commands

| Usage | What it does |
|-------|--------------|
| `/sp open` | Opens the Season Pass book |
| `/sp info` | Prints your season status in chat |
| `/sp buy` | Buys the premium pass |

All three only work for players. Without `ks.seasonpass.user.use` they answer "No permission.". With `enabled: false` in `config.json` they answer "The Season Pass is currently disabled."

### `/sp open`

Opens the [Season Pass book](./ui#the-book) on the Tiers tab. The same window opens from the Season Pass item and from a Core citizen with the ID `showcase_seasonpassplayer`. Without a running season it answers "No season is currently active."

### `/sp info`

```
Season: Season 1: Explorer | Tier: 12/40 | XP: 2340/2518 | Tokens: 87
PREMIUM
Season ends in 18 days
```

- XP is the XP inside the current tier and the XP needed for the next one.
- "Tokens" are the internal season tokens, also when the season uses an item or economy currency.
- "PREMIUM" only appears with the pass, the last line only when the season has an end date.

### `/sp buy`

Buys the premium pass for `premiumCost` in the currency `premiumCurrencyId` of the season. It does exactly the same as the **Unlock** button of the premium window.

| Answer | When |
|--------|------|
| "Premium Pass purchased! All reached premium rewards are now available." | Paid. Premium rewards of reached tiers are now claimable in the book |
| "You already have the Premium Pass!" | You own it |
| "The Premium Pass is not available for this season." | `premiumEnabled` is `false` |
| "The Premium Pass can only be granted by an admin." | `premiumCommandOnly` is `true` |
| "Currency 'gold' not found. Check your season config." | `premiumCurrencyId` is not a known currency (for example `gold` in season files from before 2.0.0) |
| "Not enough currency! Cost: 1000 Gold" | Balance too low |
| "Shop service not available." | KyuubiSoft Core's shop system is not running |

---

## Admin commands

All subcommands need the admin permissions (see [Permissions](./permissions)) and work from the console as well, except `panel`. Commands that target a player only find **online** players ("Player 'Steve' not found."). On a Core showcase server every subcommand except `panel` is refused for players (the panel opens, but blocks every change).

| Usage | What it does |
|-------|--------------|
| `/spadmin panel` | Opens the admin panel |
| `/spadmin start <seasonId>` | Starts a season |
| `/spadmin end` | Ends the running season |
| `/spadmin pause` | Pauses the running season |
| `/spadmin resume` | Resumes it |
| `/spadmin reload` | Reloads config, seasons and languages |
| `/spadmin info` | Shows the season status |
| `/spadmin grantxp <player> <amount>` | Gives XP |
| `/spadmin setxp <player> <amount>` | Sets XP |
| `/spadmin granttokens <player> <amount>` | Gives internal season tokens |
| `/spadmin grantpremium <player>` | Gives the premium pass |
| `/spadmin revokepremium <player>` | Takes the premium pass away |
| `/spadmin settier <player> <tier>` | Sets the tier |
| `/spadmin resetplayer <player>` | Resets the player's season |
| `/spadmin grantbooster <player> <multiplier> <minutes>` | Gives a personal XP booster |
| `/spadmin doublexp <minutes> [multiplier]` | Starts a server-wide XP event |
| `/spadmin stopdoublexp` | Ends the XP event |
| `/spadmin setprestige <player> <level>` | Sets the prestige level |
| `/spadmin credits` | From 2.0.8: lists unclear economy payouts |
| `/spadmin creditpaid <id>` | From 2.0.8: marks an unclear payout as booked and removes it |
| `/spadmin creditunpaid <id>` | From 2.0.8: marks an unclear payout as not booked; it is booked at the next join |

### `/spadmin panel`

Opens the [admin panel](./admin-panel) (players only).

### `/spadmin start <seasonId>`

```
/spadmin start season_1
```

Starts the season with that ID and sets up its currency. Refused with "A season is already active: season_1" while one runs, and "Season 'season_9' not found." for an unknown ID. Online players who still hold another season's data get that season's end payout, have it moved to their history and start at tier 0. Everyone online gets "Season 'Season 1: Explorer' started!". See [Seasons](./seasons#lifecycle).

### `/spadmin end`

Ends the running season ("Season ended. All online players' data archived."). Online players get their open rewards automatically and their season is moved to the history. Items, lootbags and commands that do not fit wait until there is room; players who are offline get their payout on their first join after the next season has started. See [Seasons](./seasons#season-end-payout).

### `/spadmin pause` / `resume`

While paused, nobody earns XP or challenge progress, there are no login rewards, no challenge rotation and no automatic end, and the HUD is hidden. The book, claims and the shop keep working. `resume` rolls challenges that became due during the pause.

### `/spadmin reload`

Reloads `config.json`, every season file and every language file and sets up the currency of the active season again: "Config reloaded. 1 seasons loaded." The log lists unknown premium currencies and lootbag IDs of the seasons.

### `/spadmin info`

```
Season: season_1 | Status: Active | Players: 5
```

Status is "Active" or "Paused" ("Paused" also while `enabled` is `false` in `config.json`); Players is the number of players online. Without a season: "No season is currently active."

### `/spadmin grantxp <player> <amount>`

```
/spadmin grantxp Steve 5000
```

Grants XP the normal way: premium, prestige, booster and event multipliers **and** the daily caps apply, tokens are earned and tiers rise. Nothing is granted while the season is paused. The answer shows the base amount: "Granted 5000 XP to Steve. New total: 7340".

### `/spadmin setxp <player> <amount>`

Sets both the XP inside the current tier and the total season XP to `<amount>`, then raises the tier if the amount is enough for the next tier(s). It does not lower the tier.

### `/spadmin granttokens <player> <amount>`

Adds internal season tokens ("Granted 50 tokens to Steve. New balance: 137"). With the season currency `item` or `economy` these tokens are not the shop currency.

### `/spadmin grantpremium <player>` / `revokepremium <player>`

Gives or takes the premium pass for free. Granting makes the premium rewards of reached tiers claimable (they are not handed out automatically). Revoking keeps everything already claimed; premium challenges stop counting.

### `/spadmin settier <player> <tier>`

Sets the tier directly. The XP inside the tier is not changed, and the value is not checked against the number of tiers.

### `/spadmin resetplayer <player>`

Moves the player's current season to their history and resets tier, XP, tokens, premium, claims, challenges, prestige and booster. It cannot be undone. The player gets no new challenges until the next daily / weekly reset (use **New daily challenges** in the admin panel's **Events** section).

### `/spadmin grantbooster <player> <multiplier> <minutes>`

```
/spadmin grantbooster Steve 2.0 60
```

Starts a personal booster and replaces a running one. The player sees "XP Booster activated! 2.0x for 60 minutes." A multiplier of 1.0 or less has no effect.

### `/spadmin doublexp <minutes> [multiplier]`

```
/spadmin doublexp 120          (x2 for 2 hours)
/spadmin doublexp 60 3.0       (x3 for 1 hour)
```

Starts a server-wide XP event for everyone (default multiplier 2.0) and replaces a running one. All online players get "DOUBLE XP EVENT! 2.0x XP for 120 minutes!" and, five minutes before the end, a warning. The event survives server restarts. A multiplier of 1.0 or less has no effect.

### `/spadmin stopdoublexp`

Ends the event at once ("The Double XP Event has ended." to everyone), or answers "No global XP event is currently active."

### `/spadmin setprestige <player> <level>`

Sets the prestige level (and with it the prestige XP bonus) directly. It grants no prestige rewards, does not reset the tier and does not check `prestigeEnabled` or `maxPrestigeLevel`.

### Unclear economy payouts (from 2.0.8)

:::caution[Not released yet]
These commands come with Season Pass 2.0.8, which is not released yet and has not been tested in game.
:::

In the `economy` currency mode, a payout whose booking broke off halfway (the economy failed during it) is never tried again automatically, so nobody is paid twice. The admin decides each one after checking the player's balance (see [Economy payouts](./configuration#economy-payouts-from-208)).

| Usage | What it does |
|-------|--------------|
| `/spadmin credits` | Lists the unclear payouts: "Unclear economy credits: N · check the balance, then mark each one", then one line per payout with the first 8 characters of its id, the player, the amount and the time. Without any: "No unclear economy credits." |
| `/spadmin creditpaid <id>` | It was booked: the entry is removed ("Credit … marked as booked and removed.") |
| `/spadmin creditunpaid <id>` | It was not booked: the entry waits again and is booked at the player's next join or with their next payout; if the player is online, at once |

- `<id>` is the id or its start, at least 4 characters. When more than one unclear payout starts with it, nothing changes ("type more of the id").
- Each payout can only be decided once. If the decision cannot be saved, nothing changes.
- The log records every decision with the admin's name. Players who are offline appear with their UUID in the list.

:::note[HUD after admin commands]
Changes made with these commands show up in the player's HUD within 30 seconds. Changes made in the admin panel show up at once.
:::

---

## `/kslang`

The language command shared by all KyuubiSoft mods. `/kslang` alone answers in chat with your current language, the available language codes and how to change it. `/kslang <code>` (e.g. `/kslang de-DE`) sets your language, `/kslang auto` goes back to the game language. Season Pass texts follow this choice. 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 [Localization](./localization).