Skip to content

Installing a FiveM Resource

Before installing a FiveM resource, read its requirements, prepare a development copy, review database changes, check startup, and test the intended player interaction. A resource starting successfully is one check; it does not establish that the feature works.

Use the resource author’s instructions alongside this checklist. Two scripts with similar features can need different frameworks, dependencies and database steps.

Download the three-page installation checklist (PDF)

1. Check requirements before copying files

Section titled “1. Check requirements before copying files”

Read the README and inspect fxmanifest.lua. The manifest can declare resources that must load first and runtime requirements such as a minimum server build. Check these against the author’s installation instructions. Cfx.re manifest reference

Record the exact resource release, framework version, required dependencies, database steps and configuration changes. A framework name alone does not prove compatibility with your installed versions or integrations.

Keep the original archive and documentation so you can identify what you installed if you need help later.

Use a development server before introducing the resource to players. Confirm that its database connection points to a separate test database: copying server files while retaining the live connection does not isolate the test.

Back up the files you expect to change and prepare appropriate database recovery before running SQL. Note the starting configuration.

Choose a concrete behavior to test. For a job resource, that might be opening a particular menu as a character with the expected job and grade. Write down the expected result before changing anything.

If SQL is included, determine whether it is for a fresh installation or an upgrade. Confirm the destination database and affected tables.

If a statement fails, check whether earlier statements already changed the database before trying again. Repeatedly importing the same file can obscure the original problem. Follow the author’s order and resolve unclear or destructive changes before proceeding.

A saved Lua file cannot restore database contents. Keep file recovery and database recovery separate.

Once dependencies, database work and configuration are ready, check what the development server can load. If you added the resource while FXServer was running, refresh rescans resource manifests. ensure starts a stopped resource or restarts one that is already running. Cfx.re server commands

FXServer console — replace resource_name
refresh
ensure resource_name

Use the actual resource name and run the commands only when you intend that start or restart. Follow the resource author’s instructions for persistent startup configuration in server.cfg; these console commands do not replace its setup steps.

Watch the server console during startup, join the development server, and perform the interaction you chose. Check the client console too when the failure appears client-side. Verify any database behavior the feature depends on.

If something fails, keep the first relevant error and the action that triggered it. Change one relevant thing, then repeat the same test. A short record of attempts makes troubleshooting more useful than “it doesn’t work.”

Copy and fill in — remove private details
Resource and release:
Framework and version:
Dependency versions:
Expected player interaction:
What happened instead:
First relevant error:
Steps already tried:

Remove credentials, connection strings and private player or server details before sharing logs or screenshots.

The AI Script Installer brings proposed file, database and configuration work into a review screen. Inspect the dependencies and proposed changes before deciding what to apply. Keep steps requiring manual attention visible, and treat database recovery separately from file backups.

Start with a development project and one resource. Review the proposal, apply changes you understand, and perform the same in-game check you would use after a manual installation. This checklist does not claim that a particular resource has been tested.

Next step: open your first development project, then use the installer guide to review one resource. If you still need the desktop app, get the current Windows build from the Boltise download page.

Does a successful resource start mean the feature works?

Section titled “Does a successful resource start mean the feature works?”

No. Test the intended player interaction and any required database behavior before treating the installation as complete.

Should I rerun SQL when the resource reports an error?

Section titled “Should I rerun SQL when the resource reports an error?”

First identify the error, whether the SQL is for installation or upgrade, and whether earlier statements ran. Rerun it only when you understand the result and the author’s instructions support that step.

Can a resource-folder backup undo database changes?

Section titled “Can a resource-folder backup undo database changes?”

No. Restoring files does not restore database contents. Plan database recovery separately.

What should I include when asking for help?

Section titled “What should I include when asking for help?”

Share the resource and framework versions, the first relevant error, what you expected, and the steps already tried. Include only sanitized details needed to reproduce the problem.

Docs privacy