FeatherfallBank

FeatherfallBank

Shillings. Pouch. Treasury.
A modern Vault economy plugin for Paper 1.21.x that introduces a Shillings currency, a player Pouch (wallet), and a region-safe Treasury bank—wrapped in polished GUIs with clear, friendly UX.

---

✨ Features

• Vault Economy Provider – Registers Shillings so shop/rank plugins work out of the box.
• Pouch (wallet) – Action-bar pickup messages, itemized drops, /pouch GUI, and /pouch drop.
• Treasury (bank) – Secure bank separate from the pouch with clean Deposit/Withdraw menus.
• Fair Death Penalty – Drops 50% of the Pouch on any death (configurable).
• Safe Zones – No pouch drops in configured WorldGuard regions (e.g., spawn).
• Teller Blocks – Optional region-gated teller access (e.g., LECTERN, BELL) for immersive banking.
• Anti-Abuse – Hopper-proof, fire-proof pouch items; safe despawn handling; GUI click-protection.
• Starting Balance – Set a default balance for new players.
• SQLite Storage – Zero-config default; simple and reliable.
• Admin Tools – /treasuryadmin set|give|take|top|reload, locale-aware formatting.

---

✅ Requirements

• Server: Paper 1.21.x (tested on 1.21.8)
• Dependencies:
  • Vault (required)
  • WorldGuard (optional, for safe-zones)
• Note: If you currently use EssentialsX-Economy, remove that jar so FeatherfallBank is the active Vault provider.

---

🚀 Installation

1. Install Vault (and WorldGuard if you want safe-zones).
2. Drop FeatherfallBank-<version>.jar into plugins/.
3. Start the server to generate config files.
4. Run /vault-info and confirm FeatherfallBank is the registered economy provider.
5. Adjust config.yml (starting balance, death-drop percent, safe-zone regions), then /treasuryadmin reload.

---

🔧 Quick Config

currency-name: "Shillings"
currency-name-singular: "Shilling"
starting-balance: 500

pouch:
  death-drop-percent: 0.5        # 50% of Pouch dropped on death
  respect-keep-inventory: true   # if keepInventory is on, skip drops
  hopper-proof: true
  despawn-deletes: true

safe-zones:
  enabled: true
  regions: [owlrun, spawn]       # WorldGuard regions with no pouch drops

treasury:
  allow-command-open: true
  teller:
    enabled: true
    require-region: true
    regions: [owlrun]
    blocks: [LECTERN, BELL]      # blocks that act as Tellers

storage:
  type: SQLITE

messages:
  pickup: "+{amount} Shillings to your Pouch."
  receipt-deposit: "Deposited {amount} Shillings to your Treasury."
  receipt-withdraw: "Withdrew {amount} Shillings to your Pouch."