How to Install a FiveM Script (Step-by-Step for QBCore & ESX)

Installing a FiveM script is one of the first skills every server owner needs, and once you've done it a few times it becomes second nature. Here's a clear, general step-by-step that works for most scripts on both QBCore and ESX. Always follow the script's own README too, since specifics vary.

Step 1: Get the resource into your resources folder

Your server has a resources folder (often organized into subfolders like [qb], [esx], [standalone]). To install a script:

1. Download and unzip the resource.
2. Make sure the folder name is correct — some scripts require an exact name (check the README). Don't rename a resource unless told it's safe.
3. Place the folder inside your resources directory, ideally in a sensible subfolder like [custom] or [scripts].

If the resource came as a nested zip (a folder inside a folder), make sure you place the actual resource folder — the one containing fxmanifest.lua — not a wrapper folder.

Step 2: Add it to server.cfg

Your server only starts resources you tell it to. Open server.cfg and add an ensure line:

ensure resource-name-here

Use the exact folder name. Placement matters for dependencies — a script that needs your framework must be ensured *after* the framework, and anything needing ox_lib must come after ox_lib.

Step 3: Run the SQL (if the script has a database)

Many scripts store data and include a .sql file. If so:

1. Open your database tool (phpMyAdmin, HeidiSQL, or similar).
2. Select your server's database.
3. Import or run the provided .sql file.

Skipping this step is one of the most common install mistakes — the script loads but errors or does nothing because its database tables don't exist.

Step 4: Check dependencies

Confirm the script's dependencies are installed and started first. Common ones:

• oxmysql (database access)
• ox_lib (shared library)
• ox_inventory / ox_target (if the script integrates with them)
• Your framework (qb-core or es_extended)

A missing dependency is the second most common reason a fresh install fails.

Step 5: Configure it

Open the script's config.lua (or config folder) and set it up for your server — prices, locations, jobs, keybinds, language. Good scripts have a clear, commented config. Take a moment here; the defaults may not match your server.

Step 6: Start and test

Restart your server (or start the resource live with ensure resource-name / start resource-name in the console). Then:

1. Watch the server console as it starts — errors show here immediately.
2. Join and test the feature.
3. If something's wrong, read the console error first — it usually names the problem.

Common install problems

• "Resource won't start" — check the folder name matches the ensure line and fxmanifest.lua is present.
• Script loads but does nothing — you probably skipped the SQL, or a dependency isn't loaded.
• Errors mentioning another resource — a dependency is missing or loading in the wrong order.
• Nested folder issue — you placed a wrapper folder instead of the actual resource folder.

A repeatable routine

Once you've done a few, the rhythm is: drop in the folder → ensure it → run the SQL → check dependencies → configure → restart → watch the console → test. Follow that every time and installs go smoothly.

At Viper Development, every script ships with clear installation documentation and a well-commented config, so setup is painless — and if you get stuck, our Discord support is there. Browse our scripts →