Bank | UClans Addon 5.1.0

This addon requires UltimateClans 9.0.0+

Documentation/Wiki | 

About:

Addon for ⚔ Ultimate Clans ⚔ | Take your server to a higher level.

Clan Bank adds a complete shared financial system for clans. Clan members can deposit money, withdraw funds according to their role permissions, organize clan reserves, create Vaults and Goals, review transaction history, track member contributions and much more.

The real clan balance is always managed and saved by UltimateClans Core. Bank-specific information such as transaction history, Vault allocations, Goals, requests and statistics is stored separately by the addon.

This addon must be installed in: /plugins/UltimateClans/addons/

⭐ Features

• Shared Clan Bank - Deposit and withdraw money shared between clan members.
• Complete Bank GUI - Access the main Bank features directly through configurable menus.
• Transaction History - Track deposits, withdrawals, transfers, interest and other Bank operations.
• Paginated History - Easily browse large transaction histories.
• Member Contributions - Track how much every clan member has deposited and withdrawn.
• Contribution Ranking - See the members who contributed the most to the clan.
• Bank Statistics - View total deposited, total withdrawn, transaction count and other Bank information.
• Withdrawal Requests - Members can request withdrawals that must be approved by authorized clan roles.
• Configurable Approval Rules - Require approvals depending on the requested amount.
• Direct Withdrawal Permission - Authorized roles can bypass the request system.
• Transaction Limits - Configure maximum withdrawal amounts per transaction.
• Daily Withdrawal Limits - Control how much each role can withdraw per day.
• Weekly Withdrawal Limits - Control how much each role can withdraw per week.
• Protected Reserve - Reserve part of the clan balance so it cannot be withdrawn normally.
• Bank Vaults - Create internal allocations for different clan purposes.
• Vault Management GUI - Create, rename, allocate funds, release funds and delete Vaults directly in-game.
• Clan Goals - Create financial goals and follow their progress through the Bank GUI.
• Goal Progress - Displays current balance, target amount and completion percentage.
• Clan-to-Clan Transfers - Transfer clan money directly to another clan.
• Optional Interest System - Reward clans for keeping money in their Bank. Disabled by default and fully configurable.
• Bank Upgrade Tiers - Bank capabilities can progress according to the clan level.
• Role Permissions - Control access to Bank features using the UltimateClans role permission system.
• PlaceholderAPI Support - Extensive placeholders for balance, statistics, Goals, Vaults, contributions and more.
• Fully Configurable GUIs - Materials, slots, cosmetics, sounds and menu elements can be customized through gui.yml.
• Customizable Messages and Commands - Uses the same configurable structure as other UltimateClans addons.

🏦 Bank Vaults

Vaults allow clans to organize their existing Bank balance into internal allocations such as War Fund, Base Upgrades or Emergency Reserve.

Vaults do not create a second money balance. The real money always remains inside the UltimateClans Core Bank. A Vault only marks part of that balance as allocated.

Example:

Clan Bank: $1,000,000
War Vault: $300,000
Upgrade Vault: $200,000
Available Balance: $500,000

Vaults can be created and managed directly through the GUI. Authorized members can allocate funds, release funds, rename Vaults and remove empty Vaults.

🎯 Clan Goals

Create a financial objective for your clan and track its progress automatically.

Goal: New Clan Base
Current: $650,000
Target: $1,000,000
Progress: 65%

Goals do not reserve money. They monitor the clan's current Bank balance and display progress toward the configured target.

📜 Transaction History & Contributions

Every important Bank operation can be registered in the clan's transaction history, including the player responsible, amount, previous balance, resulting balance, date and operation type.

The Contributions menu separately tracks member deposits and withdrawals, making it easy to identify the clan's top contributors.

Both menus support pagination for clans with large amounts of Bank activity.

✅ Withdrawal Requests & Limits

Servers can enable a request system for withdrawals. Instead of directly taking money from the clan Bank, members can submit a request containing an amount and optional reason.

