Configuration

All configuration lives in config.lua. Staff, ranks, zones, blips, events, the whitelist and most day-to-day settings are managed in the panel and saved to the database, so this file only holds the server-wide defaults.

Debug#

Config.DEBUG = true

Turns on extra console logging. While it is on, staff can also ban themselves (useful to test the ban screen) and the /demovehicles command exists (see Commands).

Framework#

Config.Framework = "auto" -- auto | qbcore | esx | qbox

auto checks for es_extended, then qbx_core, then qb-core, and waits up to 5 seconds for one of them to start. Force a value only if detection picks the wrong one.

Server language#

Config.Locale = "en"

The language players see, loaded from locales/<locale>.json (en and sv ship with the resource). Staff can pick their own language in the panel. See Languages for how to add one.

Inventory#

Config.Inventory = 'auto'

The inventory resource items are given, removed and viewed through. auto uses the first started one of: ox_inventory, qb-inventory, ps-inventory, codem-inventory, core_inventory, origen_inventory, tgiann-inventory. Set one of those names to force it.

Notifications#

Config.Notifications = 'inbuilt' -- inbuilt | ox_lib | framework | custom

Used for the in-game notifications: report alerts, jail, zones, vehicle wipe warnings and the admin menu’s own messages.

Positions, sounds and per-staff alert settings only apply to inbuilt.

-- Config.CustomNotify = function(data)
--     exports['okokNotify']:Alert(data.title, data.body, data.duration, data.kind)
-- end

Only used with Config.Notifications = 'custom'. It runs on the client and gets one table: { kind = 'success' | 'error' | 'info', title = string, body = string, duration = milliseconds }. If it is missing or throws an error, the built-in notification is shown instead.

Currency#

Config.Currency = {
    pattern   = '$ %s',
    thousands = ',',
    account   = 'bank', -- cash | bank
}

How money is shown in the panel (player money, transactions, statistics). pattern uses %s as the number placeholder and thousands is the separator between groups of three digits. account is not used by any screen in the current version.

Admin command#

Config.Command = 'admin'
 
Config.OpenKey = 'F9'
 
Config.NoClipCommand = 'noclip'

Config.Command is the chat command that opens the admin panel. Only staff can open it. See Commands.

Config.OpenKey is the default key that opens it. Every player can change it under Settings → Key Bindings → FiveM → Open admin menu, and the key does nothing for players who aren’t staff. Set it to '' to have no default key. A player’s own choice is kept, so a new default only applies to players who never changed it.

Config.NoClipCommand is a chat command that turns noclip on or off, the same as the quick menu toggle. It only works for staff with the Quick Menu permission. Set it to '' to have no command.

The same list has a key for each quick menu toggle: noclip, freecam, god mode, invisible, player names, player blips, staff tag, coordinates, night and thermal vision, head light, super jump, infinite stamina, fast run, no ragdoll and global voice. They have no default key, so each staff member binds the ones they use. The keys do nothing for players who aren’t staff.

Staff access#

Staff members and their ranks live in the database. The tables and the default ranks (Owner, Admin, Moderator, Support) are created on first start. Manage them on the Staff page or from the server console. See Staff & Ranks.

Config.Owners = {
    -- 'fivem:123456',
    -- 'discord:123456789012345678',
}

Players listed here always have full access and are added to the top rank when they join. Any identifier works: license:, license2:, discord:, fivem:, steam:. An owner listed with a discord: identifier can also sign in to the web panel and use the Discord bot.

Config.OwnerAce = 'bablo-admin.owner'

Players with this ACE are treated like Config.Owners in game. Example for server.cfg:

add_ace group.admin bablo-admin.owner allow

Config.FirstAdminSetup = true

While nobody is staff yet, the first server admin who runs /admin becomes the first Owner. A server admin is anyone with the command ACE (txAdmin admins have it), a QBCore god or admin, an ESX admin or superadmin, or a Qbox admin. Set it to false to only allow Config.Owners, Config.OwnerAce and the console command.

