Getting Started

This guide walks you through setting up the Bank plugin on your Hytale server.

1. Install the Plugin

Place the bank.jar file into your server’s mods/ directory.

server/
  mods/
    bank.jar
    core.jar        (recommended — shared economy, localization)

Start the server. On first launch the plugin creates its data folder and extracts the default config.json.

2. Verify First Launch

After the server starts, check the console for:

[KyuubiSoft Bank] Config loaded: 5 max pages, 45 slots/page, blacklist mode with 0 items

The plugin data folder is created at:

server/
  mods/
    bank/
      config.json
      data/           (player bank data, created on first use)
      transactions.db (SQLite, created on first use)

3. Basic Configuration

Open config.json and adjust to your needs:

{
  "defaultPages": 1,
  "maxPages": 5,
  "slotsPerPage": 45,
  "upgrade": {
    "enabled": true,
    "defaultCosts": [0, 250, 500, 1000, 2500],
    "defaultCurrencyName": "Gold",
    "providerCosts": {},
    "providerDisplayNames": {}
  },
  "restrictionMode": "blacklist",
  "restrictedItems": [],
  "historyMaxEntries": 100
}

Key decisions:

How many pages should players start with? Set defaultPages.
How expensive should upgrades be? Adjust the upgrade.defaultCosts array. Pages beyond the array length are only grantable via admin.
Multiple economies? Add provider-specific costs in upgrade.providerCosts and display names in upgrade.providerDisplayNames.
Should certain items be blocked? Add patterns to restrictedItems and set restrictionMode.

After editing, reload without restarting:

/ksbank reload

4. Set Up a Bank NPC

The bank integrates with the KyuubiSoft Citizens system. To create a bank NPC:

Create a citizen NPC using the Citizens plugin
Configure the NPC’s dialog to trigger the bank open action
Players interact with the NPC to open their bank

The bank opens using the native Container API with drag-and-drop support — no custom UI pages required.

5. Test It

Walk up to the bank NPC and interact to open your bank
Drag items in and out to test storage
Check your history:
```
/ksbank history
```
Try upgrading:
```
/ksbank upgrade
```
Switch pages:
```
/ksbank page 2
```

6. Admin Quick Reference

Grant yourself admin access, then test the admin commands:

/ksbank open <player>           — View another player's bank
/ksbank give <player> <item>    — Add an item to a player's bank
/ksbank adminupgrade <player>   — Unlock pages for free
/ksbank reset <player>          — Reset a player's bank
/ksbank log <player>            — View transaction log
/ksbank reload                  — Reload config

All admin commands require the bank.admin permission.

Next Steps

See Commands for the full command reference
See Configuration for all config fields and examples