Authorized roles can approve or deny pending requests. Approval requirements can be configured according to the withdrawal amount.

Bank withdrawals can also be limited by:

• Maximum amount per transaction
• Maximum amount per day
• Maximum amount per week
• Clan role

Withdrawal Requests and limits are optional and can be configured without changing the classic Bank behavior.

💰 Interest System

The optional Interest System can periodically reward clans based on the money stored in their Bank.

Interest is disabled by default and can be configured with its own percentage, interval and limits.

Any money generated by interest is credited to the real UltimateClans Core Bank balance and registered in the Bank history.

⌨ Commands

Main Bank
/clan bank - Opens the Bank menu.
/clan bank add - Deposit money into the clan Bank.
/clan bank withdraw - Withdraw money from the clan Bank.
/clan bank view (-gui) - View the clan Bank.

History & Statistics
/clan bank history - Opens the transaction history.
/clan bank stats - Opens Bank statistics.
/clan bank contributions - Opens member contributions.

Withdrawal Requests
/clan bank request [reason] - Create a withdrawal request.
/clan bank request list - View withdrawal requests.
/clan bank request approve - Approve a request.
/clan bank request deny - Deny a request.
/clan bank request claim - Claim an approved withdrawal.

Bank Vaults
/clan bank vault list - List clan Vaults.
/clan bank vault create - Create a Vault.
/clan bank vault delete - Delete an empty Vault.
/clan bank vault deposit - Allocate Bank funds to a Vault.
/clan bank vault withdraw - Release funds from a Vault.

Protected Reserve
/clan bank reserve - Change the protected Bank reserve.

Clan Goals
/clan bank goal view - View the current clan Goal.
/clan bank goal set - Create or change the clan Goal.
/clan bank goal clear - Remove the current Goal.

Clan Transfers
/clan bank transfer - Transfer Bank money to another clan.

Most Bank V2 features can also be accessed and managed directly through the Bank GUI.

🔐 Clan Role Permissions

The addon integrates with the UltimateClans role permission system.

Bank-View
Bank-Add
Bank-Withdraw
Bank-History
Bank-Statistics
Bank-Contributions
Bank-Requests
Bank-Approve-Request
Bank-Withdraw-Direct
Bank-Vault
Bank-Reserve
Bank-Goal
Bank-Transfer

Permissions can be assigned to the appropriate clan roles, allowing servers to control exactly who can access each financial feature.

🔌 Placeholders

%uclans_bank_reserved%
%uclans_bank_available%
%uclans_bank_total%

%uclans_bank_goal_name%
%uclans_bank_goal_amount%
%uclans_bank_goal_progress%
%uclans_bank_goal_percentage%

%uclans_bank_total_deposited%
%uclans_bank_total_withdrawn%
%uclans_bank_transactions%

%uclans_bank_member_deposited%
%uclans_bank_member_withdrawn%
%uclans_bank_member_net%

%uclans_bank_pending_requests%

%uclans_bank_vaults%
%uclans_bank_vault_total%
%uclans_bank_vault_limit%

%uclans_bank_tier%
%uclans_bank_interest_rate%
%uclans_bank_interest_earned%

%uclans_bank_top_depositor_1%
%uclans_bank_top_depositor_1_amount%

Top depositor placeholders support different numeric positions by replacing 1 with the desired ranking position.

⚙ Configuration

The addon provides configurable files for:

• Bank behavior and feature settings
• Withdrawal limits and requests
• Interest
• Bank tiers
• Vaults and Goals
• Commands
• Clan role permissions
• Messages and languages
• GUI layouts, items, materials, slots, sounds and cosmetics

Bank V2 metadata is stored in:

/plugins/UltimateClans/addons/Bank/storage/yaml/data.yml

The real clan Bank balance is not stored in this file. The clan's money continues to be managed and persisted by UltimateClans Core.

📦 Dependencies

⚔ Ultimate Clans ⚔ | Take your server to a higher level - Required!

UltimateClans Economy Extension / supported economy implementation - Required!

🖼 Preview