Wiki Release: 2026.09.5 · UltimateClans: 9.1.4 · Documentation branch: 9 · ClanChest
ClanChest#
ClanChest adds shared clan inventory storage with multiple pages, configurable page modes, role restrictions and safer multiserver access. The pages in this section explain what players see in-game, what administrators need to configure, the normal setup flow, and the most common problems you may need to diagnose.
Compatibility#
- Component version:
5.1.0 - Documentation release:
2026.09.5 - Minimum UltimateClans version:
9.0.0
What you can do with it#
- Open the shared storage through the configured
/clan chestcommand/GUI action - Unlock or buy additional pages if page purchasing is enabled
- Use NORMAL pages for regular shared storage, LOCKED pages for role-restricted access, DEPOSIT_ONLY pages when members may add but not remove, and CATEGORY pages when the page is intended for filtered/category storage
- Leaders can be configured/implemented with broader management access; test each clan role before production use
How it works#
Page modes and storage behavior#
ClanChest stores clan inventory contents independently from GUI cosmetic buttons. Each configured page has its own identity and access mode. NORMAL behaves as shared storage; LOCKED restricts access; DEPOSIT_ONLY permits adding while preventing ordinary removal; CATEGORY is intended for category/filter-oriented page behavior.
When changing GUI design, keep storage slots and cosmetic/navigation slots separate. Existing stored items and unlocked-page state should be preserved during upgrades when the page IDs/layout remain compatible. In multiserver environments, the locking/synchronization layer prevents two servers from writing the same clan chest concurrently.
First setup#
This component has little or no standalone installed configuration. Verify that the parent plugin detects it successfully, then test the feature that consumes it.
Recommended in-game workflow#
- Open the shared storage through the configured
/clan chestcommand/GUI action. - Unlock or buy additional pages if page purchasing is enabled.
- Use NORMAL pages for regular shared storage, LOCKED pages for role-restricted access, DEPOSIT_ONLY pages when members may add but not remove, and CATEGORY pages when the page is intended for filtered/category storage.
- Leaders can be configured/implemented with broader management access; test each clan role before production use.
This feature is mainly automatic or accessed through the parent plugin/GUI, so it does not need a large standalone command tree.
What administrators should configure#
- Define each page name, icon, description, unlock requirement and mode in the addon configuration.
- Keep visual GUI slots separate from actual stored item layout; do not repurpose storage slots as cosmetic buttons.
- For shared MySQL/multiserver environments, use the addon locking/synchronization behavior and avoid running different page definitions on different nodes.
Before going live#
- Back up the component data/configuration.
- Start the server and confirm the component is detected without startup errors.
- Test with a non-OP player and the lowest clan role that should have access.
- Exercise the complete flow once, including the failure/deny path, not only the happy path.
- Restart the server and verify that persistent state survives.
- If the network is multiserver, repeat the test from a second node and verify storage/synchronization.
Troubleshooting quick reference#
| Symptom | Likely cause | What to check |
|---|---|---|
| A member can open a page but cannot remove items | The page is DEPOSIT_ONLY/LOCKED or the role does not meet the configured access rule | Check the page mode and role requirement; test with leader versus ordinary member. |
| Items appear missing after changing GUI layout | Stored item positions and GUI cosmetic layout were changed inconsistently | Restore the page/storage layout from backup and change only documented cosmetic slots. |
| Two servers show different chest state | Nodes use different storage, page configuration or synchronization state | Verify identical addon config, shared database where intended, and check locking/sync errors on both nodes. |
| Page purchase/unlock does nothing | Economy/unlock requirements or clan permissions are not satisfied | Check economy provider, price/unlocker settings and the member role permission. |
For a longer diagnostic flow, open the Troubleshooting page for this component.