Skip to content
KyuubiSoft Wiki
News & Patchnotes

Bank

Bank

Section titled “Bank”

kyuubisoft

A persistent per-player bank system for Hytale servers with native ItemGrid drag-and-drop, economy integration, rank-based page limits, a full admin panel, and multi-language support.

Features

Section titled “Features”

Native ItemGrid with Drag & Drop

Section titled “Native ItemGrid with Drag & Drop”
  • Custom UI page with native Hytale ItemGrid for full drag-and-drop support
  • 3-panel layout: Settings (left), Bank (center with DecoratedContainer), Economy (right)
  • Feels like a natural game inventory, not a plugin page

Multi-Page Storage with Upgrades

Section titled “Multi-Page Storage with Upgrades”
  • Multiple bank pages per player with configurable slot counts
  • Pages unlockable via economy-based upgrades or admin command
  • Visual page selector popup for quick navigation
  • Rank-based page limits via LuckPerms permissions

Economy Integration

Section titled “Economy Integration”
  • VaultUnlocked multi-provider support (auto-detected via reflection)
  • EcotaleCoins auto-detection for coin-to-currency conversion
  • Coin deposit: drag coin items into bank to auto-convert to currency
  • Currency withdraw to inventory
  • Per-provider balance display

Item Search and Sorting

Section titled “Item Search and Sorting”
  • Item search functionality to find items across all pages
  • Sort modes: Default, A-Z, Z-A, Rarity
  • Scroll mode toggle (scrollbar vs paginated view)
  • Per-user persistent settings (sort mode, scroll mode)

NPC Integration

Section titled “NPC Integration”
  • Open the bank by interacting with designated bank NPCs
  • NPC dialog integration with configurable greeting messages
  • Works with the KyuubiSoft Citizens system

Item Restrictions

Section titled “Item Restrictions”
  • Blacklist mode — Block specific items from being stored
  • Whitelist mode — Only allow specific items
  • Configurable per bank page or globally
  • Restrictions enforced server-side via DelegateItemContainer slot validation

Transaction History

Section titled “Transaction History”
  • All deposits and withdrawals logged to SQLite database
  • Queryable transaction history per player
  • Timestamps and item details recorded for admin auditing
  • Item icons and color-coded entries (green for deposits, red for withdrawals)

Auto-Save

Section titled “Auto-Save”
  • Automatic periodic saves to prevent data loss
  • Save on player disconnect and server shutdown
  • Dirty-flag system to minimize unnecessary writes

Admin Panel

Section titled “Admin Panel”
  • Full admin panel UI with 8 tabs (/ksbank admin)
  • General, Economy, Ranks, Coins, Restrict, Players, History, Worlds tabs
  • All settings editable inline with immediate save
  • Player search, bank inspection, and reset functionality
  • Reload configuration without server restart

World Banking

Section titled “World Banking”
  • Separate bank inventories per world group
  • Configurable world groups with pattern matching (case-insensitive contains)
  • Worlds not assigned to any group share the global bank (backward-compatible)
  • Separate data storage per world group

Shop Info Button

Section titled “Shop Info Button”
  • Configurable “Want more pages?” button in the page overview
  • Customizable button text and chat message
  • Clickable link support (e.g., to your server’s web shop)

Inline Buy Buttons

Section titled “Inline Buy Buttons”
  • Buy pages directly from the page overview without opening a separate dialog
  • Each page row shows a buy button with the cost for that page

Provider Display Names

Section titled “Provider Display Names”
  • Custom display names for economy providers (e.g., “Ecotale Coins” instead of “Ecotale”)
  • Configurable per provider in the upgrade config

Shift+Click Support

Section titled “Shift+Click Support”
  • Shift+Click to quickly move items from inventory to bank
  • Works with the native ItemGrid drag-and-drop system

Provider and Coin Management

Section titled “Provider and Coin Management”
  • Edit and delete economy providers directly in the admin panel
  • Edit and delete coin definitions in the admin panel
  • No config file editing required for coin/provider changes

Enhanced Player Tab

Section titled “Enhanced Player Tab”
  • Detailed player stats (UUID, page count, item count, world group, sort mode)
  • Add and remove pages directly from the admin player view

Pagination

Section titled “Pagination”
  • Pagination on all admin panel tabs for large datasets
  • Consistent navigation across General, Economy, Ranks, Coins, Restrict, Players, History, and Worlds tabs

Localization

Section titled “Localization”
  • 9 languages supported out of the box
  • Per-player language selection via /kslang
  • All UI labels, notifications, and NPC dialogs fully localized

Commands

Section titled “Commands”
CommandDescription
/ksbankOpen your bank (if not at an NPC)
/ksbank adminOpen the admin panel (8 tabs)

Requirements

Section titled “Requirements”
  • Hytale Server with plugin support
  • Works standalone or with KyuubiSoft Core for enhanced features (shared economy, NPC system, localization)

Configuration

Section titled “Configuration”
  • config.json — Bank settings (page sizes, upgrade costs, restriction mode, world banking, economy)
  • Localization: 9 languages supported (en-US, de-DE, es-ES, fr-FR, it-IT, pl-PL, pt-BR, ru-RU, tr-TR)
  • Transaction data stored in transactions.db (SQLite)
  • Player data stored in data/players/<uuid>.json

Pages

Section titled “Pages”