Installation

Download & unzip

Unzip the jg-mechanic-bundle and open it - the folders inside are the resources for your server.

Add the resources to your server

Drag all 4 folders (jg-mechanic, jg-mechanic-props, jg-vehiclemileage and jg-textui) into a new folder called [jg] within your server's resources folder.

If you don't plan on using our new default Text UI, you don't need to transfer it to your server. You can choose a different Text UI script in the config.

Update your server.cfg

In your server.cfg, add a new line after all your other resources have started:

ensure [jg]

Set up inventory items

Navigate into the install folder, and then into the inventory folder. Follow the guide for your chosen inventory - the item images are in the images folder.

When updating jg-mechanic, remove the old resource folder and replace it with the complete folder from the latest download. Don't copy new files over the old folder. Start with the new config files, then carefully copy your existing values into them. Mixed old and new files can cause callback errors and break locations, modifications or UI flows.

If something stops working after an update, test a clean copy of the latest resource with its default config before adding your changes again.

Inside the config folder, config.lua is the core configuration - most integrations (framework, text UI, notifications and more) are automatically detected. The main things to customise are mechanic locations, core pricing, servicing and tuning options.

The 3 other config files fine-tune how cosmetics, servicing & tuning work in your city. They are heavily commented, but can be a little complicated - only modify them if you're comfortable with Lua. See Pricing, Servicing and Tuning before changing those files.

Set up jobs and banking

Follow Job Setup for every owned mechanic location.

If Config.UseFrameworkJobs = true, set up employee management through your framework's boss menu or a compatible third-party boss menu. JG Mechanic doesn't show its built-in Management app when you use framework jobs.

If Config.UseFrameworkJobs = true, create a society bank account for every unique mechanic job before taking work orders. JG Mechanic doesn't create accounts in third-party banking resources.

Video Installation Guide

Scorpion from the JG Scripts community has created a detailed installation guide, including configuration & inventory setup for QB, Qbox & ESX.

Troubleshooting/mechanic/troubleshooting

Strict statebag mode

Strict statebag mode prevents clients from changing shared state. JG Mechanic's servicing, nitrous and paid modification changes are handled by the server.

Update both resources

Update jg-mechanic and jg-vehiclemileage together. Keep your existing config values and ensure OneSync is enabled. Start jg-vehiclemileage before jg-mechanic.

Enable strict mode

Add this to server.cfg:

server.cfg

setr sv_stateBagStrictMode true

Other resources on your server must support strict statebag mode too.

Restart and check

Fully restart your server. Connect a vehicle through the tablet, open Work Orders and test a servicing or nitrous installation. Drive the vehicle and check that mileage increases without client statebag warnings.

Custom integrations must not call Mechanic's generic client statebag setters. Garage restores use saved server data. For custom server-side changes, use setVehicleStatebagProperties.