# Commands

**Version:** 2.6.6

All bank commands are subcommands of `/ksbank` (alias `/banker`). `/ksbank` on its own only prints the list of subcommands.

| Command | Used by | Permission |
|---------|---------|------------|
| `/ksbank open` | players | `ks.bank.user.open` (allowed by default) |
| `/ksbank page <page>` | players | `ks.bank.user.page` (allowed by default) |
| `/ksbank upgrade` | players | `ks.bank.user.upgrade` (allowed by default) |
| `/ksbank history` | players | `ks.bank.user.history` (allowed by default) |
| `/ksbank open --player=<name>` | admins (players only) | `ks.bank.user.open` and `ks.bank.admin` |
| `/ksbank admin` | admins (players only) | `ks.bank.admin` |
| `/ksbank give <player> <item> [--amount=<n>]` | admins, console | `ks.bank.admin` |
| `/ksbank adminupgrade <player> [--pages=<n>]` | admins, console | `ks.bank.admin` |
| `/ksbank reset <player>` | admins, console | `ks.bank.admin` |
| `/ksbank log <player>` | admins, console | `ks.bank.admin` |
| `/ksbank reload` | admins, console | `ks.bank.admin` |
| `/kslang` | players | none (shared by all KyuubiSoft mods) |

Admin commands need `ks.bank.admin`; the console needs no node. The old `bank.admin` is no longer used. All commands work without KyuubiSoft Core. Details on [Permissions](./permissions).

