Skip to content

config.lua

Initial defaults. Most of these are also editable live in the panel (under Server config); whatever the panel saves wins on next boot, via the lo_settings overlay.

This page lists what's in the file. Comments in the file itself describe each key in more detail.

General

KeyWhat
Config.DebugVerbose console logging.
Config.LogLevel'trace' | 'debug' | 'info' | 'warn' | 'error' | 'off'.
Config.VersionCheck{ enabled, repo, branch, updateUrl } — checks GitHub for newer versions on boot.
Config.CommandChat command to open the panel. Default 'jobcreator'.
Config.ActionMenuKeyKey for the personal-action menu (the one referenced in your KeyMapping).
Config.LangDefault server language ('en', 'fr', …).
Config.PermissionGroupGroup(s) allowed to open the panel. String or table.
Config.ButtonPermissionsPer-tab permissions (empty = inherit PermissionGroup). See Permissions.
Config.ImageUrlTemplate URL for item images.

Placement

KeyWhat
Config.PlacementMode'raycast' (default) or 'gizmo' (requires jo_libs).

Framework

KeyWhat
Config.Framework.force'auto' | 'vorp' | 'standalone'. Override the runtime detection.
Config.Framework.entityExportsOptional: route job / gang upsert / delete to a third-party resource.
Config.Framework.clothingEvents fired by clothing_store / clothing_wardrobe interactions.
Config.Framework.notifyOptional notification event override.

UI providers

KeyWhat
Config.AllowInGamePreferencesLet non-admin players change their own providers / language.
Config.DefaultMenuProvider'auto' | 'ox_lib' | 'vorp' | 'jo_libs' | 'native'.
Config.DefaultInputProviderSame set.
Config.DefaultProgressProviderSame set.
Config.DefaultInteractionMode'target' (ox_target) or 'prompt' (floating prompts).

Features (tab toggles)

Config.Features — set any of these to false to hide the tab entirely:

jobs, gangs, publicActions, itemCreator, customBlips, customPeds, customVehicles, customHorses, staffTools, preferences, personalmenu.

Logging (Discord)

KeyWhat
Config.Logs.enabledMirror audit log to Discord.
Config.Logs.webhookWebhook URL.
Config.Logs.servernameEmbed author.name.
Config.Logs.colorEmbed color.

Paycheck

KeyWhat
Config.Paycheck.enabledMaster on/off.
Config.Paycheck.intervalms between payments.
Config.Paycheck.logLog every paycheck to audit + Discord.
Config.Paycheck.banking{ enabled, resource, fn } to route money into a banking resource.
Config.Paycheck.bossAccount{ resource, getAccountFn, removeMoneyFn } — read / debit a job's business account.
Config.Paycheck.gangAccountSame, for gangs.
Config.Paycheck.governmentTypesJob types paid by the state (no account check).

Performance

Config.Performance:

  • markerRenderDistance — meters
  • pedRenderDistance, maxRenderedPeds
  • propRenderDistance, maxRenderedProps
  • targetRefreshInterval — ms, ox_target rescan
  • connectedPlayerRefreshInterval — ms, fallback job re-read
  • updateDebounce — ms, panel → clients sync debounce
  • pedFaceOnApproach, pedFaceDistance

See Performance for recommended values.

Defaults

KeyWhat
Config.DefaultGradesAuto-created grades for a new job ({ '0' = {...}, '1' = {...}, … }).
Config.EntityTypesAvailable job categories (leo, medic, fire, gouv, …).
Config.InteractionTypesThe built-in interaction types' metadata (label, icon, isPublic).
Config.ActionsDefault personal-action templates.

Towns & regions

  • Config.Towns — list of towns (name, city, region, icon).
  • Config.Districts — list of districts (same shape).
  • Config.JobRegions — defaults: which regions a known job covers (loaded into new jobs on creation).

Catalogues

  • Config.AvailableMarkers — the 3D markers admins can pick from.
  • Config.PopularBlips — curated blip list for the blip picker.
  • Config.BlackListedStorageItems — items that can't be put in a stash.

Item images

KeyWhat
Config.ItemImagePathAbsolute path to vorp_inventory/html/img/items/. Required if your VORP install is under a [brackets] folder and image uploads fail.

Keys

Config.Keys and Config.UsableKeys map prompt labels and game controls used by various interactions. The exact prompt labels are localized; the controls are RedM control hashes.

Released under a commercial license. Documentation released under MIT.