Install the Resource

The resource is the part of MonoAdmin that runs on your FiveM server. You get it from our store, and then installing it is the same as installing any other resource: unzip a folder, add one line to server.cfg and start it. This page covers those steps and how to check that it started. Linking the server to your project is the next page, Link Your Server.

Before you begin, check the requirements: server build 12913 or newer with OneSync on, and oxmysql if you want character and vehicle data.

Get the Resource

MonoAdmin reaches you through Cfx.re’s asset system. You claim it as a free package on our store, signed in with your Cfx.re account, and then download it from the Cfx.re portal.

1. In the guided setup, on its first screen, Link Your Server, find Get the resource and choose Claim on Our Store. After you create a project the setup opens there by itself. Later you can get back to it from the dashboard: choose Link a Server on the Link Your FiveM Server card, or Continue on the Finish Setting Up card. The same button is in Settings > Server Link, for a team member who installs a server under their own Cfx.re account.
2. The button opens MonoAdmin on our store, which Tebex runs. Sign in there with the Cfx.re account that owns your server’s license key.
3. MonoAdmin costs nothing: finish the store’s checkout to claim it. An account claims it once.
4. Back in the panel, choose Get MonoAdmin. It opens your Granted Assets on portal.cfx.re, searched for MonoAdmin. Sign in to the portal with the same Cfx.re account if it asks, and download MonoAdmin. If the list is empty, the package was claimed with another account, or not yet.

The download holds the resource’s files and one hidden file, .fxap, next to fxmanifest.lua. Cfx.re adds it, and the resource does not start without it.

Which Account and Which Key

The resource runs only on a server whose license key belongs to the Cfx.re account that claimed it. On any other server it does not start, and FXServer reports You lack the required entitlement. See Troubleshooting.

• Your server’s license keys are listed on the registration keys page of the Cfx.re portal.
• If you claimed MonoAdmin with the wrong account, claim it again with the account that owns the key. You can also transfer it to that account from Granted Assets on the Cfx.re portal, but only once, only within 28 days of claiming it, and it cannot be undone. Cfx.re’s support article has the steps.

Put It in Your Resources Folder

Unzip the download into your server’s resources folder so that this file exists:

resources/monoadmin/fxmanifest.lua

If your archive tool adds an extra level (for example resources/monoadmin-v1.0.0/monoadmin/), move the inner monoadmin folder up so it sits directly in resources. A category folder such as resources/[local]/monoadmin/ is fine too. What matters is that fxmanifest.lua sits directly in the resource’s own folder, and that the hidden .fxap file is still next to it.

If your server is on another machine, upload the whole folder at once, with SFTP or with FTP in binary mode, and check that hidden files are shown and sent. A transfer in text (ASCII) mode changes the files and breaks the resource, and a client that skips hidden files leaves out .fxap. See Troubleshooting.

Using Another Folder Name

The folder is called monoadmin in the download, and these docs use that name. You can call it something else, such as admin: MonoAdmin works under any name FiveM accepts for a resource, made of letters, digits, dots, dashes and underscores. Then use your name wherever a resource name is written:

• the ensure line in server.cfg, for example ensure admin;
• the logging line other resources load, for example shared_script '@admin/logging.lua' (see Server Logs).

Scripts that call exports.monoadmin:createPunishment or exports.monoadmin:logCommand keep working without changes. Scripts and Exports has one thing to know about restarts. The console command stays monoadmin whatever the folder is called: monoadmin link, monoadmin status.

Start It from server.cfg

Add the resource to server.cfg after your framework and oxmysql:

ensure oxmysql
ensure es_extended      # or qb-core / qbx_core
ensure monoadmin

ensure starts a resource, and restarts it if it was already running. On a standalone server there is no framework line, so ensure monoadmin goes after oxmysql if you use it. Edit server.cfg wherever you normally do, including txAdmin’s CFG editor.

Then restart the server. To try it without a restart, type the same line in the server console:

ensure monoadmin

Does the Order Matter?

Start MonoAdmin after your framework and oxmysql, as above. The resource does not insist on it, though: its manifest does not require its neighbours to be started first. Whenever your framework, oxmysql, an inventory, chat, pma-voice, an ambulance script, jg-advancedgarages or lb-phone starts or stops, MonoAdmin runs its detection again about a second later and tells the cloud what it found.

Check That It Started

In the server console, look for two lines from the resource:

[    script:monoadmin] [info] monoadmin started version=<version> linked=false punishments=0
[    script:monoadmin] [info] framework detected framework=esx version=<version>

• linked=false is expected until you link the server.
• punishments=0 is how many bans, mutes and community service orders the server holds locally. It is zero on a first install.
• The framework detected line names what MonoAdmin found: esx, qbcore, qbox or standalone.

You can also run monoadmin status in the console. See Console and Chat Commands for its output. A player who joins sees nothing different yet. In their F8 console the line MonoAdmin client ready appears.

If the resource did not start, or the framework line is missing, see Troubleshooting.

There Is Nothing to Configure

MonoAdmin has no configuration file, and the install does not touch the rest of your setup:

• No config files. Settings come from the panel, and the server picks up changes the moment you save them.
• No convars to set. The resource reads only eight convars: sv_hostname, sv_maxclients, onesync and sv_icon, and four that txAdmin sets on a server it runs (txAdminServerMode, txAdmin-version, sv_appearAllowlisted and txAdmin-checkPlayerJoin). It never keeps a credential in a convar.
• No ACE permissions. Who may do what is decided by the roles in the panel, checked again on every action. You do not add anything to permissions.cfg.
• No database changes. The resource adds no tables or columns. For character and vehicle data it reads and writes your framework’s own tables through oxmysql.
• No inbound port. The resource connects outward. See Requirements.

The one thing you may want to set is your server’s icon. If your server.cfg loads one with load_server_icon, the resource sends it to MonoAdmin and the panel and in-game menu show it. See The Guided Setup.

What the Resource Adds to Your Server

For a sense of what you are installing:

• One console command, monoadmin, that only the server console can run.
• Two chat commands for players, /madmin and /report, plus three key bindings, two optional ones for staff and one for the Game World Editor. /report appears once you switch player reports on, and you can rename it under Settings > Features (see Features and Modules). See Console and Chat Commands.
• Two exports other resources can call. One punishes players, and no resource may use it until you name it under Settings > Game Settings. The other only writes a command line to Server Logs. See Scripts and Exports.

Next Step

Link your server to your project with a one-time code.