Installation Guide
Complete installation instructions for Oxide Menu.
Prerequisites
| Requirement | Version | Notes |
|---|---|---|
| FiveM Server | Latest | Recommended: Latest artifacts |
| QBCore Framework | Latest | Required dependency |
qb-inventory | Any | Optional: For item icon resolution |
Fresh Installation
Download
Download the oxide-menu resource and extract it to your resources folder.
Server Configuration
Add the resource to your server.cfg:
# After qb-core
ensure qb-core
# Oxide Menu
ensure oxide-menuRemove qb-menu
If you're replacing qb-menu, disable or remove it:
# Comment out or remove
# ensure qb-menuOxide Menu supports the qb-menu data format. You must update export names from 'qb-menu' to 'oxide-menu' in your scripts, but the menu data structure stays the same.
Configure
Edit config.lua to customize the menu behavior:
Config.Theme = 'oxide' -- Visual theme
Config.Position = 'right' -- Default position
Config.Debug = false -- Set true to enable demo commandsSee Configuration for all options.
Migration from qb-menu
Oxide Menu supports the qb-menu data format with a simple export name change.
Backup
Always backup before making changes:
- Export your current resource folder
- Note any custom modifications to qb-menu
Replace Resource
- Remove or rename your existing
qb-menufolder - Add
oxide-menuto your resources - Update
server.cfg:
# Replace this:
# ensure qb-menu
# With this:
ensure oxide-menuUpdate Export Names
Find and replace in your scripts:
-- Change this:
exports['qb-menu']:openMenu(...)
exports['qb-menu']:closeMenu()
exports['qb-menu']:showHeader(...)
-- To this:
exports['oxide-menu']:openMenu(...)
exports['oxide-menu']:closeMenu()
exports['oxide-menu']:showHeader(...)The menu data you pass to these functions stays the same.
The legacy event still fires for compatibility:
AddEventHandler('qb-menu:client:menuClosed', function()
-- Still triggers
end)Verify
Test your existing menus to ensure they display correctly. See Verification below.
Verification
Check Resource Started
In server console or F8:
ensure oxide-menuIf debug mode is enabled (Config.Debug = true), you'll see:
[oxide-menu] Debug mode enabled - Demo commands: /oxidemenu through /oxidemenu11If no message appears, the resource is running in production mode (normal).
Test Demo Commands
Enable debug mode temporarily:
Config.Debug = trueThen test in-game:
/oxidemenu -- Should show character options menu
/oxidemenu3 -- Should show interactive elementsTest Existing Scripts
After updating the export names, open any menu from your scripts. They should display with the new Oxide Menu styling.
Troubleshooting Installation
| Issue | Solution |
|---|---|
| Menu doesn't appear | Check F8 console for errors. Ensure resource started. |
| NUI errors | Clear FiveM cache: %localappdata%/FiveM/FiveM.app/data/cache |
| Exports not found | Ensure oxide-menu starts after qb-core in server.cfg |
| Styling broken | Verify all CSS files exist in html/css/ folder |
See Troubleshooting for more solutions.