# Admin Panel

**Version:** 2.6.6 · **Permission:** `ks.bank.admin`

The admin panel changes the bank configuration and manages player banks in game. Every saved change is written to `config.json` or to the player's bank file at once and applies without a restart. The panel's texts follow the admin's language.

```
/ksbank admin
```

With KyuubiSoft Core 2.8.0 or newer installed, the panel is also a tile in Core's `/ksadmin` hub ("KyuubiSoft Management", which itself needs `ks.admin`). The tile opens the panel with `ks.bank.admin`; showcase visitors get it read-only, like the showcase bank admin NPC below.

![The admin panel on the General section](../../../../assets/bank/bank-admin.png)
*The admin panel on the General section, with the navigation on the left.*

---

## Layout

- **Header:** "Bank Admin", the subtitle "Configuration and player banks · admins only", **Reload** and **X**.
- **Navigation (left):** under **Config** the sections General, Economy, Ranks, Coins and Restrict; under **Management** Players, History and Worlds. Ranks, Coins, Restrict and Worlds show how many entries they have.
- **Content panel (right):** the selected section. Lists with more rows than fit get a pager (`<` "1 / 3" `>`).
- **Status line** at the bottom of the panel: green for success, red for errors. It is cleared when you change the section.
- **Reload** does the same as `/ksbank reload`: it reads `config.json` again and drops toggle changes you have not saved yet.
- **Crowns** (from 2.7.0, not released yet): a button in the header while the bank carries the server currency [Kronen](https://wiki.kyuubisoft.com/hytale/core/kronen/), also while Kronen is still off, because it is switched on in that window. It opens the Kronen admin window (needs `ks.kronen.admin`). With KyuubiSoft Core 2.10.0 the button is hidden; the **Crowns** tile in the `/ksadmin` hub opens the same window.

Switches (**Active** / **Off**) are toggle buttons. In General and Economy a switch only takes effect when you press that section's save button; the World Banking switch applies at once.

Every action that changes something (saves, adds and deletes, **Open Bank**, page changes, resets, **Reload**, world groups) checks `ks.bank.admin` again before it runs. Browsing the sections and searching do not.

---

## General

Base values for all player banks.

| Field | Meaning |
|-------|---------|
| **Default Pages** | `defaultPages`: pages of a new bank (`0` = no page) |
| **Max Pages** | `maxPages` |
| **Slots per Page** | `slotsPerPage`. Saved pages are fitted the next time a bank opens; no items are lost, see [Configuration](./configuration#slotsperpage) |
| **Upgrades Enabled** | `upgrade.enabled`. **Off** = players cannot buy pages ("Bank pages cannot be bought on this server."); **+ Add Page** and `/ksbank adminupgrade` still work |
| **Economy Provider** | Read only: the economy Core found, or "Not available". From 2.7.0, while Kronen is the money: "KyuubiSoft Kronen (carried by core)" or "(carried by bank)" |

**Save Changes** stores the three numbers and the switch. A value that is not a whole number answers "Invalid number format!". Invalid numbers are corrected like on load (for example **Max Pages** below **Default Pages** becomes **Default Pages**).

---

## Economy

Page prices and the shop info button.

**Page Upgrade Costs**

| Field | Meaning |
|-------|---------|
| **Default Costs** | `upgrade.defaultCosts`, comma-separated: `0,250,500,1000,2500` (price of page 1, 2, 3, ...) |
| **Currency Name** | `upgrade.defaultCurrencyName`, for example `Gold`. From 2.7.0 empty by default ("empty = automatic": the name of the server currency or of the economy) |

**Provider-Specific Costs** lists `upgrade.providerCosts`, three per page: provider name, display name (when it differs) and the prices ("0 · 500 · 1000").

- **Add a provider:** fill in **Provider name**, **Display name** (optional, for example "Ecotale Coins"; players see it as the currency word under the balance and in the prices) and the comma-separated prices, then press **Add**. The provider name must match the economy provider. Adding a name that already exists overwrites it.
- **Edit** copies a provider into the three fields; change them and press **Add** to store the new values.
- **Del** removes the provider and its display name.

Providers are saved as soon as you press **Add** or **Del**. The hint text above the list ("Format: ProviderName=cost1,cost2,cost3 (one per line)") is left over from the old panel; use the three fields.

**Shop Info Button**

| Field | Meaning |
|-------|---------|
| **Show Info Button** | `shopInfo.enabled` |
| **Button Text** | `shopInfo.buttonText` |
| **Chat Message** | `shopInfo.chatMessage` |
| **Link URL** | `shopInfo.link` |

**Save Costs** stores the default costs, the currency name and the shop info fields. A price that is not a whole number answers with an error and nothing is saved.

---

## Ranks

Rank-based page limits (`permissions.rankPages`): permission node to maximum pages, highest match wins.

- The list shows every node with its page count, sorted by pages (8 per page), each with **Del**. Empty: "No rank pages configured."
- **Add:** type the node (for example `bank.pages.5`) and the pages, then press **Add**. An existing node is overwritten. A page count that is not a number answers "Invalid page number!".
- **Save Ranks** writes the file again; adding and deleting already save.

The nodes are checked through LuckPerms when it is installed, otherwise through Hytale's own permission system, see [Permissions](./permissions#rank-pages).

---

## Coins

Coin items that turn into balance (`coinProviders` and the legacy `coinItems`).

- The line at the top says whether EcotaleCoins were found ("Auto-detected 6 EcotaleCoins", green) or not ("EcotaleCoins not detected").
- The list shows one gold header row per provider and its coins below, sorted by value ("= 1000"), each with **Edit** and **Del**. Legacy `coinItems` appear under **Default**. Ten rows per page; header rows count as rows.
- **Add coin to provider:** pick a provider in the dropdown, or **+ New Provider...** and type its name, then fill in **Item_ID** and **Value** and press **Add**. An existing coin is overwritten.
- **Edit** copies the coin's ID and value into the fields. The dropdown is not changed: pick the coin's provider again before you press **Add**, otherwise the coin is added to the provider shown in the dropdown.
- **Del** removes the coin; a provider without coins is removed with it.
- **Save Coins** writes the file again; adding and deleting already save.

:::caution
The `Ecotale` list is replaced by the coins of EcotaleCoins on every start and reload. Coins you add or change under `Ecotale` do not last; configure them in EcotaleCoins instead.
:::

---

## Restrict

Items that may not be stored (`restrictedItems`).

- The line **Mode** shows `restrictionMode` (blacklist or whitelist). The mode can only be changed in `config.json`.
- The list shows every entry with **Del** (10 per page). Empty: "No restrictions configured."
- **Add:** type an item ID or a pattern with `*` (for example `Quest_*` or `*_Key`) and press **Add**. Upper and lower case do not matter. **Save Restrictions** writes and reloads the list; adding and deleting already save.
- The list applies to every way into the bank: clicks, drag and drop and the game's own container moves. See [Configuration](./configuration#restrictionmode-and-restricteditems).

---

## Players

Look up one player's bank.

1. Type the player's name and press **Search**. Only **online** players are found. "Enter a player name to view their bank data." is shown before the first search.
2. The card shows:

| Field | Meaning |
|-------|---------|
| Name and **UUID** | The player |
| **Unlocked Pages** | Page count |
| **Total Slots** | Occupied slots / all slots, for example "12 / 90" |
| **Items Stored** | Number of occupied slots |
| **World Group** | The world group bank the player has loaded, otherwise "Global" |
| **Sort Mode** | name, rarity, quantity or "Default" (no sorting) |

3. Actions:

| Button | What it does |
|--------|--------------|
| **Open Bank** | Replaces the panel with the player's bank, see [UI Pages](./ui-pages#another-players-bank). When that bank is already open, the panel stays open and the status line says "Bank is already open!" |
| **+ Add Page** | One more page for free, up to `maxPages` ("Already at max pages (5)") |
| **- Remove Page** | One page less, never below 1 ("Cannot remove last page"). The items of the removed page stay in the file but cannot be reached until the page is added again |
| **Reset Bank** | Empties every page and sets the page count to `defaultPages` at once, without a confirmation. The history is kept |

When the player has the bank open, **+ Add Page**, **- Remove Page** and **Reset Bank** first save and close the player's window, then apply the change; the status line reports it afterwards.

:::danger
**Reset Bank** cannot be undone.
:::

---

## History

The history of one player.

1. Type the player's name and press **Search**. Only **online** players are found. Before a search: "Search for a player to view history."
2. The list shows 10 entries per page, newest first: item icon, translated item name, "Deposited" or "Withdrawn" with date and time ("17.10. 14:32") and the amount (`+12` green, `-1` red). Transfers count as "Withdrawn". It lists every entry, also those older than the player's `historyMaxEntries`.

For offline players use `/ksbank log <uuid>`.

---

## Worlds

World banking: one bank per world group (see [Configuration](./configuration#worldbanking)).

- **World Banking Enabled** switches world banking on or off and saves at once.
- **World Groups** lists every group with its world entries (6 per page), each with **Edit** and **Del**. Empty: "No world groups yet."
- **+ Add Group** creates a group named `group_N` with the placeholder world `world_name` and opens it in the editor.
- **Edit World Group:** **Group Name** and **Worlds** (comma-separated parts of world names, for example `arena, battleground`), then **Save** or **Cancel**. Renaming a group does not move its bank files: players start with an empty bank in the renamed group, the old files stay in `worlds/<old name>/`.
- **Del** removes the group. Its bank files stay on disk.

---

## Showcase servers

On a server running KyuubiSoft Core's showcase mode every action that changes something answers "Blocked: Showcase mode" for players who are not real admins. Browsing the sections still works.

A Core citizen with the ID `showcase_bankadmin` opens this panel for players with `ks.bank.admin`, and for other players only while showcase mode keeps it read-only. Everyone else gets a "no permission" message in their own language. **Open Bank** counts as a change, so visitors cannot open other players' banks through it.

For showcase visitors the **Players** and **History** sections show "Player data is hidden" instead of their content, and their searches do not answer. On a normal server nothing changes.

---

## Workflow examples

### Rank-based page limits

1. **Ranks:** add `bank.pages.3` with 3, `bank.pages.5` with 5, `bank.pages.10` with 10.
2. **Economy:** make sure **Default Costs** has a price for every page up to 10, for example `0,250,500,1000,2500,4000,6000,8000,10000,15000`, and press **Save Costs**.
3. Give the nodes to your groups in LuckPerms:
   ```
   /lp group default permission set bank.pages.3 true
   /lp group vip permission set bank.pages.5 true
   /lp group premium permission set bank.pages.10 true
   ```

### A separate price list for one economy

1. **General:** check the **Economy Provider** name.
2. **Economy:** type that name, a display name and the prices, press **Add**.
3. Players now see **Pay with** in the Pages tab.

### A separate bank for the PvP worlds

1. **Worlds:** **+ Add Group**, name it `pvp`, worlds `arena, battleground`, **Save**.
2. Switch **World Banking Enabled** on.
3. Players in a world whose name contains `arena` or `battleground` now get their PvP bank.