Skip to content

Install Raid System

Install XSC_Raids, register its objective and reward items, then verify a complete encounter.

On this page

1. Check the archive and dependencies

  1. Keep a copy of the complete download and any existing raid configurations before replacing files.
  2. Install and verify your framework, ox_lib, ox_target, and ox_inventory using their own setup instructions.
  3. Confirm the framework exposes the QB core API and working player bank/inventory functions, including GetMoney, RemoveMoney, AddItem, and RemoveItem. A running inventory alone does not establish that this bridge works.
  4. Place the resource in a folder named XSC_Raids with fxmanifest.lua directly inside it. Keep all Cfx-delivered files, including .fxap when present.
Resource layout
resources/
└── XSC_Raids/
    ├── fxmanifest.lua
    ├── client/
    ├── server/
    └── configs/

A Qbox installation must provide the compatible QB API and inventory methods this version calls. Do not start a second framework just to satisfy a missing export. ESX and standalone adapters are not included.

2. Prepare objective and reward items

All four supplied configurations use this objective. Register the same item name in the inventory setup used by your core, or change the objective to an item you have deliberately registered for that purpose.

Inside a configs/config_*.lua return table
objective = {
    item = "walker_manifest",
    requiredAmount = 1
},
  • Review every loot entry in the four supplied configurations. Reward names must exactly match registered inventory items.
  • The supplied economy references custom materials, drugs, weapon parts, keys, and weapons. Those definitions and their gameplay systems are not installed by Raids.
  • Set the objective label, weight, and image through your inventory's item configuration. Supply artwork through that inventory's image directory; this Raids archive includes no item artwork to copy.
  • Verify an objective item and one configured reward can be added through the framework/inventory bridge before testing a paid raid.

3. Start the resource after its dependencies

Add Raids after your existing framework and inventory startup sequence. This example shows the named dependencies; retain any additional prerequisites required by your particular core and inventory.

server.cfg: QBCore example
ensure ox_lib
ensure qb-core
ensure ox_target
ensure ox_inventory
ensure XSC_Raids

There is no Raids SQL file to import. Database installation for your framework or inventory is separate. Restart during a maintenance window after changing inventory definitions or resource files.

4. Test from the start contact to delivery

  1. Check the server console for Loaded configuration for raid messages and read any earlier dependency or Lua error.
  2. Choose a configured encounter and visit its startingPed coordinates. Use ox_target within approximately 2 metres and select Start Raid.
  3. Use a test character with enough bank funds for startCost. Confirm the charge and the GPS route to the raid area.
  4. Enter the marked area, allow guards to spawn, and clear them. After the search notification, use Search Guard on the bodies until the objective is found.
  5. Confirm the objective item was received, follow the delivery route, and select Deliver Loot at the configured endingPed.
  6. Check the actual inventory changes and server logs. Test every encounter's access, collision, guard positions, and reward definitions before opening it to players.