Configuration

Which framework to use. 'auto' detects it at boot and keeps retrying until one is running. Set 'esx', 'qbcore' or 'qbox' to pin it.

Language for the panel, notifications and menus. Shipped: 'de', 'en', 'es', 'fi', 'fr', 'it', 'nl', 'pl', 'pt-br', 'tr'. Missing keys fall back to English.

Verbose lifecycle and session logging to the server console and the client console. Leave off in production.

Registers the developer subcommands of /mechanic. They also require an admin group, and the client only registers them once the server has confirmed one. Leave off on a live server.

Framework groups treated as admin. Gates the shop creator and the developer subcommands. This resource uses no ACE permissions, so this is the one place to grant access.

Jobs that may use department shops, keyed by job name. Each entry takes label (display name), minGrade (lowest grade that may open a department workshop) and defaultsMinGrade (lowest grade that may save a build as the department default for a model).

On QBCore and QBox, also require the job's on-duty flag before a department workshop opens.

Order departments are searched in when Config.Persistence.crossDepartmentDefaults lets a vehicle borrow another department's default build. Empty means the Config.Jobs keys sorted alphabetically, so the answer is the same after every restart.

The shops on your map. See the field reference below. Overlapping bays are allowed: the first shop the player may use wins, so two departments can share one garage.

Adds an ox_target option to a vehicle while it sits in a bay.

Range of that target option, in metres.

Also give the driver a key prompt while sitting in a bay.

Default key for the seated prompt. It is registered as the keybind nx_mechanic_open, so players can rebind it under Settings, Key Bindings, FiveM. The resource does not disable the horn, so on the default binding a press both honks and opens the panel.

Vehicle classes a department shop accepts. 18 is Emergency.

Extra models a department shop accepts whatever their class. A vehicle qualifies when its class is listed or its model is.

Never eligible anywhere, whatever the class says. Helicopters have no workshop.

Classes a commercial shop refuses. Commercial shops take everything else, so the class and model lists above do not apply to them. Shipped blocked: cycles, boats, helicopters, planes, emergency, trains.

Optional per-job restriction. Keyed by job name, each entry a list of models. A job with an entry may only work on those models.

Engine, brakes, transmission, suspension, armour and turbo mod slots.

Interior mod slots plus interior and dashboard colours.

Plate style and window tint.

The repair and wash buttons.

Neon strips and neon colour.

Camber, track width, ride height and wheel size and width.

The 'set as department default' action for grades at or above defaultsMinGrade.

How often stanced vehicles nearby are re-asserted. 0 means every frame while one is within distance. Nothing runs when none is near.

Metres. Stanced vehicles further away than this are left alone.

Slider ranges. Camber is in degrees, track and height in centimetres, size and width as a percentage of the fitted wheel.

Allow builds to be shared and imported as codes.

How long a code lasts. 0 means codes never expire. Expiry is worked out from when the code was made, so changing this re-dates every code you already handed out.

Allow importing a code created by another department.

Allow importing only into the model the code was made from.

Previewing a horn option sounds it once.

The Lights category turns the headlights on while it is open.

The hood opens for Performance and the driver door for Interior.

The mechanic holds a tablet while the panel is open, and its screen lists the changes made so far. Everyone nearby sees the same screen. The screen needs nx-3d; without it the prop and the animation still play.

'fixed' charges the category's price. 'percent' charges that percentage of the vehicle's value. 'combined' adds both.

ISO currency code used to format prices in the panel and in notifications.

Accounts a customer may pay from. The first is the default.

Vehicle value used for percent pricing when no vehicle shop table knows the model.

Model to value. Overrides every other source, including the framework's own vehicle price.

Price per category. Each entry takes price (fixed), percent (share of vehicle value) and optionally levelMult. See the table below.

Per mod slot price override, keyed by slot number. Slot 18 is the turbo.

How far a shop owner may raise a category price in game, as a multiple of the configured price. They may always go down to zero.

Fixed prices for the two service buttons.

Where a commercial shop's income goes. 'auto' picks the first installed banking adapter; a name from bridge/society uses that one; 'builtin' keeps the balance in nx_mechanic's own table.

How a mechanic invoices a customer. 'auto' picks the first installed billing adapter; a name from bridge/billing uses that one; 'builtin' uses nx_mechanic's own invoice book; 'off' hides invoicing entirely.

Self-service customers may leave a work order for staff instead of paying now. Needs the shop to name a job.

Who counts as staff of a commercial shop. 'framework': anyone holding the shop's job. 'builtin': only the roster hired through the tablet. Owners and managers always count.

Commercial shops that carry a price can be bought, sold and transferred in game. Selling returns 60% of the purchase price.

Which inventory holds the parts. 'auto' picks the first installed one; a name from bridge/inventory uses that one; 'none' means no inventory at all. There is no builtin: with 'none' the resource holds no items and Config.Tuning.requireItems cannot be satisfied.

How long each kind of job takes, in seconds. A cart with nothing but cosmetic changes gets the single cosmetic job.

Which job kinds ask for a skill check. Which minigame runs is decided by the skill-check adapters.

Metres a raised car lift lifts the car.

Offer dyno runs at shops that have a dyno coordinate.

Length of a run.

What a run costs at a commercial shop.

Offer the 62 chameleon paints. They need game build 2612 or newer. Turning this off hides them from the picker; a build that already carries one still shows its name.

Colour indices pinned at the top of the paint picker.

Names for vehicle extras, keyed by model then extra index. Without an entry an extra shows as 'Extra N'. The game has no name for an extra, so this is the only source.

