Console and Chat Commands

MonoAdmin adds one command to your server console, two chat commands for players and staff, and three key bindings: two optional ones for staff, and one for the Game World Editor. This page lists every one of them, with what it prints and what can go wrong. There are no other commands: no chat commands for banning or kicking, and nothing to set up with ACE permissions. You punish from the panel, from the in-game menu, or from a script through an export.

At a Glance

Command	Where it runs	What it does
monoadmin status	Server console	Shows the version, link, framework, players and punishments
monoadmin link <code>	Server console	Links the server to a project with a pairing code
monoadmin unlink	Server console	Deletes the stored link
monoadmin debug on / off	Server console	Shows or hides MonoAdmin’s detailed log lines
/madmin	Game chat, or madmin in the F8 console	Opens and closes the in-game menu (staff)
/madmin link <code>	Game chat, or madmin link <code> in F8	Links your game account to your MonoAdmin account
/report	Game chat	Opens the report window (players), once reports are on. The name can be changed in Settings > Features
madmin_players	A key you bind	Opens the menu on the players list (staff)
madmin_noclip	A key you bind	Turns noclip on or off (staff)
+gizmoSelect	The left mouse button	Holds a handle of the Game World Editor’s gizmo (staff)

The monoadmin Console Command

monoadmin runs in the server console: the window FXServer runs in, txAdmin’s Live Console, or RCON. It is refused from anywhere else. A player cannot run it, even one who has been given ACE access to it, and another resource cannot run it through ExecuteCommand. This protects the link credential and the pairing code. RCON is the way it has been checked on a live server; typing it in the console window or in txAdmin’s Live Console is expected to behave the same, and if one of them is refused, use RCON. A refusal is logged in the server console:

[warn] monoadmin command refused: it only runs from the server console
[warn] monoadmin command refused: another resource ran it; it only runs from the server console

Subcommands are not case sensitive. The arguments of link are never printed back or written to the log; the log redacts anything that looks like a pairing code.

Typing monoadmin with no subcommand prints the usage, and an unknown subcommand prints a hint:

Usage: monoadmin <status|link|unlink|debug>
Unknown subcommand. Usage: monoadmin <status|link|unlink|debug>

monoadmin status

Prints the state of the resource, the link and the server. A linked server that is connected prints:

