Skip to main content

Installation

This guide assumes you have an existing FiveM server and access to its resources directory and server.cfg.

1. Download and extract​

Extract the product ZIP. The resource directory in the supplied archive is named ChaosMod.

Make sure the files are directly inside that folder:

resources/
└── [standalone]/
└── ChaosMod/
├── fxmanifest.lua
├── config.lua
├── client/
├── server/
├── shared/
└── web/

Avoid double-nesting such as resources/[standalone]/ChaosMod/ChaosMod/fxmanifest.lua.

2. Review the configuration​

Open ChaosMod/config.lua. Before starting the resource, decide if your server should run the full destructive catalog or the restricted live-safe selection.

For live RP servers, begin with:

Config.LiveSafeMode = true
Config.AllowDestructiveEffects = false
Config.WeatherEffects = false

Keep Config.Enabled = true if the timer should run automatically when the resource starts. For manual-only events, use Config.Enabled = false and trigger specific effects with admin commands.

3. Grant administrative access​

The resource requires ACE authorization for in-game chaos commands. In server.cfg, add:

add_ace group.admin chaosmod.admin allow

This grants chaosmod.admin to the existing group.admin principal. Your account must already be assigned to that group. If your server uses a different admin principal, replace group.admin with its actual name. Do not grant these commands to all players.

The server console can always execute the control commands without a player ACE assignment.

4. Start the resource​

In server.cfg, add:

ensure ChaosMod

Restart the server, or type ensure ChaosMod in the server console. Keep the folder name and ensure name identical.

5. Verify installation​

  1. Connect to the server.
  2. Look for the CHAOS MODE countdown near the top center of the screen.
  3. As an authorized administrator, use /chaos status.
  4. Run /chaos list to confirm which effects are available under your filters.
  5. For a simple test, run /chaos force miscFireworks.

The default automatic timer is two minutes between effect starts, not two minutes after every effect completes. Most timed effects last 30 seconds; others have their own defined durations.

6. Next steps​

:::note No framework dependency The resource uses FiveM natives, Lua, and a local HTML/CSS/JavaScript NUI. QBCore, ESX, ox_lib, and ox_target are not required. The chat resource is only needed if optional chat messages are enabled. :::