PurseCommand
PluginMIT

PurseCommand

A basic purse plugin that lets player use their Vault balance as in-game gold ingots, mostly used in towny servers.

23
Downloads
0
Followers
1 months ago
Updated
📦
2
Versions

📖About PurseCommand

💰 BasicPurseCommand

A lightweight, fully configurable gold purse economy plugin for Minecraft servers — powered by Vault.


✨ Features

  • 🪙 Withdraw & deposit: gold ingots between your purse and inventory
  • 🔒 Per-subcommand permissions: full control over who can do what
  • ⚙️ Fully configurable: subcommand names, messages, limits, tab-complete, all from config.yml
  • 🔄 In-game reload: no restarts needed
  • 🗂️ Smart tab-complete: suggests amounts based on your inventory and balance
  • 🛡️ Inventory full protection: optionally prevent withdrawals that would overflow

🧩 Compatibility

Server Software Support
Paper ✅ Full
Purpur ✅ Full
Spigot ✅ Full
Bukkit ⚠️ Partial
Folia ⚠️ Partial

Minecraft version: 1.20.1+
Java version: 21+


📦 Dependencies

Dependency Required
Vault ✅ Yes

📜 Commands

Command Description Permission
/purse withdraw <amount> Withdraw gold from your purse purse.withdraw
/purse deposit <amount> Deposit gold into your purse purse.deposit
/purse balance Check your purse balance purse.balance
/purse reload Reload the configuration purse.reload

📜 Tabcomplete

Command Sequence
/purse withdraw Amount of gold can fit in inventory / Max withdraw amount
/purse deposit Amount of gold in inventory / Max deposit amount
/purse balance No tabcomplete sequence
/purse reload No tabcomplete sequence

⚙️ Configuration

purse:
  max-withdraw-amount: 256
  max-deposit-amount: 2304
  prevent-withdrawal-when-inventory-full: true

subcommands:
  withdraw: "withdraw"
  deposit: "deposit"
  balance: "balance"
  reload: "reload"

permissions:
  withdraw: "purse.withdraw"
  deposit: "purse.deposit"
  balance: "purse.balance"
  reload: "purse.reload"

[...]

All messages, subcommand names, permissions, and limits are fully configurable via config.yml.


🚀 Installation

  1. Download the latest .jar from Releases
  2. Place it in your server's plugins/ folder
  3. Make sure Vault and an economy provider (e.g. EssentialsX) are installed
  4. Restart the server
  5. Configure plugins/BasicPurseCommand/config.yml to your liking
  6. Run /purse reload to apply changes without restarting

🔨 Building from Source

git clone https://github.com/puckypucky0/PurseCommand.git
cd BasicPurseCommand
mvn clean package

Output jar will be in target/.


📄 License

This project is licensed under the MIT License.