Names for mod slots the vehicle pack left unnamed, keyed by model then slot number. The shipped default names slots 42 to 45 as callsign digits, which is what vanilla pursuit cars and several emergency packs use them for.

Names for the options inside a slot, keyed by model, then slot, then option index counting from zero. Use it when a pack ships a label with no text behind it.

Metres. How close the player must be to open the workshop.

Metres. Leaving this range ends the session.

Minimum gap between saves and service actions.

Minutes. An idle session is ended by the server after this, and the vehicle is handed back.

Fraction of the screen width the camera's aim is shifted right, so the vehicle sits centred in the space the panel leaves free. 0 centres it on screen.

Hold to hide the panels and orbit the camera freely. Releasing returns to where the camera was.

Per-model camera framing, merged over the built-in presets. Keyed by model, then focus name: overview, front, rear, side, sideR, roof, top, wheel, interior, engine. Each is { az = degrees, el = degrees, dist = multiple of the vehicle's size }.

Framework tables that also receive each save. Each entry names the table, its plate column and its props column. The shipped three cover ESX, QBCore and QBox, and sky_jobs_base.

When a driver gets into an eligible vehicle, apply the plate's build, or the department default for the model if it has none.

Also keep a vehicle record for plates no framework table knows about, such as random spawns. Off means only owned or department vehicles carry tuning, wear and stance across a respawn.

When the driver's own department has no default for the model, borrow another department's. The order is Config.DefaultPriority.

Match rows in the sync tables with a full-table string comparison instead of the indexed plate lookup. Only turn this on if your plates are stored in a shape the indexed match misses.

Audit rows older than this are pruned at start. 0 keeps them forever.

Which categories are printed to the server console. Set it to true instead of a table to print every category. Security events are always printed.

Also send events through ox_lib's logger.

Discord webhook URL and the categories sent to it. An empty URL disables it. A webhook Discord rejects is reported once and then left alone.

Title shown on the resource's notifications.

Master switch for custom tuning.

Also offer tuning in self-service shops. Off means mechanic shops only.

The mechanic must be carrying the option's item, and it is consumed on install. Needs an inventory; see Config.Business.inventory and Parts as items below.

An engine swap changes how the car sounds. Each engine's sound field is any vehicle model name.

Never tunable, whatever the shop offers. Shipped blocked: cycles, boats, helicopters, planes and trains.

Engine swaps. Shipped: I4 Turbo 2.5L (25,000), V6 3.3L (35,000), V8 6.5L (55,000), V12 6.0L (85,000), all combustion only, and a performance motor (60,000) for electric cars.

All-wheel drive (12,000), rear-wheel drive (9,000), front-wheel drive (9,000). Each sets the drive bias outright rather than scaling it.

Turbocharger (15,000), combustion only.

Close-ratio gearbox (14,000) shifts faster; long-ratio gearbox (14,000) trades acceleration for top speed.

Sport (3,500), semi-slick (6,000), slick (9,500), off-road (4,500) and drift (5,000).

Sport brakes (6,000) and ceramic brakes (14,000).

Drift tuning kit (18,000): less grip, more lateral hold and more steering lock.

Master switch for nitrous.

Fire key. Registered as the keybind nx_mechanic_nos, so players can rebind it in FiveM's key settings.

Purge key. A purge clears the line with a coloured cloud. Registered as the keybind nx_mechanic_purge, so it is rebindable too.

How long one shot lasts and how hard it pushes. Power multiplies the game's own boost.

Minimum gap between shots on one vehicle, enforced on the server.

A purge this recent makes the next shot safe.

A shot fired without a recent purge has this chance of costing that much engine health. The roll happens on the server.

Price of the kit, charged once, and the item it needs when Config.Tuning.requireItems is on.

Bottle sizes. Each entry takes id, label, shots, price and item. Shipped: small (5 shots, 2,500), medium (10 shots, 4,500), large (20 shots, 8,000). A new bottle arrives full and is charged when it changes.

Cost of topping up one missing shot.

Colours a driver may pick for the purge cloud. Each entry takes id, label and rgb. Shipped: white, blue, red, green, purple, pink. Changing the colour is free.

Classes that cannot fit nitrous: motorcycles, cycles, boats, helicopters, planes and trains. Electric cars are excluded as well.

Master switch for servicing and wear.

Percentage at or below which a part counts as due for service, in the inspection and on the tablet.

Parts at zero percent cause real failures: stalls, smoke, brake fade, misfires. Turn off to keep only the handling penalty.

Wear multiplier while the engine is above that share of its rev range.

Extra multiplier while a turbo is fitted and the revs are high.

Multiplier while a nitrous shot is running.

Crash damage. A collision above minSpeedKmh damages that many parts by between minPct and maxPct, no more often than cooldownMs. The server picks which parts and by how much.

Resources whose own damage system fights this one. While one of them is running the wear loop stays off and both consoles say so.

Run the wear loop anyway, alongside a conflicting resource. Expect the two to fight over the same car.

The parts themselves. Add, rename or remove them freely: the panel and the wear loop both read this list. See the table below.

Offer roadworthiness inspections at mechanic shops.

What an inspection costs.

How long a passing certificate stays valid.

Lowest engine health that passes, out of 1000.

Lowest body health that passes, out of 1000.

What fails a road-legal inspection: window tint indices 1 (pure black) and 2 (dark smoke), any neon, a nitrous kit, and the drift tuning category.

Jobs that may look a certificate up with /inspection.