Getting Started

Welcome to the official F5 Studio documentation. Here you'll find installation guides, configuration references, API docs, and troubleshooting guides for all our FiveM scripts.

Requirements

Before installing any F5 Studio script, make sure you have:

Requirement	Minimum Version
FiveM Server Artifacts	6116+ (latest recommended)
Framework	ESX 1.9+, QBCore, or QBox Core
Database	MySQL 8.0+ or MariaDB 10.6+ (if the script uses a database)
Database Resource	oxmysql (recommended) or mysql-async (if the script uses a database)

Multi-Framework

All F5 Studio scripts (unless marked as standalone) include a bridge system that automatically detects your framework at startup — no manual framework configuration needed. The detection priority is: QBox → QBCore → ESX.

Installation Flow

Installation Overview

Every F5 Studio script follows the same installation pattern:

1. Download

Download the script from GitHub (free scripts) or purchase from the F5 Studio store (paid scripts). For paid scripts, claim your asset on Cfx.re Keymaster and download the latest version.

2. Extract

Place the script folder into your server's resources directory. We recommend grouping F5 scripts:

Recommended folder structure

resources/
  [f5]/
    f5_safezones/

3. Server Config

Add the resource to your server.cfg — make sure it starts after your framework (and database resource, if the script uses one):

ESX

server.cfg

ensure es_extended
ensure f5_scriptname

QBCore

server.cfg

ensure qb-core
ensure f5_scriptname

QBox Core

server.cfg

ensure qbx_core
ensure f5_scriptname

Start Order

F5 scripts must start after your framework resource. Incorrect boot order is the most common installation issue.

4. Restart

Restart your server or use /refresh followed by /start f5_scriptname in the server console.

Framework Auto-Detection

You do not need to set your framework in config.lua. The built-in bridge automatically detects which framework is running and initializes the correct integration. You'll see a confirmation in the server console on startup:

[f5_scriptname:bridge:SERVER] Framework detected: qbcore (resource: qb-core) after 1 attempt(s)

Database Auto-Setup

For scripts that use a database, no manual SQL import is required. All necessary tables and columns are created automatically on first startup. If you update the script and the database schema has changed, the script will apply migrations automatically — no manual intervention needed.

tip

You don't need to run any .sql files. Just start the resource and the database is ready.

Available Scripts

Premium Scripts

Script	Description	Docs
F5 Board	Cinematic corkboard / chalkboard / whiteboard system with multi-tool editor, public edit, editor whitelist, preview camera and Discord audit trail	View docs

Free Scripts

Script	Description	Docs
F5 Safezones	Advanced safezone system with NUI admin panel	View docs
F5 Boost	FPS optimization tool with NUI settings menu	View docs
F5 Board Calibrate	Developer companion tool for F5 Board — in-game surface calibrator with live 3D overlay and Lua export	View docs

Need Help?

• Browse this documentation for detailed guides
• Join our Discord server for community support
• Open a support ticket on Discord for direct assistance
• Check the FAQ for common questions