Wiki Release: 2026.09.5 · UltimateClans: 9.1.4 · Documentation branch: 9 · ClanWar
ClanWar#
ClanWar adds organized clan-versus-clan wars using arenas, invitations, kits, event rules, rewards and match state. 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.0.1 - Documentation release:
2026.09.5 - Minimum UltimateClans version:
9.0.0
What you can do with it#
- Create/select an arena with the addon wand/admin flow, then define the required positions/spawns
- Configure a kit or arena inventory rules when the war mode requires one
- Configure invitation/acceptance behavior and match limits
- Start/accept a war with test clans, verify teleport, PvP, block rules, winner detection and return flow before enabling rewards
How it works#
War lifecycle#
ClanWar manages invitations/challenges, arena assignment, team/player state, kits, block rules and win resolution. Arena and kit managers are separate so the same combat framework can be reused with different equipment/setup. The event listeners protect the active war from unrelated commands/actions according to configuration.
Build and validate the arena first, then configure kits/rules, then issue a challenge between two test clans. Verify invite expiry/acceptance, teleport/spawns, death/elimination and final winner/reward before enabling broad player access.
First setup#
Before enabling the feature for players, review these installed files:
chat.ymlcommands.ymlconfig.ymlgui.ymllanguage/Lang_EN.ymlpolymart.yml
Recommended in-game workflow#
- Create/select an arena with the addon wand/admin flow, then define the required positions/spawns.
- Configure a kit or arena inventory rules when the war mode requires one.
- Configure invitation/acceptance behavior and match limits.
- Start/accept a war with test clans, verify teleport, PvP, block rules, winner detection and return flow before enabling rewards.
Useful command entry points#
/{_clan} {_war}/{_clan} {_war} {_challenge} (-gui) //{_clan} {_war} {_accept}/{_clan} {_war} {_deny}/{_clan} {_war} {_cancel}/{_clan} {_war} {_view} (-gui)/{_clan} {_war} {_spectate}/{_clan} {_war} {_join}/{_clan} {_war} {_kits} (-gui)/clanwar help/clanwar reload/clanwar wand/clanwar arena create/clanwar arena delete/clanwar arena list/clanwar arena point/clanwar arena toggle/clanwar arena seticon
See Commands in the sidebar for the full command reference and configured aliases/permissions.
GUI areas#
The installed GUI configuration contains screens/sections such as:
War.war_amountWar.war_select_clanWar.war_select_arenaWar.war_select_kitWar.war_select_kit_listWar.war_arenasWar.war_homeWar.war_kitsWar.war_kits_preview
What administrators should configure#
- Keep arena definitions and kit IDs stable after players begin using them.
- Configure commands/rewards only after winner detection is verified.
- Review block protection and restoration behavior for arenas that are not disposable.
Configuration map#
config.yml—Config(date_format, War, Icon, Permissions, logger, league)chat.yml—Announce(invite_sended, inwait_announce, inlobby_announce, instarted_announce, inending_announce, inending_announce2, instoped_announce, incanceled_announce, receive)
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 |
|---|---|---|
| War invitation expires or cannot be accepted | Invite timeout, clan state, permission or another active war blocks acceptance | Check both clans are eligible and review invite timing/state. |
| Players are not teleported correctly | Arena spawn/location data is incomplete or world is unavailable | Validate every arena location and teleport to it with admin tools. |
| Winner is not detected | Participant/clan elimination state did not reach the expected condition | Check console errors and reproduce with the smallest possible 1-clan-vs-1-clan test. |
| Arena blocks remain changed | Protection/restore configuration does not match the intended arena behavior | Use the documented protection mode and test rollback before production. |
For a longer diagnostic flow, open the Troubleshooting page for this component.