RoyalBank

# RoyalBank

RoyalPlugins: (https://discord.gg/D3HRBJXsHj) · (https://github.com/joogiebear/RoyalBank/wiki) · (https://github.com/joogiebear/RoyalBank/issues) · (https://github.com/joogiebear/RoyalBank)

RoyalBank is a Vault-backed bank plugin for Paper 26. 2 or newer with upgradeable account tiers, configurable GUI menus, SQLite storage, daily interest, transaction history, optional EcoItems-style upgrade costs, optional PlaceholderAPI placeholders, and bStats.

Part of a suite with (https://github.com/joogiebear/RoyalAuctions), (https://github.com/joogiebear/RoyalBazaar) and (https://github.com/joogiebear/EconGuard). Each works standalone.

## Requirements

• Paper 26. 2 or newer (Java 25)
• Java 21 (build target)
• Vault
• A Vault-compatible economy plugin
• Optional: EcoItems or another PDC-tagged custom item plugin
• Optional: PlaceholderAPI
• Optional: EconGuard — if present, every bank movement is reported to the shared audit ledger
• automatically. No configuration needed on either side.

1. Build or download `RoyalBank.jar`. 2. Put the shaded jar in your server `plugins/` folder. 3. Do not install `original-RoyalBank.jar`. 4. Restart the server. 5. Edit generated files under `plugins/RoyalBank/`. 6. Run `/bank reload` after config/message/GUI edits.

## Commands

Player commands:

```text /bank /bank balance /bank deposit /bank withdraw /bank transfer /bank upgrade /bank interest /bank info ```

Admin commands:

```text /bank reload /bank admin balance /bank admin setbalance /bank admin addbalance /bank admin removebalance /bank admin setlevel /bank admin reset /bank admin transactions /bank admin backup /bank admin flags ```

## Permissions

```text royalbank.use default: true royalbank.deposit default: true royalbank.withdraw default: true royalbank.upgrade default: true royalbank.transfer default: true royalbank.admin default: op royalbank.alerts default: op ```

GUI actions enforce the same deposit/withdraw/upgrade permissions as commands.

## Configuration files

Generated files:

```text plugins/RoyalBank/config.yml plugins/RoyalBank/messages.yml plugins/RoyalBank/gui/main.yml plugins/RoyalBank/gui/deposit.yml plugins/RoyalBank/gui/withdraw.yml plugins/RoyalBank/gui/transactions.yml plugins/RoyalBank/gui/confirm-upgrade.yml ```

GUI files support configurable title, rows, filler item, item slots, materials, names, lore, actions, and sounds.

## Upgrade item requirements

Preferred shorthand format:

```yaml upgrade-cost: money: 25000000. 0 items: - "minecraft:GOLD_BLOCK:64" - "ecoitems:enchanted_gold_block:20" - "ecoitems:bank_upgrade_core:1" ```

Vanilla requirements reject known custom/PDC-tagged EcoItems so a custom gold-block item does not satisfy `minecraft:GOLD_BLOCK`.

## PlaceholderAPI

If PlaceholderAPI is installed, RoyalBank registers these placeholders:

```text %royalbank_balance% %royalbank_balance_raw% %royalbank_level% %royalbank_level_name% %royalbank_max_balance% %royalbank_max_balance_raw% %royalbank_bank_space% %royalbank_bank_space_raw% %royalbank_next_interest% %royalbank_next_interest_raw% %royalbank_interest_time% %royalbank_max_interest% %royalbank_combined_balance% ```

## Interest & bonuses

• Interest is claim-driven, not paid by a background timer. Players receive it on join (if
• `settings.interest-on-join` is true) and via `/bank interest` or the GUI button, subject to
• `settings.interest-cooldown-hours`. The cooldown is only consumed when interest is actually paid,
• so an empty or full bank does not "waste" a claim.
• `settings.max-daily-interest.amount` caps each claim; the cooldown governs how often a claim can
• happen. Set the amount negative for no global cap. A per-level `max-interest` of `0` disables
• interest for that tier; a negative value means no per-level cap.
• The first-deposit bonus is paid once per account, tracked persistently. Emptying and
• re-depositing no longer re-grants it. (An admin `/bank admin reset` makes a fresh account eligible
• again.)

```text /bank admin backup ```

Backups are written to:

```text plugins/RoyalBank/backups/ ```

The backup command uses SQLite `VACUUM INTO` instead of copying the live database file directly, and runs off the main thread so large databases do not stall the server.

## Anti-abuse / RMT detection

RoyalBank watches money moving in and out of the bank to surface laundering and real-money-trading (RMT) — e.g. a brand-new account suddenly parking a fortune. It is a detection layer: it cannot see purse-to-purse `/pay` transfers (limit those in your economy plugin), but large deposits and rapid balance growth are stron