Config.ConsoleCommand = 'babloadmin'

The server console command for staff management. See Commands.

Discord profile pictures#

Staff with a Discord identifier show their Discord picture. It is fetched each time they join and saved. This needs a Discord bot token in server.cfg (any bot works, it does not have to be in your Discord server):

set bablo_admin_discord_token "your bot token"

Without a token, staff show Discord’s default avatar. See Your Own Discord Bot for how to create one.

ACE mirroring#

Ranks can give ACEs and commands (the Advanced ACE rules in the rank editor). For that the resource must be allowed to change ACEs. Add these lines to server.cfg:

add_ace resource.bablo-admin command.add_ace allow
add_ace resource.bablo-admin command.remove_ace allow
add_ace resource.bablo-admin command.add_principal allow
add_ace resource.bablo-admin command.remove_principal allow

See Staff & Ranks.

Weather and time#

Config.WorldSync = 'auto'

Weather and time shown and set on the dashboard.

Server tick times#

-- Config.PerfUrl = 'http://127.0.0.1:30120/perf/'

The dashboard reads server tick times from FXServer’s /perf/ page. It tries your server’s port and 30120 on its own. Only set this when the console prints that the tick times could not be read.

Zones#

Config.Zones = {
    SpeedUnit = 'kmh',
}

SpeedUnit is the unit of a zone’s speed limit: kmh or mph. Zone behaviors (disable weapons, speed limit, freeze, announce entry, keep players out) are switched on per zone in the zone editor on the Map page. A zone can also name a custom handler that other resources react to, see State Bags, Exports & Events.

Event announcements#

Config.EventAnnouncements = true

Server events planned in the panel are announced to every player with a banner at the top of the screen when they start. How long the banner stays is set per event (“Show on screen”). Set to false to never show it.

Reports#

Config.Reports = true
Config.ReportCommand = 'report'

/report opens the player’s report window, /report <message> sends a report straight away. Staff answer under Reports in the panel. Set Config.Reports = false to turn reports off (the command is then not registered). See Reports & Media.

UI preview#

Config.UIPreview = true

true makes screens that are not connected to the server yet show built-in demo data in game (staff, permissions and your own session are always real), and enables the hidden /admin probe blur diagnostic. Set it to false once every screen you use is connected.

Remote spectate#

Config.Spectate = {
    MaxFeeds = 4,
    Fps = 30,
    Resolution = 720,
    IceServers = { 'stun:stun.l.google.com:19302', 'stun:stun1.l.google.com:19302' },
}

Used by Monitoring, the report live preview and Remote in Players: the watched player’s game view is streamed to the staff member’s panel.

Moderation#

Config.Moderation = {
    BanTokens = true,
    WarningHoldSeconds = 5,
    Appeals = true,
    AppealCooldownHours = 24,
    Flags = {
        { id = 'streamer', label = 'Streamer', colour = '#b977ff' },
        { id = 'creator', label = 'Content Creator', colour = '#00d0ff' },
        { id = 'watchlist', label = 'Watchlist', colour = '#ff3a52' },
        { id = 'newPlayer', label = 'New Player', colour = '#57ff97' },
    },
    Jail = {
        Inside = vec4(1641.62, 2570.17, 45.56, 0.0),
        Release = vec4(1846.2, 2586.0, 45.67, 270.0),
        Radius = 140.0,
    },
}

Bans are matched against every identifier the player had when banned (license, discord, steam, fivem…). The IP is only added when staff tick Also ban IP address in the ban window. A jail survives a reconnect or a server restart.

Whitelist#

Config.Whitelist = {
    Enabled = false,
    Requests = true,
    RequestCooldownHours = 24,
    ApplyUrl = '',
}

Staff always get in, even when they are not on the list.

Community service#

