Wiki Release: 2026.09.8 · UltimateClans: 9.1.4 · Documentation branch: 9 · Rewards

Rewards#

Rewards adds persistent clan reward tracking/claiming tied to supported clan progression/events, with GUI and storage. 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: 1.2
Documentation release: 2026.09.8
Minimum UltimateClans version: 9.0.0

What you can do with it#

Configure reward definitions and eligibility rules
Trigger the associated clan progression/event on a test clan
Open reward GUI/command, claim the reward and verify it cannot be claimed again when designed as one-time

How it works#

Reward claim model#

Rewards persists claimable clan rewards and prevents already-consumed rewards from being treated as new when configured as one-time. It is commonly consumed by progression features such as Levelup. Test reward creation, listing and collection with the exact inventory/economy/command actions you plan to use.

First setup#

Before enabling the feature for players, review these installed files:

commands.yml
config.yml
gui.yml
language/Lang_EN.yml
language/Lang_ES.yml

Recommended in-game workflow#

Configure reward definitions and eligibility rules.
Trigger the associated clan progression/event on a test clan.
Open reward GUI/command, claim the reward and verify it cannot be claimed again when designed as one-time.

This feature is mainly automatic or accessed through the parent plugin/GUI, so it does not need a large standalone command tree.

GUI areas#

The installed GUI configuration contains screens/sections such as:

General.levelup_rewards

What administrators should configure#

Test overflow/inventory/economy command actions separately.

Configuration map#

config.yml — Config (date_format_short, Rewards, Permissions); Storage (type, mysql, user, pass, databases, datasource)

The Configuration page lists the available paths and defaults from the installed configuration, with notes on what each area controls.

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
Reward never appears	Trigger/eligibility definition is unmet	Check exact event/level requirement and clan state.
Reward can be claimed repeatedly	Claim persistence failed or reward identity changed	Check storage and keep stable reward IDs.
Command reward fails	Console command syntax or placeholder is invalid	Run resolved command manually.

For a longer diagnostic flow, open the Troubleshooting page for this component.