Skip to main content

Bank Admin Panel

The Bank Admin Panel is a full in-game configuration interface with 8 tabs. All settings can be edited inline with immediate save — no config file editing required.

Opening the Admin Panel

/ksbank admin

Permission: bank.admin


Panel Layout

The admin panel uses a tabbed sidebar on the left with 8 tabs, and the active tab's content on the right. A status message bar at the bottom shows feedback for actions.


Tabs

General Tab

Configure core bank settings.

FieldTypeDescription
Default PagesText InputNumber of bank pages new players start with (min: 1)
Max PagesText InputMaximum number of bank pages a player can unlock
Slots Per PageText InputNumber of item slots per bank page
Upgrade EnabledCheckboxWhether players can purchase page upgrades with currency
Economy ProviderDisplayShows the detected economy provider name (read-only)

How to edit: Change the value in the text field and press the Save button. Invalid values are auto-corrected (e.g., defaultPages < 1 is set to 1).


Economy Tab

Configure upgrade costs and economy providers.

FieldTypeDescription
Default CostsText InputComma-separated cost array (e.g., 0,250,500,1000,2500). Index 0 = page 1 cost, index 1 = page 2 cost, etc.
Default Currency NameText InputDisplay name for the default currency (e.g., Gold)
Provider CostsList (paginated, 3 per page)Per-provider cost arrays with display names. Shows ProviderName (DisplayName) — [costs]
Shop Info EnabledCheckboxShow the "Want more pages?" button in page overview
Shop Info Button TextText InputLabel on the shop info button
Shop Info MessageText InputChat message sent when the button is clicked
Shop Info LinkText InputClickable URL included in the chat message

Provider management:

  • Add provider: Enter a name in the "New provider name..." field and click Add
  • Edit provider: Click the Edit button next to a provider to load its values into the form fields, modify them, then click Update
  • Delete provider: Click the Delete button next to a provider to remove it

Ranks Tab

Configure rank-based page limits via LuckPerms permissions.

FieldTypeDescription
Rank listList (paginated, 8 per page)Shows permission → pages mappings sorted by page count
PermissionText InputPermission node (e.g., bank.pages.5)
PagesText InputMaximum pages for this permission

Rank management:

  • Add rank: Enter the permission and pages values, then click Add
  • Edit rank: Click a rank entry to load its values, modify, then Update
  • Delete rank: Click the Delete button next to a rank entry

Coins Tab

Configure coin-to-currency conversion definitions.

FieldTypeDescription
Provider dropdownDropdownSelect which economy provider to add coins to
Coin entriesList (paginated, 10 per page)Shows coins grouped by provider with headers
Item IDText InputThe item ID of the coin (e.g., Copper_Coin)
ValueText InputCurrency amount per coin item
Auto-detectedDisplayShows whether EcotaleCoins were auto-detected

Coin management:

  • Add coin: Select provider from dropdown, enter Item ID and Value, click Add
  • Edit coin: Click the Edit button on a coin row to load its values, modify, then Update
  • Delete coin: Click the Delete button to remove a coin definition
  • New provider: Select "+ New Provider..." in the dropdown, enter a provider name

Restrict Tab

Configure item restrictions (blacklist/whitelist).

FieldTypeDescription
ModeDisplayShows current mode (blacklist or whitelist)
Restricted itemsList (paginated, 10 per page)Item ID patterns currently in the restriction list
Item IDText InputItem ID or wildcard pattern (e.g., Quest_Item_*)

Restriction management:

  • Add item: Enter an item ID or pattern and click Add
  • Delete item: Click the Delete button next to an item to remove it
  • Toggle mode: Use the Mode toggle button to switch between blacklist and whitelist

Players Tab

Search and manage individual player bank data.

FieldTypeDescription
SearchText InputEnter a player name to search
Player NameDisplayPlayer's username
UUIDDisplayPlayer's UUID
PagesDisplayNumber of unlocked pages
SlotsDisplayUsed slots / total slots
Item CountDisplayTotal number of items stored
World GroupDisplayCurrent world group (or "Global")
Sort ModeDisplayPlayer's selected sort mode (Default, A-Z, Z-A, Rarity)

Player management:

  • Add Page: Click to grant one additional page to the player (free)
  • Remove Page: Click to remove the last page (items on that page are lost)
  • Open Bank: Click to open and view the player's bank contents (read/write)
  • Reset Bank: Click to reset the player's bank entirely (irreversible)
danger

Resetting a player's bank removes ALL items and resets page count to defaultPages. This action cannot be undone.


History Tab

View transaction logs for any player.

FieldTypeDescription
SearchText InputEnter a player name to search
History entriesList (paginated, 10 per page)Shows timestamp, action (DEPOSIT/WITHDRAW), item ID, and amount

Entries are color-coded: green for deposits, red for withdrawals. Each entry shows a precise timestamp (date + time with seconds).


Worlds Tab

Configure world banking — separate bank inventories per world group.

FieldTypeDescription
World Banking EnabledCheckboxEnable/disable separate bank inventories per world
World GroupsList (paginated)Shows group name and associated world patterns
Group NameText InputName for the world group (e.g., pvp, creative)
WorldsText InputComma-separated world name patterns (e.g., arena, battleground)

World group management:

  • Add group: Enter group name and world patterns, click Add
  • Edit group: Click the Edit button on a group to load its values, modify, then Update
  • Delete group: Click the Delete button to remove a world group
info

World pattern matching uses case-insensitive contains logic. A pattern arena matches a world named PvP_Arena_Kx8hs9d. This accommodates dynamic world name suffixes.


Workflow Examples

Setting up rank-based page limits

  1. Open the admin panel: /ksbank admin
  2. Click the Ranks tab
  3. Enter bank.pages.5 in the Permission field
  4. Enter 5 in the Pages field
  5. Click Add
  6. Repeat for other ranks
  7. In LuckPerms, assign the permissions to groups:
    /lp group vip permission set bank.pages.5 true

Configuring economy providers

  1. Open the admin panel: /ksbank admin
  2. Click the Economy tab
  3. Enter a provider name in "New provider name..."
  4. Click Add
  5. Enter cost array (e.g., 0,100,200,500) and display name
  6. Click Save

Adding item restrictions

  1. Open the admin panel → Restrict tab
  2. Verify the mode is set to your desired mode (blacklist/whitelist)
  3. Enter item patterns (e.g., Quest_Item_*, Soulbound_*)
  4. Click Add for each pattern

Save Behavior

Changes made in the admin panel are applied immediately to the running configuration and saved to config.json on disk. No server restart is required.

If you need to reload configuration from disk (e.g., after manual file edits), use:

/ksbank reload