Config.CommunityService = {
    Center = vec4(195.17, -933.77, 30.69, 144.0),
    Radius = 55.0,
    Release = nil,
    TaskSeconds = 8,
    EscapePenalty = 2,
    Spots = {
        vec3(175.0, -943.0, 30.69),
        vec3(187.5, -951.0, 30.69),
        vec3(200.0, -958.0, 30.69),
        vec3(213.0, -946.0, 30.69),
        vec3(220.0, -930.0, 30.69),
        vec3(208.0, -915.0, 30.69),
        vec3(191.0, -906.0, 30.69),
        vec3(176.0, -915.0, 30.69),
        vec3(168.0, -930.0, 30.69),
        vec3(198.5, -934.5, 30.69),
    },
}

Staff give a player a number of tasks from the Jail button on a player (Community service tab). The player is sent to Center and walks to the marked Spots, pressing E to sweep each one.

A sentence carries over a reconnect or a server restart.

Screenshots and clips#

Config.Media = {
    Enabled = true,
    Provider = 'server',
    KeepDays = 30,
    MaxClipSeconds = 30,
    StopKey = 'F11',
}

See Reports & Media.

Database backups#

Config.Backups = {
    Enabled = true,
    EveryHours = 168,
    Keep = 7,
}

Saves a full copy of the server database as a .sql.gz file in the backups folder of the resource.

EveryHours and Keep are only the starting values. Once they are changed in Settings → Database backups, the panel values are used. See Database Backups.

Polls#

Config.Polls = {
    Enabled = true,
    Command = 'poll',
}

Staff with the Polls permission start a poll from the Polls page. Every player gets a card in game and opens the poll with the command to vote. Set Enabled = false to turn polls off. See Reports & Media.

Ban screen#

Config.BanScreen = {
    Card = true,
    ServerName = '',
    AppealUrl = '',
    LogoUrl = '',
    HoldSeconds = 300,
}

A styled card (a FiveM Adaptive Card) shown every time a banned player tries to join: reason, ban ID, who banned them, the date and when it runs out.

A kicked or banned player leaves the server at once with a plain text message, because FiveM’s own “Disconnected” popup can only show plain text. The styled screen comes when they try to join again.

Kick screen#

Config.KickScreen = {
    Card = true,
    Minutes = 10,
}

Shown once when a kicked player joins again within Minutes: reason, who kicked them and when, with Join server and Leave buttons. Card = false lets them straight back in. The card closes by itself after Config.BanScreen.HoldSeconds and then lets the player in.

Players tab bridges#

Config.Appearance = 'auto'

The clothing resource behind Clothing (opens the player’s clothing menu) and Reload skin. auto picks the first one that runs: illenium-appearance, fivem-appearance, bl_appearance, crm-appearance, rcore_clothing, codem-appearance, tgiann-clothing, qb-clothing, esx_skin, skinchanger. Each one is a small file in src/appearances; copy one to add another resource.

Config.VehicleKeys = 'auto'

Key resource used when staff give keys or spawn a vehicle for a player: qbx_vehiclekeys, qb-vehiclekeys, wasabi_carlock, qs-vehiclekeys, Renewed-Vehiclekeys or cd_garage (files in src/vehiclekeys).

Config.Banking = 'auto'

Where the Transactions window reads a player’s bank history: bablo-banking, Renewed-Banking, okokBanking or qb-banking (files in src/banking).

Sounds#

Config.Sounds = {
    Announcement = { name = 'Event_Message_Purple', set = 'GTAO_FM_Events_Soundset' },
    Message = { name = 'Text_Arrive_Tone' },
    Warning = { name = 'Boss_Message_Orange', set = 'GTAO_Boss_Goons_FM_Soundset' },
}

GTA frontend sounds players hear for a staff announcement or event start (Announcement), a message from staff (Message) and a warning (Warning). Give the sound name and its set (leave set out for sounds without one). Set one to false to play nothing.

