Wiki Release: 2026.09.5 · UltimateClans: 9.1.4 · Documentation branch: 9 · ClanRaids
ClanRaids practical usage guide#
ClanRaids adds multi-stage clan raid system with lobby/ready flow, multiple environment modes, waves, bosses and objective types, rewards, requirements, effects and recovery. 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: Create/edit a raid definition in the admin workflow and choose an environment type appropriate to your server: REGION, ARENA, DYNAMIC or INSTANCE where supported. Configure lobby/start behavior, participant limits/requirements and the stage list. For each stage, configure objectives such as waves, boss, kill, destroy, defend, no-deaths, survive, reach, capture, collect, escort or interact according to the supplied objective system.
Recommended in-game workflow#
- Create/edit a raid definition in the admin workflow and choose an environment type appropriate to your server: REGION, ARENA, DYNAMIC or INSTANCE where supported.
- Configure lobby/start behavior, participant limits/requirements and the stage list.
- For each stage, configure objectives such as waves, boss, kill, destroy, defend, no-deaths, survive, reach, capture, collect, escort or interact according to the supplied objective system.
- Define mobs/bosses/rewards in their dedicated files and reference the exact IDs from the raid/stage definitions.
- Start a test raid with a small clan, verify ready/countdown, objective progression, stage transitions, completion/failure and player return.
Administrator setup checklist#
- Keep
raids.yml,mobs.yml,bosses.ymlandrewards.ymlIDs consistent; a typo can make a structurally valid YAML file unusable. - INSTANCE mode requires its environment/template prerequisites; REGION/ARENA require valid saved locations/bounds.
- Use debug and environment diagnostics before modifying gameplay code when entities/objectives do not progress.
- Test server restart/reload recovery only after the basic raid completes normally.
Useful configured command examples#
The following usage strings are taken from the supplied commands.yml; aliases and exact command labels remain configurable.
Use: /clanraids admin [raid]Use: /clanraids listUse: /clanraids infoUse: /clanraids create [DYNAMIC|REGION|ARENA]Use: /clanraids cloneUse: /clanraids deleteUse: /clanraids nameUse: /clanraids descriptionUse: /clanraids iconUse: /clanraids enableUse: /clanraids disableStage: list, create [name], delete , name , completion ALL|ANY, checkpoint true|false, move up|down, objective add|remove [optional].Objective: list, create , delete , name , type , target , amount , time .Wave: list, create , link , remove , move up|down, delay , condition ALL_DEAD|TIMER, mob add|amount , mob remove .Mob: list, create [entity], delete , name|entity|health|damage|elite, equipment, dropchance, effect, drop.Boss: list, create, delete, name, entity, health, damage, scalehealth, scaledamage, equipment, effect, drop, phase.Reward: list, create , delete , link|unlink , set , item|command add|remove|clear [value].Environment: type, selection apply, point1, point2, playerspawn, mobspawn, bossspawn, exit, blockbreak, blockplace, regenerate, exclusive, requireinside, returnmode, minradius, maxradius, world, template, validate, debug.
Configuration areas#
general—tick-period,max-active-raids,allow-reload-with-active-raidslobby—timeout-seconds,require-all-ready,leader-auto-ready,start-countdown-seconds,countdown-effects-every-secondsession—disconnect-grace-seconds,empty-timeout-seconds,return-players-after-endgameplay—dynamic-spawn-min-radius,dynamic-spawn-max-radius,remove-raid-mob-drops,remove-raid-mob-xp,stage-transition-delay-ticks,offline-grace-seconds,mob-boundary-check-ticks,max-runtime-mobs-per-raid,instance,mob-health-indicator,environmentintegration—rewardsadmin—wanddebug—enabled,console
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.