MonoAdmin v<version>
Project: My Server (#6)
Connection: connected
Framework: esx 1.16.0
Integrations: inventory ox_inventory, medical esx_ambulancejob, database oxmysql, garage none, phone none
Players: 12 online, 12 tracked by the panel
Punishments: 3 enforced from the local copy (revision 8)

A server that is not linked prints a shorter report with a reminder:

MonoAdmin v<version>
Cloud link: not linked. Create a pairing code in the panel, then run: monoadmin link <code>
Framework: esx 1.16.0
Integrations: inventory none, medical esx_ambulancejob, database oxmysql, garage none, phone none

Line	Meaning
MonoAdmin v<version>	The resource version.
Update available: v<latest> - <address>	Only when a newer resource exists. The address is your Granted Assets on portal.cfx.re, where the new version is downloaded.
Project: <name> (#<id>)	The project this server is linked to.
Cloud link: not linked...	The server holds no link. If it still enforces bans from an earlier link, the line reads not linked, <n> cached bans still enforced.
Connection: <state>	One of the states in the next table.
Last failure: <reason>	Only while the link is down, and says why. See the reasons below.
Framework: <framework> <version>	The detected framework, or Framework: not detected yet right after a start.
Warning: the panel is set to <chosen> but this server runs <detected>. Change the framework in the panel's settings.	The project’s framework differs from what runs.
Integrations: inventory <x>, medical <y>, database <z>, garage <g>, phone <p>	The inventory resource, ambulance script and database resource found, and the garage and phone scripts with their versions, or none.
Players: <n> online, <n> tracked by the panel	Players beyond your plan’s limit are not tracked.
Punishments: <n> enforced from the local copy (revision <r>)	Bans, mutes and service orders the server holds. Punishments: not synchronised yet before the first sync.
Connect check: fail-closed - players are refused while the cloud cannot be asked (set in the panel)	Only when fail-closed is on under Settings > Game Settings.

Connection States

State	Meaning
connected	The link is up and MonoAdmin has accepted this server.
connected, waiting for the cloud to accept this server	The connection is open but the greeting has not been accepted yet.
connecting	A connection is being opened.
reconnecting	The link dropped and the resource is waiting to try again. It waits a little longer each time, up to 30 seconds.
stopped	The link has stopped. A Last failure: line usually says why. Some stops last until you unlink and link again, or restart the resource.
not started	No link is running, for example in the first moments after a start.

The status never says “disconnected”.

Last Failure Reasons

Reason	What it means
another server connected with this server's credential - this one will not reconnect	A second server used the same link, so this one was replaced. It does not fight back.
credential revoked - run monoadmin unlink, then link with a new code from the panel	The link was cancelled from the panel, or replaced by linking another server.
credential rejected - pair again from the panel	MonoAdmin did not accept the stored credential. It retries every 5 minutes.
resource version no longer supported - update	This resource version is too old to connect. It retries every 5 minutes.
the cloud refused this server: <message>	MonoAdmin answered the server’s greeting with a refusal.
the cloud answered HTTP <status>	The connection attempt got an HTTP error instead of a connection.
connection closed (code <code>)	The connection closed with a WebSocket code and the resource is retrying.

When a reason needs action, Troubleshooting has the fix.

monoadmin link

monoadmin link XXXXX-XXXXX

Exchanges a pairing code from the panel for the server’s link. The code is 10 letters and digits, with or without the dash, in any case. A code works once, for 10 minutes. Output:

You see	Meaning
Contacting MonoAdmin...	The code looks right and the request is on its way.
Linked to project <name>. Connecting...	Success. The log then shows server linked and connected to the cloud.
Usage: monoadmin link <code>	No code, or more than one word.
That does not look like a pairing code. It is 10 characters, shown as XXXXX-XXXXX in the panel.	The text is not 10 letters and digits.
This pairing code is not valid or has expired. Create a new one in the panel.	Used, expired or replaced, or the member who made it has since left the project, lost Manage Server Link or secured their account.
Too many attempts. Wait <n> seconds and try again.	Rate limit.
Could not reach MonoAdmin. Nothing was changed. <reason>	The request failed. <reason> is timeout, network, too_large, malformed answer or http <status>.
A link attempt is already in progress.	You ran it twice at once.
This server is already linked to <name>. Run monoadmin unlink first.	Unlink first. Nothing was contacted.

Step by step, see Link Your Server.

monoadmin unlink

monoadmin unlink

Deletes the stored link and closes the connection. Output:

Unlinked from project My Server. The stored credential was deleted.

If the server holds cached bans, it adds ; <n> cached bans stay in force until this server is linked to another project. This is on purpose: unlinking is not a way to let banned players back in. There is no command to clear cached bans. They are replaced when the server is linked to a different project, and linking the same project again keeps them. If there is no link, it prints This server is not linked.

monoadmin unlink only changes the server. To cut the link from the panel’s side too, use Settings > Server Link > Unlink Server.

monoadmin debug

monoadmin debug on
monoadmin debug off

MonoAdmin keeps the server console quiet: it prints when it starts and stops, the framework it found, the project it connected to, when the server is linked or unlinked, the first time the connection to MonoAdmin drops, players refused at the door, and every warning and error. monoadmin debug on adds the detailed lines (every reconnect, synchronisation and setting, with their details) until the resource restarts or you run monoadmin debug off. Turn it on when support asks for it, and off again afterwards. monoadmin debug alone says whether it is on.

In-Game Commands

These are typed in the game’s chat with a slash, or without the slash in the F8 console.

/madmin

Opens the in-game menu, and closes it if it is already open. It works with or without a menu key. It opens only for staff, and only when the owner has turned the in-game menu on. See Turn On and Open the Menu.

When the menu will not open, a short message in the game explains why:

Message	Reason
You’re not recognised as staff here. Link this game account with /madmin link and the code from the web panel.	The game account is not linked to a staff member.
This game account is linked to more than one staff member. Ask the server owner to fix the links in the web panel.	Two members share one game account.
Your role can’t use the in-game menu. Ask the server owner for the In-game menu permission.	The role lacks Open the In-Game Menu.
The in-game menu is switched off for this server. The owner can switch it on in the web panel’s settings.	The owner has not turned the menu on.
This server’s MonoAdmin resource can’t run the in-game menu. Update the resource.	The resource is too old.
Too many tries. Wait a moment, then open the menu again.	Rate limit.
MonoAdmin can’t be reached right now. Try again in a moment.	The cloud link is down.
The MonoAdmin menu couldn’t load. Restart the game, or ask the server owner to update the resource.	The menu’s files did not load.

Any other word after /madmin shows how to open the menu. With a menu key set, it reads “Press F6 or type /madmin to open the MonoAdmin menu. To link this game account, type /madmin link followed by the code from the web panel.” Without one, it says to type /madmin and that the key is chosen in the web panel under Settings > Features.

/madmin link

/madmin link ABCD-EFGH

Links the game account you are playing on to your MonoAdmin account, so the menu recognises you as staff. Get the code in the panel under Settings > My Membership > Link Game Account. It works once and for 10 minutes. This is a different, shorter code than the server’s pairing code. Case, spaces and the dash do not matter.

Message	Meaning
Linked to Alex. You can now use the in-game menu when it is switched on.	Success. Your MonoAdmin name replaces “Alex”.
Type /madmin link followed by the code from the web panel, for example /madmin link ABCD-EFGH.	You typed no code.
That link code isn’t valid. Check it, or get a new one in the web panel.	Wrong or already used.
That link code has expired. Get a new one in the web panel.	More than 10 minutes old.
This game account has no Rockstar license MonoAdmin can verify	The player has no verifiable Rockstar identifier.
Too many link attempts. Wait a minute and try again.	Rate limit.
This game account was linked to someone else at the same moment. Try again.	A race with another member.
Your visit isn’t known to MonoAdmin yet, followed by “try again in a moment”	The server has not registered you yet. Wait a moment, or rejoin.
The in-game menu is switched off on this server, so game accounts can’t be linked. The owner can switch it on in the web panel’s settings.	The owner has to turn the menu on first.
Linking didn’t work. Try again, or get a new code in the web panel.	Any other failure.

/report

Opens the report window, where a player can report another player, a bug, a question or something else. It appears once the owner turns on Player Reports. A player who joined while reports were off gets the command as soon as reports are switched on, without rejoining. The message “Player reports are switched off on this server.” shows only when reports are switched off during that player’s game session. The window, its limits and what players see are on What Players See, and staff handle the result on Reports.

The command is /report unless the project picked another name. Settings > Features has a Report Command box under the Player Reports switch, and anyone with Edit Settings can change it: 2 to 32 lowercase letters, digits and underscores, starting with a letter, written without the slash. The new name works at once. Players already in the game keep the old name taken until they rejoin, and typing it does nothing. Everything above then applies to the new name. The rules, and the few names that are reserved, are on Features and Modules.

If another resource on your server also registers the report command, the two commands can clash. Which one runs when both are present has not been checked on a real server. While player reports are on, MonoAdmin looks for such resources, on the server and in players’ games, and warns you in the panel (in Settings > Features and in the guided setup). It offers three ways out: use another command, keep /report and turn the other script off, or, for the owner, turn off MonoAdmin’s player reports. The server console also prints a warning, once for each set of resources it finds:

[warn] [reports] /report is also a command of qs-reports. In the panel, Settings > Features lets you pick another report command, or you can turn that resource off.

The panel explains each way out on Features and Modules. If you run a report script, test the command either way.

Key Bindings

The menu key is not a FiveM key binding. You choose it in the panel (Settings > Features, or the guided setup), and the game reads it for staff only. These are the actual bindings that appear in FiveM, under Settings > Key Bindings > FiveM:

Entry in FiveM’s list	Command	Default	What it does
MonoAdmin: open the Players list	madmin_players	Unbound	Opens the menu on the players sheet, or switches an open menu to it
MonoAdmin: noclip on or off	madmin_noclip	Unbound	Turns noclip on or off without opening the menu
MonoAdmin: drag the Game World Editor’s gizmo (hold)	+gizmoSelect	Left mouse button	Holds a handle of the Game World Editor’s gizmo while you drag it. It does nothing when no gizmo is on screen.

Noclip prints “Noclip on. Press the key again to land.” and “Noclip off.” If your role cannot use it, it says “Your role doesn’t allow noclip.” If you are spectating, it says “Stop spectating first.” and if the switch fails, “Noclip couldn’t be switched. Open the menu and try again.”

Both staff keys need the same access as the menu: a linked game account, the in-game menu switched on, and a role that allows it (Noclip for the noclip key). The Players key shows the same refusal messages as /madmin. The noclip key has its own: a role that cannot use noclip gets “Your role doesn’t allow noclip.”, and an account that is not linked, is linked to more than one staff member, or is not known to MonoAdmin yet gets “You’re not recognised as staff here. Link this game account with /madmin link and the code from the web panel.” The messages for the menu being switched off and the cloud link being down are the same as for /madmin.

FiveM Commands You Will Use With It

These belong to FiveM, not MonoAdmin, and you run them in the server console.

Command	When
ensure monoadmin	Start MonoAdmin, or restart it. It is also the line for server.cfg.
restart monoadmin	Restart the resource after an update.
refresh	Run before restart monoadmin after an update, so a changed file list is picked up.
stop monoadmin	Stop the resource. Bans are not enforced while it is stopped.

Related Pages

• Install the Resource
• Link Your Server
• Troubleshooting
• Scripts and Exports