Installation

Ensure ox_lib is installed and started.
Place nexra_sumo in your resources folder.
Add the following to server.cfg:

ensure ox_lib
ensure nexra_sumo

Admin access uses ACE perms. Add this to server.cfg:

add_ace group.admin nexra_sumo.admin allow

Replace group.admin with your staff group if needed. You can also grant a single identifier:

add_ace identifier.license:YOUR_LICENSE_HERE nexra_sumo.admin allow

Restart the server (or start the resource), then use /sumoadmin to place start points and arenas.

The NUI is prebuilt in web/build/ — no web build step is required on install.

Load order

Start ox_lib before nexra_sumo. Your framework, target, keys, and fuel resources should also be started before Sumo so auto-detection can find them.

Dependencies

Required

Resource	Notes
ox_lib	Required — loaded in `fxmanifest.lua`

Auto-detected

These are picked up when started. No extra config is required for common stacks.

Integration	Supported
Framework	`qbx_core`, `qb-core`, `es_extended`, `custom`, standalone
Target	`ox_target`, `qb-target`, `tgiann-target`, `sleepless_interact`, `core_focus`
Vehicle keys	`qbx_vehiclekeys`, `qb-vehiclekeys`, `wasabi_carlock`, `Renewed-Vehiclekeys`, `mk_vehiclekeys`, `cd_garage`, `okokGarage`, `mVehicle`, `vehicles_keys`, `ak47_vehiclekeys`, `0r-vehiclekeys`, `nd_core`, `custom`
Vehicle fuel	`ox_fuel`, `LegacyFuel`, `ps-fuel`, `cdn-fuel`, `qb-fuel`, `lc_fuel`, `rcore_fuel`, `Renewed-Fuel`, `ti_fuel`, `x-fuel`, `qs-fuelstations`, `okokGasStation`, `ND_Fuel`, `myFuel`, `hrs_fuel`, `BigDaddy-Fuel`, `internal`, `custom`
Notifications	`ox_lib`, `lation_ui`, `okokNotify`, `wasabi_notify`, `mythic_notify`, `brutal_notify`, `pnotify`, `t-notify`, `fl-notify`, `vms_notifyv2`, `zsx_uiv2`, `solaire_notify`, `codem-notification`, `custom`

A target resource is recommended for ped / prop start points. Press E start points work without one.

Framework support

Works with Qbox, QBCore, ESX, and standalone. For other frameworks, edit framework/custom/.

Admin access uses ACE perms.

Locales

Locale files live in locales/. Set Config.Locale in config.lua.

Included: en, de, es, fr, nl, pt-br, tr, cs

Branding

Replace the default UI logo by putting your image in the NUI build folder and pointing config at it.

Add your logo file here:

nexra_sumo/web/build/logo.png

Set the filename in config.lua:

Config.Brand = {
    logo = 'logo.png',
    name = 'Nexra Sumo',
}

Config.Brand.logo can be:

A file in web/build/ (example: 'logo.png' → web/build/logo.png)
A path inside the resource (example: 'web/build/branding/server.png')
A full https:// or nui:// URL

Config.Brand.name is the brand text shown in the UI.

Custom vehicle images

Optional. The vehicle picker uses FiveM’s default vehicle images first. To override or add custom vehicles, place images in:

nexra_sumo/web/build/vehicles/

Name each file after the vehicle spawn model:

web/build/vehicles/issi2.png
web/build/vehicles/your_custom_car.webp

Supported extensions: webp, png, jpg, jpeg, gif, bmp, svg, avif, jfif, pjpeg, pjp, tif, tiff, ico, heic, heif

Data files

Arenas and start points are stored as JSON — no SQL install is required.

File	Purpose
`data/arenas.json`	Saved arenas (zone points, spawns, default vehicle)
`data/startpoints.json`	World start points players use to open the lobby UI

A default start point and sample arena ship with the resource. Edit or replace them from the admin menu.

Editable files

These remain open for customization (escrow ignore):

config.lua
locales/*.json
server/*.lua
framework/** bridges and custom stubs
modules/**/custom/*.lua

Installation

On this page