Core
The main settings file: tablet, feature switches, admins, commands, logs and blips.
General
| Setting | Default | What it does |
|---|---|---|
Debug | false | Prints extra debug messages in the server and F8 console. Leave off on a live server |
UtcOffset | 0 | Hours to shift the script's clock to your time zone (decimals allowed, e.g. 5.5). Affects every time window (raids, turf activity, airdrops) and daily stats |
PoliceJobs | police, sheriff, bcso, sasp, lspd | Jobs counted as police: they get alerts, can raid hideouts, and can't sell on corners. On QBCore / Qbox, any job with the type leo also counts |
Tablet
| Setting | Default | What it does |
|---|---|---|
Tablet.Command | 'gangtablet' | Chat command that opens the tablet. false removes it |
Tablet.Item | 'gang_tablet' | Usable item that opens the tablet. false turns this off |
Tablet.Keybind | false | Set to a key like 'F9' to add a rebindable key. Needs Tablet.Command to be set |
Tablet.Animation.dict / clip | Tablet idle animation | Animation played while the tablet is open. Remove to play none |
Tablet.Animation.prop.model | 'prop_cs_tablet' | Prop held in the hand. Remove prop for no prop |
Tablet.Animation.prop.bone | 28422 | Bone the prop attaches to (right hand) |
Tablet.Animation.prop.pos / rot | offsets | Position and rotation of the prop in the hand |
Tablet.Currency.code | 'USD' | Currency shown on money, e.g. 'EUR', 'GBP' |
Tablet.Currency.locale | 'en-US' | Number format, e.g. 'de-DE' for 1.000,00 |
Desk & interface
| Setting | Default | What it does |
|---|---|---|
ManageFromTablet | false | true lets gangs use the Organisation pages (members, treasury, upgrades…) from the tablet anywhere. false means only at the hideout desk |
KeyHints | 'kartik' | On-screen key prompts: 'kartik' for the built-in panel, 'ox' for ox_lib text UI |
LockDesk | false | true lets only one member use a gang's desk at a time |
Branding
| Setting | Default | What it does |
|---|---|---|
Branding.Enabled | true | Let gangs change their colour, logo, banner and plate prefix from the tablet (rank permission branding) |
Branding.CooldownMinutes | 10 | Wait between branding changes |
Limits
| Setting | Default | What it does |
|---|---|---|
Limits.MaxRanks | 10 | Most ranks a gang can ever have. Upgrades can't go above this |
Limits.MaxMembers | 30 | Most members a gang can ever have. Upgrades can't go above this |
Limits.AliasMin | 3 | Shortest alias allowed |
Limits.AliasMax | 20 | Longest alias allowed |
Limits.InviteSeconds | 60 | How long an invite stays open |
Limits.InviteDistance | 10.0 | Maximum distance between inviter and player. The invite list itself shows players within 8 m |
Features
Turn whole systems on or off. Every feature is true by default. Turning one off also hides its tablet and admin pages.
| Setting | Turning it off removes |
|---|---|
Features.Market | Underground market and /marketclaim |
Features.Wars | Gang wars |
Features.DarkChat | Dark chat |
Features.Ranking | Leaderboards |
Features.SeasonPass | Season pass |
Features.Contracts | Contracts |
Features.Turfs | Turfs and influence |
Features.Hotspots | Hotspots |
Features.Graffiti | Graffiti |
Features.Racketeering | Rackets |
Features.Corners | Corner selling. Turn off if you use another drug script |
Features.Raids | Police raids |
Features.Laundering | Money laundering |
Features.Medic | Black medic |
Features.Airdrops | Airdrops |
Features.Surveillance | Spy gear |
Features.Restraints | Tie up and head bags. Turn off if you use another restraint script |
Features.Furniture | Hideout furniture |
Features.Garage | Gang vehicles, dealership and garages |
Features.Stash | Gang stash and storage furniture |
Features.Wardrobe | Gang wardrobe |
Features.DailySpin | The daily spin prize wheel |
Don't delete SeasonPass from the list. Removing that line turns the season pass off, while the other features stay on when their line is missing.
Commands
Command names. Set any to false to remove it.
| Setting | Default | What it does |
|---|---|---|
Commands.Admin | 'gangadmin' | Opens the admin panel |
Commands.SetGang | 'setgangmember' | /setgangmember [id or citizen id] [gang id] [rank] adds a player to a gang |
Commands.RemoveMember | 'kickgangmember' | /kickgangmember [id or citizen id] removes a player from their gang |
Commands.GiveVehicle | 'giveganggarage' | /giveganggarage [gang id] [model] gives a gang a vehicle |
Commands.ResetStats | 'resetgangstats' | /resetgangstats [gang id] resets one gang's stats, or all gangs if no ID |
Commands.FurnitureImages | 'gangfurnitureimages' | Generates furniture shop images. Add force to redo all, stop to cancel. In game only |
Commands.TurfAttack | 'turfattack' | /turfattack [turf name or id] starts an NPC attack on a turf, /turfattack stop ends every attack |
Commands.CreateGang | 'creategang' | Players: apply for a new gang |
Commands.GangRequests | 'gangrequests' | Admins: approve or decline gang requests |
Gang registration
Lets players apply for their own gang. Full guide: Gang Registration.
| Setting | Default | What it does |
|---|---|---|
Registration.Enabled | true | Turns registration on or off. Without the block it is off |
Registration.Approval | true | true: an admin approves every request. false: the gang is created as soon as the player applies |
Registration.Fee | 50000 | Price to apply, given back if the request is declined or cancelled. 0 makes it free |
Registration.Account | 'bank' | Where the fee is paid from: 'cash' or 'bank' |
Registration.Item | false | Item needed to apply, e.g. 'gang_papers'. One is taken and given back like the fee |
Registration.MaxPending | 20 | Most requests waiting at the same time |
Registration.CooldownMinutes | 60 | Wait after a declined request |
Registration.NameLength | { 3, 24 } | Shortest and longest gang name (at most 32) |
Registration.NoteLength | 200 | Longest "about your gang" text |
Admins
| Setting | Default | What it does |
|---|---|---|
Admins | empty | Extra admins, by identifier or citizen ID, e.g. ['license:abc123'] = true |
Framework admins and the kartikgangs.admin ace also count. See Admin Access.
Dispatch & logs
| Setting | Default | What it does |
|---|---|---|
Dispatch.Mode | 'server' | 'server': the server sends police alerts, so players can't block them. 'client': the criminal's game sends them |
Logs.DrugSales | true | Log every drug sale to the general webhook |
Logs.Robberies | true | Log robberies to the general webhook |
Logs.TurfAbandoned | true | Log abandoned turfs to the general webhook |
Rivalries and turf owner changes are always logged.
Gang activity log
Extra entries in each gang's activity log (tablet Activity page, admin gang Activity tab, and the gang's Discord webhook if set).
| Setting | Default | What it does |
|---|---|---|
ActivityLog.DrugSales | true | Log every drug sale by a member |
ActivityLog.StashOpened | true | Log stash opens, at most once per 5 minutes per member |
ActivityLog.StashItems | true | Log items put in and taken out of gang stashes. ox_inventory only |
With no dispatch script, officers get a notification and a map blip for 90 seconds.
Webhooks
Paste Discord webhook URLs. Leave empty to turn a channel off.
| Setting | Logs |
|---|---|
Webhooks.general | Treasury moves, upgrades, pass unlocks, drug sales, robberies, turf changes, dark chat |
Webhooks.admin | Every admin panel action |
Webhooks.wars | Wars starting and ending |
Webhooks.raids | Raids pending, starting, ending and money seized |
Webhooks.market | Listings, purchases and admin removals |
The general webhook also gets tier promotions and weekly / monthly leaderboard results. Each gang can also have its own webhook for its activity log, set in Admin → Gangs → [gang].
Blips
| Setting | Default | What it does |
|---|---|---|
Blips.Hideout.sprite | 492 | Map icon for the gang hideout |
Blips.Hideout.color | 1 | Blip colour |
Blips.Hideout.scale | 0.8 | Blip size |
Blips.Hideout.label | 'Gang Hideout' | Blip name |
Blips.ShowHideoutToMembers | true | Show members their own hideout on the map. Other gangs never see it |
Guards leave alone
NPC guards (contracts and airdrops) never shoot these players. Guards already shooting at one of them stop.
GuardExempt = {
Downed = true, -- downed / dead players
Jobs = { ambulance = true, ems = true }, -- these jobs...
RequireDuty = true, -- ...only while on duty
},| Key | Default | What it does |
|---|---|---|
GuardExempt.Downed | true | Guards stop shooting players who are downed or dead |
GuardExempt.Jobs | { ambulance = true, ems = true } | Jobs guards never attack. Add your server's EMS job names |
GuardExempt.RequireDuty | true | Only protect those jobs while on duty |