Wiki Release: 2026.09.5 · UltimateClans: 9.1.4 · Documentation branch: 9 · ClanBank
ClanBank practical usage guide#
ClanBank adds shared clan economy with deposits, withdrawals, statements, member contributions, withdrawal requests, protected reserves, goals, transfers, vaults and configurable progression/limits. This guide focuses on the actual administrator and player workflow: what to set up first, how to test it in-game, and what to check before enabling it for everyone.
How the feature works#
In normal use, the feature follows this flow: Open the bank with /clan bank view -gui (or the configured GUI action). Deposit clan funds with /clan bank add <amount> and verify the new balance. Withdraw with /clan bank withdraw <amount> when the member role and bank rules allow it.
Recommended in-game workflow#
- Open the bank with
/clan bank view -gui(or the configured GUI action). - Deposit clan funds with
/clan bank add <amount>and verify the new balance. - Withdraw with
/clan bank withdraw <amount>when the member role and bank rules allow it. - Use
/clan bank history,/clan bank contributionsand/clan bank statsto audit activity. - Configure a protected reserve with
/clan bank reserve <amount>so normal withdrawals cannot consume money reserved by the clan. - Use
requestfor approval-based withdrawals,goalfor a clan savings target,transferfor clan-to-clan money movement, andvaultfor additional separated balances where enabled.
Administrator setup checklist#
- Confirm an economy implementation is available to UltimateClans before allowing deposits or withdrawals.
- Review role-based Bank permissions and limits in
config.yml; test with a normal member and a leader. - Configure transaction/history retention, requests, goals, reserve, transfer rules, interest and upgrade/tier features only if you intend to expose them.
- Keep storage consistent across servers when the network shares clan data.
Commands and GUI access#
Use the command examples in the workflow above and open the Commands page in the sidebar for the complete configured command tree. Command labels can be changed in commands.yml, so the Wiki keeps the player-facing examples separate from the raw message templates.
Configuration areas#
Config—Bank,Icon,Permissions,logger
Changing settings safely#
- Back up the component configuration and persistent data before changing a live server.
- Change one feature area at a time.
- Reload only if the component documents reload as safe; otherwise restart the server.
- Test with a non-OP account that has exactly the intended clan role/permission.
- Watch the console from the first relevant warning/error, not only the final stack trace.
- On multiserver networks, repeat the check on every node and confirm shared storage/sync settings match.