Give vehicle garage#

Config.GiveVehicleGarage = { car = 'pillboxgarage', air = 'intairport', sea = 'lsymc' }

The garages that Give vehicle puts a new vehicle in on QBCore and Qbox. Helicopters and planes go to air, boats and submarines to sea, everything else to car. Use garage names from your garage script; the defaults exist in qb-garages and qbx_garages. On start the console warns if one of them doesn’t exist. A single name like 'pillboxgarage' still works and is used for every vehicle type.

Send to garage and Release from the impound also use these garages when a vehicle has no garage saved or still points at a depot.

Impound#

Config.ImpoundLot = 'los_santos'

How Impound works depends on the framework:

Impound is not offered when jg-advancedgarages is running, or on ESX servers without esx_garage.

Vehicle pictures#

Config.VehicleImageUrl = 'https://assets.babloresources.com/vehicles/%s.webp'

Pictures in the Vehicles tab, the player view and owned vehicles. Your own picture in images/vehicles, named after the spawn code (for example images/vehicles/sultanrs.webp; .png, .jpg and .gif work too), is used first and shows after a resource restart. Every other vehicle loads from this address, where %s is the spawn code in lower case (the same name in capitals is tried when that is missing). Set it to false to only use your own pictures.

Hidden vehicles#

Config.HiddenVehicleCategories = { 'planes', 'helicopters', 'boats', 'military', 'industrial', 'openwheel' }
Config.HiddenVehicleModels = {
    'trailers5', 'tvtrailer2',
    'freight', 'metrotrain', 'cablecar',
    'polmav', 'predator', 'seashark2',
    'cerberus', 'phantom2', 'boxville5', 'oppressor', 'ruiner2', 'deluxo', 'stromberg', 'toreador', 'jb7002',
    'imperator', 'imperator2', 'imperator3', 'dominator4', 'impaler2', 'impaler3', 'impaler4',
    'issi4', 'issi5', 'issi6', 'deathbike', 'deathbike2', 'deathbike3',
}

Vehicles left out of the Vehicles tab. Categories are the framework vehicle categories (QBCore shared/vehicles.lua category), models are spawn codes. A vehicle a player owns is always listed, and hidden vehicles can still be spawned and given by spawn code. Use {} to list everything.

Quick menu#

Config.QuickMenu = {
    Command = 'quickmenu',
    OpenKey = 'F10',
    CursorKey = 'ALT',
    FreezeKey = 'G',
    DeleteKey = 'DEL',
    InspectorRange = 50.0,
    StaffTagRange = 30.0,
    HealthBarColour = 18,
    NoclipSpeed = 50.0,
    NoclipFastSpeed = 240.0,
    NoclipInfoKey = 'H',
    DebugRange = 20.0,
    DebugLimit = 8,
}

The quick menu opens with the Open Quick Menu key from Settings → Keybinds (each staff member picks their own) or the command. Its toggles last for the session: leaving or a resource restart switches them all off.

Teleport locations#

-- Config.TeleportLocations = {
--     { id = 'legion', label = 'Legion Square', coords = vec4(195.17, -933.77, 29.7, 144.5) },
-- }

Places offered in the teleport window. Leave it commented out to use the built-in list (Legion Square, Pillbox, Mission Row, the airport, the Vinewood sign, Sandy Shores, Paleto Bay and Mount Chiliad). When you set it, your list replaces the built-in one.

Your own logos#

The menu’s logos are two image files in the main bablo-admin folder, next to config.lua. Replace them with your server’s logo and restart the resource.

You can use .webp, .png, .jpg, .gif or .svg; keep the name, for example logo_icon.png. Logos are fitted into their spot without being cropped. Use a white or light logo on a transparent background: it sits on dark pictures. Delete a file to get the Bablo logo back.

The web panel shows your logos too. After you replace one, the web panel can take up to an hour to show the new picture.