ox_core Installation Guide

ox_core can be installed from a release like any other resource, or built from source if you want to track main. Both paths are documented here.

Prerequisites

Cfx.re account created and a server license key issued from keymaster
FXServer artifacts downloaded and extracted
MariaDB 11.4 or newer installed
OneSync enabled — ox_core requires it
A developer on the team who will write the gameplay layer

⚠️

ox_core ships no jobs, shops, phone or HUD. After this install you will have a server you can connect to, create a character on, and very little else. That is expected — see the overview.

Method 1 — txAdmin recipe

Start FXServer

Run FXServer.exe and link your Cfx.re account in the txAdmin wizard.

Use the Overextended recipe

Point the deployer at the overextended/txAdminRecipe repository.

Enter database credentials

The deployer creates the schema and imports the SQL.

Method 2 — from a release

Install the dependencies

Download releases of oxmysql and ox_lib. Both are required.

Download ox_core

Take the latest release and extract it into your resources folder.

Add the optional resources

Not strictly required, but expected by most ox_core code: ox_inventory, ox_target, ox_doorlock.

Configure server.cfg

set onesync on
set mysql_connection_string “mysql://user:password@localhost/ox?charset=utf8mb4”
ensure oxmysql
ensure ox_lib
ensure ox_core
ensure ox_inventory
ensure ox_target

ox_core builds its own schema on first start — there is no SQL file to import manually.

Method 3 — build from source

Install the toolchain

You need Git, Node.js and bun.

Clone and build

git clone https://github.com/overextended/ox_core.git 
cd ox_core
bun i
bun run build

Configuration

ox_core is configured entirely through convars. Use setr so clients can read the replicated ones:


setr ox:characterSlots 3
setr ox:deathSystem true
setr ox:characterSelect true
setr ox:plateFormat "........"
setr ox:defaultVehicleStore "impound"
setr ox:debug false

ox:debug also allows duplicate identifiers, which is how you test multiple characters from one machine. Never leave it on in production.

Validation

Console reaches "Started resource ox_core" with no errors
Database contains users, characters, accounts and vehicles tables
You can connect and create a character
The character is still there after a server restart
ox_inventory opens and items persist

ox_core Installation