Skip to content

Installation

Jump to bottom
Travis edited this page Feb 23, 2026 · 2 revisions

Installation

Step-by-step guide to installing Respoon on your FiveM server.

Requirements

Requirement Details
FiveM Server Any recent build of FiveM (fx_version cerulean)
Database MySQL or MariaDB (see Database page)
Database driver oxmysql (recommended) or a manual connection string

Respoon has no framework dependency -- it works with QBCore, ESX, QBox, or standalone servers.

Step 1 -- Download

Download the latest release from the Releases page.

Step 2 -- Extract

Extract the respoon folder into your server's resources/ directory:

resources/
  respoon/
    dist/
    web/
    data/
    fxmanifest.lua

Step 3 -- Configure server.cfg

Add the following lines to your server.cfg:

ensure respoon

add_ace builtin.everyone respoon.use allow
add_ace group.admin respoon.admin allow

Tip: If you only want certain groups to access Respoon (instead of everyone), see the Permissions page for more granular ACE configuration.

Database driver

If you already have oxmysql running, no extra configuration is needed -- Respoon detects it automatically.

If you do not have oxmysql, add a connection string to your server.cfg:

set mysql_connection_string "mysql://user:password@localhost:3306/database"

Replace user, password, localhost, 3306, and database with your actual credentials.

See the Database page for full details.

Step 4 -- Start the server

Start (or restart) your server. On first boot, Respoon will:

  1. Create all required database tables automatically
  2. Seed the model catalogs (~317k rows of data)

First startup takes approximately 30 seconds while the catalogs are being seeded. Subsequent starts are instant.

You will see log output in your server console as tables are created and seeded.

Step 5 -- Open the editor

Once the server is running, join your server and:

  • Type /rs in chat

to open the Respoon editor.

Resource load order

If you are using oxmysql, make sure it starts before Respoon in your server.cfg:

ensure oxmysql
ensure respoon

If oxmysql has not started when Respoon initializes, it will fall back to the bundled MySQL driver using the mysql_connection_string convar.

Updating

To update Respoon:

  1. Download the new release
  2. Replace the respoon folder in your resources/ directory
  3. Restart the resource (ensure respoon or restart the server)

Database migrations run automatically on startup -- no manual SQL changes are needed when updating.

Troubleshooting

Problem Cause Solution
Database errors on start oxmysql not started yet Ensure oxmysql starts before respoon in server.cfg
Editor does not open Missing NUI build files Re-download and extract the release
Entities do not spawn No players in the routing bucket Normal -- entities load when a player joins a room
Long startup time First boot seeding catalogs Wait ~30 seconds; subsequent starts are instant

For additional help, join the Discord.

Clone this wiki locally