Installation

Requirements

  • Database: oxmysql
  • Framework: ESX / QBCore / QBOX

Quick Start

Important: Use an editor like VSCode to edit JSON files. JSON is syntax-sensitive.

Anticheat Warning: If you have an anticheat, read Anticheat Help before proceeding.

Server Setup

  1. FiveM Server Artifacts Minimum Version: 28009+

  2. Edit server.cfg and add (Order is important):

     # Give permissions to the admin menu
 add_ace resource.luxu_admin command allow
 set mumble_allowExternalConnections true
 add_unsafe_child_process_permission luxu_admin # Must be set before any resource starts! Very important

 # All your resources
 start oxmysql
 start framework

 # Luxu Admin Starts last
 start luxu_admin

    add_unsafe_child_process_permission luxu_admin Must be set before any resource starts!

Why these permissions are required

add_ace resource.luxu_admin command allow lets the resource register and run the admin menu’s own commands. It is not the same as giving every player group.admin.

add_unsafe_child_process_permission luxu_admin must be set before any resource starts. It allows Luxu Admin’s web-panel related helpers to run. Without it, the external panel and some remote tooling will fail.

After the resource starts, create staff groups in the menu and grant only the permissions each role needs. Use Discord role sync if you want Discord ranks to map to those groups.

  1. Add luxu_admin to your resources folder

  2. Configure luxu_admin/config/config.json:

    • Add your identifier (license2, fivem, or discord)
    • If the menu doesn't open, try using license2 only
    • (Optional) Choose command names - ensure they don't conflict with other scripts

    config identifier

  3. Add API keys to config/api.json:

  4. Start luxu_admin and wait for "Database installed successfully" message

  5. Restart luxu_admin

  6. In-game: Open Pause Menu → Edit Keybinds

    • All relevant keybinds should show (luxu_admin)

    keybinds

Discord Bot Setup (Optional)

The admin menu includes a Discord bot for server control and log channels.

  1. Create a new application at Discord Developers

  2. Copy the following:

    • Bot ID (client_id)
    • Bot token
    • Enable Privileged Gateway Intents
    • Your Discord server's guild ID

    discord setup

  3. Add to api.json:

    "discord_bot": {
  "enabled": true,
  "client_id": "APP ID",
  "token": "TOKEN",
  "guild_id": "SERVER ID"
}

  4. Invite the bot to your server with appropriate permissions

  5. Edit command names in luxu_admin/config/discord.json (optional)

  6. Restart luxu_admin

  7. Use /log to setup log channels (type / to see all commands)

Additional Resources

Compatibility

The admin menu includes compatibility with most popular resources. Features like "open clothing menu" rely on third-party resources. If you've added compatibility for another resource, please share the code snippets via Discord ticket.

FAQ

Q: Is this safe?

A: Yes, when you follow the guide. The ACE line authorises the resource, not every player. Restrict who can open the menu with identifiers in config.json and with staff groups. Review Discord bot scopes if you enable the bot.

Q: What frameworks does Luxu Admin support?

A: ESX, QBCore, QBOX, VRP, and partial OX core. Updated October 2026.

See the Luxu Admin product page.