Requirements

MonoAdmin asks very little of your server: a recent FiveM server build with OneSync turned on, and a connection that can reach MonoAdmin. Character and vehicle data need one more resource, oxmysql. This page lists everything, so you can check your server before you install.

Your FiveM Server

Requirement	Details
Server artifact 12913 or newer	An artifact is a build of the FiveM server software. The resource declares this version as a dependency, so on an older build FXServer will not start it. MonoAdmin is developed and tested on build 35245. Other builds from 12913 up meet the requirement but have not been run through the full test pass.
OneSync turned on	OneSync is FiveM’s server-managed synchronisation mode, which lets the server see and control players and entities. The resource declares it as a dependency too. Turn it on with set onesync on in server.cfg.
Node 22 runtime	The resource asks FXServer for its Node 22 runtime. FXServer supplies it, so there is nothing to install.
Outbound HTTPS	The server must be able to reach MonoAdmin. See Network below.
A server license key on your Cfx.re account	The resource is delivered through Cfx.re’s Asset Escrow, which runs it only on a server whose license key belongs to the Cfx.re account that claimed it. See Install the Resource.

If one of the server build or OneSync requirements is missing, FXServer refuses to start the resource and says that a dependency is not met.

Your Framework

A framework is the roleplay base your server runs on. MonoAdmin supports four setups:

Framework	Supported versions	How MonoAdmin recognises it
ESX	1.13.5 to 1.16.0	es_extended is started
QBCore	Tested on 1.3.0	qb-core is started
Qbox	1.22.5 and later	qbx_core is started
Standalone	No framework needed	None of the three is started

A server with no framework still gets moderation, the live map, the Player Monitor, reports and Server Logs. The framework decides how much of your players’ data MonoAdmin can read and change. Supported Frameworks has the full comparison.

If your ESX is older than 1.13.5 or your Qbox is older than 1.22.5, MonoAdmin still connects, but the panel and the console warn that money, items and character edits may fail until you update it.

For Character and Vehicle Data

The Character tab on a player’s profile and the Vehicles page read your framework’s database. For that, you need:

• ESX, QBCore or Qbox, and
• oxmysql started on the server.

Other database resources (mysql-async, ghmattimysql) are detected, but they are not enough for character and vehicle data. Without oxmysql, those pages do not appear. Everything else works without it.

Optional Resources

None of these is required. Each one unlocks or improves something.

Resource	What it adds	Page
An inventory resource	Giving items and editing a character’s inventory; ox_inventory also adds item lines to Server Logs	Inventory Resources
An ambulance script	A Revive that ends the script’s own death screen	Revive and Ambulance Scripts
jg-advancedgarages v3	A Vehicles page that follows jg’s garages and impounds, and deleted cars that go back to their garage	Garage Scripts
lb-phone 2	lb-phone’s phone number on the Character tab, Reset Lock for a forgotten PIN, and phone lines in Server Logs	Phone Scripts
FiveM’s built-in Mumble voice (or pma-voice)	Voice mutes	Voice and Text Mutes
The default chat resource	Text mutes, and chat lines in Server Logs	Voice and Text Mutes

Network

The resource only makes outbound connections. It needs to reach the MonoAdmin gateway, ws.monoadmin.net, over HTTPS (port 443) for the one-time linking request and over a secure WebSocket for the live connection.

• No inbound port. You do not forward anything for MonoAdmin, and you do not allow MonoAdmin to connect to your server.
• Players’ games reach the gateway too. A player’s own game connects to it for live position data, screenshots and profile pictures. That works over their normal internet connection. There is nothing for you to open.
• Proxies. Running the game server behind an HTTP proxy has not been tested.

If your host filters outbound traffic, allow ws.monoadmin.net.

Your MonoAdmin Account

You need an account to create a project. Sign up with an email address and a password and confirm your email, or sign up with Discord, which needs a verified email address on your Discord account.

The panel runs in a current web browser, on a computer or a phone. The Player Monitor needs a browser with WebRTC, which current browsers have. The steps are on Create Your Account and Project.

Every project starts on the free Starter plan, and you do not need a payment method to begin. See Plans and Limits for what each plan allows.

Checklist

Before you continue, check that:

1. The server runs build 12913 or newer, with set onesync on.
2. You know which framework it runs, and that the framework starts correctly.
3. oxmysql is started, if you want character and vehicle data.
4. The server can make outbound HTTPS connections.
5. You can reach the server console: the window FXServer runs in, txAdmin’s Live Console, or RCON.

Then create your account and project.