Wiki Release: 2026.09.8 · UltimateRaids: 0.12.0 · Documentation branch: 1
UltimateRaids installation#
UltimateRaids 0.12.0 targets Java 21 and declares Bukkit/Paper API compatibility from Minecraft 1.18 through the current supported line of the project. Put the plugin JAR in plugins/, start the server once, then review the generated plugins/UltimateRaids/ directory before creating production raids.
Files created on first start#
The plugin ensures these files and folders exist:
config.yml— global runtime, recovery, scheduler, party and provider settings.modules.yml— provider priority when a raid usesAUTO.commands.yml— command aliases/help/permissions presentation.gui.yml— player and admin GUI layout.language/Lang_EN.yml— English messages.raids/— one YAML per raid definition.kits/— reusable temporary raid loadouts.loot/— reusable loot tables.skills/— reusable action sequences.schedulers/— automatic raid schedules.instances/templates/— full-world instance templates supplied by the administrator.instances/schematics/—.schemfiles for schematic instances.extensions/andaddons/— optional JAR components.- runtime storage/recovery files created as the plugin needs them.
The bundled resources include example.yml, example_discovery.yml, example_instance_schematic.yml, example_instance_world.yml, example kits/loot/skills/scheduler and example_room.schem.
Optional integrations#
UltimateRaids starts with native providers for vanilla items/entities, internal raid parties/groups, a native border when the server supports it, and a default schematic bridge. Optional plugins/extensions can add or improve:
- EntityWizard — required for persistent join NPCs; can also provide a visual border bridge through its relocated PacketEvents runtime.
- WorldEdit / FastAsyncWorldEdit — required for
INSTANCEraids whose source isSCHEMATIC. - PlaceholderAPI — exposes
%uraids_...%runtime placeholders. - UltimateClans — can provide clan/group participation through a compatibility extension/provider.
- Vault — economy requirements and money rewards/penalties when a Vault economy provider is registered.
- MythicMobs — custom raid entities through an entity provider.
- Nexo, ItemsAdder, CraftEngine, Oraxen, MMOItems — custom item providers.
- PacketEvents / ProtocolLib — optional visual/border providers when extensions are installed.
The plugin uses modules.yml only to choose among providers registered at runtime. Listing a provider there does not install that integration by itself.
First startup checks#
After startup, verify that UltimateRaids reports its registries/providers and loads the example raid files without errors. Before using advanced content, run:
/uraid validate example
/uraid debug implementations
The first command checks the raid definition; the second shows the providers/registries actually available on the server.
Safe upgrade practice#
- Back up
plugins/UltimateRaids/before replacing the JAR. - Keep custom raid, kit, loot, skill and scheduler files.
- Let the plugin merge missing defaults into the main configuration files.
- Run
/uraid validate <raid>on important raids after the upgrade. - Test KIT inventory restoration and INSTANCE cleanup on a staging server before updating a busy production network.