Skip to main content

How to Install a Script

Step-by-step guide to installing a Code9 Studio script on your FiveM server.

This section

How to Install a Script

Once you've downloaded a script from the Cfx.re portal, follow these steps to install it on your server. Every Code9 product uses the same installation flow — only dependencies and database setup vary per script.

1. Extract the archive

Unzip the downloaded .zip into a temporary folder. Inside you'll find a folder named like code9_mechanic (the actual name depends on the product — e.g. code9_carPlay, code9_shop).

2. Copy to your server's resources folder

Move the extracted folder into your server's resources/ directory:

text
my-server/
├── resources/
│ ├── [other resources]
│ └── code9_mechanic/ ← here
└── server.cfg

3. Add to server.cfg

Open server.cfg and add an ensure line for the resource. Place it after any of its dependencies (framework, ox_lib, etc.):

text
ensure ox_lib
ensure oxmysql
ensure code9_mechanic

4. Import the database (if applicable)

Scripts that persist data (e.g. Mechanic, Shop, CarPlay, Multicharacter) ship with a data.sql file. Import it into your MySQL database once, before starting the resource.

The per-script Installation page documents whether a SQL file exists and what table names it creates.

5. Configure the script

Open shared/config.lua (path varies per script) and set:

  • Your framework (ESX / QBCore / QBox / Standalone — each script declares what it supports).
  • Your inventory system.
  • Any script-specific toggles (locations, permissions, UI strings, etc.).

Every Code9 script is fully config-driven — you never need to touch code.

Each script's Development → Config Files section under Scripts documents every option in detail.

6. Start the server

Restart your FiveM server — or, if it's already running, restart just the new resource from the server console:

text
restart code9_mechanic

7. Verify it's running

Watch the server console. A successful start prints something like:

text
Started resource code9_mechanic

If the resource fails to start, scroll back through the console — the first error line usually tells you which dependency is missing or which config value is wrong.

Common follow-ups