Configuration
Config options for Nexra Sumo.
All options are in config.lua.
| Option | Default | Description |
|---|
Config.Debug | false | Extra server logging; also allows starting a match with 1 player |
Config.Locale | 'en' | Locale file from locales/ |
Config.Brand.logo | 'logo.png' | Logo file in web/build/ (see Installation) |
Config.Brand.name | 'Nexra Sumo' | Brand name shown in the UI |
| Option | Default | Description |
|---|
Config.AdminCommand | 'sumoadmin' | Admin menu command |
Config.UseAdminCommand | true | Enable the admin command |
Config.AdminAce | 'nexra_sumo.admin' | ACE permission checked for admin access |
| Option | Default | Description |
|---|
Config.DefaultBucket | 0 | Bucket players return to after a match |
Config.BucketBase | 7000 | Starting bucket ID for new lobbies |
Each lobby gets its own bucket (BucketBase, then incrementing) so matches stay isolated.
| Option | Default | Description |
|---|
Config.Match.countdownSeconds | 5 | Countdown before a round starts |
Config.Match.minPlayers | 2 | Minimum players required to start |
Config.Match.announcementDuration | 3500 | Announcement display time (ms) |
Config.Match.roundEndDuration | 10000 | Round / match results display time (ms) |
Hard caps applied when creating or editing lobbies.
| Option | Default | Description |
|---|
Config.LobbyLimits.maxNameLength | 32 | Max lobby name length |
Config.LobbyLimits.minPlayers | 2 | Minimum max-players value |
Config.LobbyLimits.maxPlayers | 32 | Maximum max-players value |
Config.LobbyLimits.minRounds | 1 | Minimum rounds |
Config.LobbyLimits.maxRounds | 10 | Maximum rounds |
Defaults used when a player creates a lobby.
| Option | Default | Description |
|---|
Config.LobbyDefaults.namePrefix | 'Arena Lobby' | Auto name prefix |
Config.LobbyDefaults.maxPlayers | 8 | Default max players |
Config.LobbyDefaults.rounds | 3 | Default round count |
Config.LobbyDefaults.showZoneDebug | true | Show zone outline during the match |
Config.LobbyDefaults.forceFirstPerson | false | Force first-person camera |
Config.LobbyDefaults.allowSpectators | true | Allow spectating |
Config.LobbyDefaults.isPrivate | false | Default private lobby setting |
| Option | Default | Description |
|---|
Config.StartPointsFile | 'data/startpoints.json' | Start points save path |
Config.StartPointTarget.icon | 'fas fa-flag-checkered' | Target icon |
Config.StartPointTarget.label | 'Open Sumo Lobby' | Target / interaction label |
Config.StartPointTarget.distance | 2.0 | Target interaction distance |
Config.StartPointTarget.radius | 1.5 | Target zone radius |
Config.StartPointDefaults.label | 'Open Sumo Lobby' | Default point label |
Config.StartPointDefaults.pedModel | 's_m_m_highsec_01' | Default ped model |
Config.StartPointDefaults.pedScenario | 'WORLD_HUMAN_CLIPBOARD' | Default ped scenario |
Config.StartPointDefaults.targetModel | 'prop_tennis_ball' | Default prop for target points |
Config.StartPointDefaults.targetRadius | 1.5 | Default target radius |
Config.StartPointDefaults.interactDistance | 2.0 | Press E / interact distance |
Config.StartPointDefaults.drawDistance | 20.0 | Marker / prompt draw distance |
| Option | Default | Description |
|---|
Config.ArenasFile | 'data/arenas.json' | Arenas save path |
Config.ArenaDefaults.name | 'New Arena' | Default arena name |
Config.ArenaDefaults.thickness | 6.0 | Default zone thickness |
Config.ArenaDefaults.vehicleModel | 'issi2' | Default match vehicle |
Config.ArenaDefaults.maxPoints | 24 | Max zone polygon points |
Config.ArenaDefaults.maxSpawns | 32 | Max spawn points |
Used when cancelling in-world placement / progress.
| Option | Default | Description |
|---|
Config.Progress.cancelControl | 73 | Control index (default X) |
Config.Progress.cancelKey | 'X' | Displayed cancel key |
Integrations auto-detect from started resources. To force a provider, set it in config.lua:
Config.Providers = {
framework = 'qb-core', -- or qbx_core / es_extended / custom
target = 'ox_target',
vehiclekeys = 'qb-vehiclekeys',
vehiclefuel = 'ox_fuel',
notifications = 'ox_lib',
}
