Wiki Release: 2026.09.8 · UltimateRaids: 0.12.0 · Documentation branch: 1

UltimateRaids getting started#

The fastest way to learn UltimateRaids is to create a small raid, edit it through the admin GUI, set its locations, validate it, and run it before adding bosses or instance worlds.

Create your first raid#

/uraid create crypt_test

The command creates a new raid definition in raids/. Then open the editor:

/uraid edit crypt_test

The editor exposes the same underlying YAML model through sections for general settings, entry/lobby behavior, participation, loadout, NPC, environment, border, locations, player lifecycle, access requirements/cooldowns, stages, rewards, displays/actions and validation.

Set the important locations#

Stand where the raid should use each point and run:

/uraid location origin crypt_test
/uraid location lobby crypt_test
/uraid location spawn crypt_test
/uraid location spectator crypt_test
/uraid location exit crypt_test

If you want hard arena bounds:

/uraid location pos1 crypt_test
/uraid location pos2 crypt_test

Locations are written into the raid definition. For relative locations, UltimateRaids resolves them from the raid origin at runtime.

Add gameplay#

Every production raid should have at least one stage. A stage can complete from an objective, waves, both, either, or auto behavior depending on completion.

A simple first stage can be:

stages:
  '1':
    id: survive
    name: 'Hold the room'
    timeout: 60
    completion: OBJECTIVE
    objective:
      type: SURVIVE
      amount: 30

Once that works, add waves and bosses.

Validate before starting#

/uraid validate crypt_test

Validation detects missing stages, impossible player/group limits, bad instance templates/schematics, unavailable providers, unknown objectives/rewards, invalid boss targets, missing kits and many other configuration problems.

Start it#

For a normal raid, an administrator can use:

/uraid start crypt_test

A player may also use:

/raid join crypt_test

depending on the raid's entry/participation rules.

/uraid start <raid> force bypasses the normal lobby/availability path and should be used mainly for deliberate testing or administration.

Recommended first test#

Use SOLO, min-players: 1, max-players: 1, loadout.mode: PLAYER, environment.mode: OPEN_WORLD, and one SURVIVE stage. This isolates the basic lifecycle. Add KIT, groups, INSTANCE cloning, loot, custom providers and automation only after the simple raid completes cleanly.