:::note[From 2.7.0 (not released yet): Kronen commands]
When the bank carries the server currency [Kronen](https://wiki.kyuubisoft.com/hytale/core/kronen/) (KyuubiSoft Core is not installed, or an older Core without Kronen), the bank also registers its commands. With Core 2.10.0 Core registers them instead; they work the same way.

| Command | Used by | Permission |
|---------|---------|------------|
| `/kskronen` | players (console: state) | `ks.kronen.user.balance` (allowed by default) |
| `/kskronen pay <person> <amount> [reason]` | players | `ks.kronen.user.pay` (allowed by default) |
| `/kskronen history` | players | `ks.kronen.user.balance` (allowed by default) |
| `/kskronenadmin` | admins (players only) | `ks.kronen.admin` |

Syntax, answers and the admin window are described on [Kronen](https://wiki.kyuubisoft.com/hytale/core/kronen/#commands).
:::

:::note[Optional arguments]
Hytale passes optional arguments by name: `--amount=64` or `--amount 64`. A plain extra word such as `/ksbank give Steve Ore_Gold 64` is not read as the amount.
:::

---

## Player commands

### `/ksbank open`

Opens your own bank window, on page 1 in the Pages view. Same as using a bank NPC. With world banking on, the bank of the world group you are in opens.

### `/ksbank page <page>`

Opens your bank on a page.

| Argument | Type | Required | Description |
|----------|------|----------|-------------|
| `page` | Integer | yes | Page number, starting at 1. A number above your page count opens your last page. `0` or less answers "Invalid page number!" |

```
/ksbank page 3
```

The page number only matters in the Pages view; the Scroll view always shows every page.

### `/ksbank upgrade`

Buys your next page, like **Buy** in the Pages tab, with two differences:

- It always uses the default price list (`upgrade.defaultCosts`) and the default economy, never a provider-specific price list.
- It always upgrades your normal bank, also when world banking is on and you stand in a world group.

Possible answers in chat:

| Answer | When |
|--------|------|
| "New bank page unlocked! (Page N)" | The page was bought (or was free, see below) |
| "Maximum bank size reached!" | You own as many pages as you may buy, or the next page has no price |
| "Not enough funds! Need: 250 Gold" | Your balance is lower than the price |
| "Transaction failed!" | The economy refused the payment |
| "Bank pages cannot be bought on this server." | `upgrade.enabled` is `false` |
| The `lockedMessage` of `permissions.upgrade`, or "You are not allowed to buy bank pages." | `permissions.upgrade` names a node you do not have |

Without an economy, or when the price is `0`, the page is unlocked for free.

### `/ksbank history`

Prints your 20 newest bank history entries in chat (fewer when `historyMaxEntries` is set lower than 20):

```
=== Bank History ===
19.10 14:32 | DEPOSIT Ingredient_Bar_Gold x12
19.10 14:30 | WITHDRAW Weapon_Sword_Iron x1
```

Deposits are green, withdrawals and transfers red. The bank window's History tab shows the full list with search and filters, see [UI Pages](./ui-pages#history-tab).

### `/kslang`

The language choice shared by all KyuubiSoft mods. `/kslang` without an argument answers in chat with your current language (chosen by you or taken from your game), the available language codes and how to change it. `/kslang <code>` (for example `/kslang de-DE`) sets a language, `/kslang auto` goes back to the client language. The command is registered by the first KyuubiSoft mod that loads (Core on most servers).

---

## Admin commands

### Choosing the player

Every admin command takes a player as a name or a UUID:

- **Name:** only players who are online (their bank is loaded) are found. Upper and lower case do not matter.
- **UUID:** works for offline players too; their bank file is read from disk.

If nobody is found the command answers that the player was not found.

With world banking on, a name can find a world group bank the player has loaded instead of their normal bank. A UUID always targets the normal bank.

### `/ksbank open --player=<name>`

Opens another player's bank for you.

```
/ksbank open --player=Steve
/ksbank open --player=550e8400-e29b-41d4-a716-446655440000
```

- The vault is the player's, the inventory below it is **yours**: you can move items between the two.
- The Account tab is hidden. Buying pages and switching the view answer "Only possible in your own bank"; sort changes are not saved for the owner.
- If the player has their bank open, you get "Bank is already open!". If the player opens their bank while you look at it, your view is saved and stops working.

This variant needs `ks.bank.user.open` and `ks.bank.admin`; without the admin node it answers "No permission!".

### `/ksbank admin`

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

### `/ksbank give <player> <item> [--amount=<n>]`

Puts an item into a player's bank.

| Argument | Type | Required | Description |
|----------|------|----------|-------------|
| `player` | String | yes | Name of an online player or a UUID |
| `item` | String | yes | Item ID, for example `Ingredient_Bar_Gold` |
| `--amount` | Integer | no | Stack size, default `1` |

```
/ksbank give Steve Weapon_Sword_Iron
/ksbank give Steve Ingredient_Bar_Gold --amount=64
```

The item goes into the first **empty** slot of the player's pages (it is not added to an existing stack); a page that cannot be read is skipped. Answer: "Item added: Ingredient_Bar_Gold x64 for Steve". A full bank answers "Bank full or item could not be added!". The command is not written to the history.

### `/ksbank adminupgrade <player> [--pages=<n>]`

Adds pages to a player's bank for free.

| Argument | Type | Required | Description |
|----------|------|----------|-------------|
| `player` | String | yes | Name of an online player or a UUID |
| `--pages` | Integer | no | Pages to add, default `1` |

```
/ksbank adminupgrade Steve
/ksbank adminupgrade Steve --pages=3
```

The result is capped at `maxPages` (rank pages do not raise this limit). Answer: "Bank of Steve expanded to 3 pages." At the limit the command answers "Maximum page count already reached!".

### `/ksbank reset <player>`

Empties all pages of a player's bank and sets the page count back to `defaultPages`.

```
/ksbank reset Steve
```

Answer: "Bank of Steve has been reset." The history in `bank.db` is kept.

:::danger
A reset cannot be undone. The previous file stays as `<uuid>.json.bak` only until the next save of that bank.
:::

### `/ksbank log <player>`

Prints the 30 newest history entries of a player with date and time to the second:

```
=== Bank Log: Steve ===
19.10.26 14:32:07 | DEPOSIT Ingredient_Bar_Gold x12
```

### `/ksbank reload`

Reloads `config.json` without a restart: all values, the restriction list and the auto-detected EcotaleCoins. Language files are not reloaded. Answer: "Bank config reloaded." When `config.json` cannot be read, the answer is "Error loading config: ..." with the reason; the bank keeps its current settings and the file is not changed (see [Configuration](./configuration#validation)).

---

:::note[Changes while the bank is open]
`give`, `adminupgrade`, `reset` and the reset and page buttons of the admin panel first save and close the player's open bank window, then apply the change, so the window cannot write its old contents back over it. The player sees their bank window close.
:::