Admin Tools

Every command that comes with oxide-tablet, the in-game settings editor you use to set up the tablet, and how to give someone admin access.

Most of your setup happens in one place: type /tablet settings in game. Changes you save there go live straight away, with no restart and no file editing.

Commands Overview

/tablet is one command — the word you type after it picks what it does. You can type these in the in-game chat. Where the table says "Yes" under Server console, you can also type the command (without the /) into your server console, the text window where your server prints its messages (or Live Console in txAdmin).

Who can use it means:

• Everyone: any player can run it. No permission is needed.
• Admins: only players who pass the admin check (see Permissions). Anyone else gets the message "You do not have permission." (oxide-tablet:mapmode says "You do not have permission to change map settings.")

Needs Debug logging means the command only works while Debug logging is switched on in the settings editor (Advanced tab, Advanced section). Only tablet_testsend needs it. Every other command is always available.

Command Details

/tablet

Shows which tablet commands exist.

/tablet

Typing /tablet on its own, or with a word it doesn't recognise, shows in game:

Usage: /tablet <open|device|resethome|settings|wipe|notify>

Run from the server console, it prints one line per subcommand with a short description instead.

Who can use it: everyone. Server console: yes.

/tablet open

Opens your tablet, just like pressing the Open tablet key.

/tablet open

Who can use it: everyone. Server console: no — from the console it prints "This command must be run in-game."

What happens:

• If Require an item is on (it is by default), you must carry one of the tablet items listed in the settings editor. If you carry more than one tablet, the one in your lowest inventory slot opens.
• If Require an item is off, the tablet opens for anyone. Its home screen and settings are then saved to your character instead of to a tablet item.

Output:

Notes:

• If you run it again within half a second, the second try is ignored. This is normal.
• The tablet won't open while the settings editor is open on your screen.

/tablet device

Tells you which tablet you're carrying. Every tablet item gets its own IMEI, a 15-digit ID number, the first time it's used. The IMEI stays with that item even when it changes hands, so it's how you tell one tablet apart from another.

/tablet device

Who can use it: everyone. Server console: no — from the console it prints "This command must be run in-game."

If you carry more than one tablet, this shows the one in your lowest inventory slot. That's the same tablet that opens when you press the key.

Output:

Notes:

• Players can also find the IMEI inside the tablet under Settings → About. If Show IMEI on the item is on, it also appears in the item's description in inventories that show item descriptions.
• If a tablet still says "not activated" after being opened, your inventory probably can't save extra information on items. The tablet still works, but its home screen and settings are saved to the character instead of the item.

/tablet resethome

Puts a home screen back to the default arrangement of apps and widgets. Installed apps and the Settings app choices are not touched — only the layout is reset.

/tablet resethome

Who can use it: everyone. Server console: no — from the console it prints "This command must be run in-game."

Which home screen gets reset: the same tablet that /tablet open would bring out.

• With Require an item on, that's the first tablet item in your inventory that already has an IMEI.
• Your character's home screen is reset instead when that tablet has never been used (it has no IMEI yet), when your inventory can't save an IMEI on items, when Require an item is off, or when you carry no tablet at all.

If you carry more than one tablet, reset a particular one from inside it: open it, go to Settings → General, and tap Reset layout (tap again to confirm).

Output:

• Success: "Home screen reset to the default layout."
• Failure: "The home screen could not be reset right now." This happens when your character hasn't finished loading.

/tablet settings

Opens the settings editor, where you change every tablet option live. See The Settings Editor for a walk-through.

/tablet settings

Who can use it: admins. Server console: no — from the console it prints "This command must be run in-game."

Output:

• Success: the settings editor opens. If your tablet was open, it's put away first.
• Failure: "You do not have permission."

/tablet wipe

Factory-resets one tablet using its IMEI. Use this when a tablet has a messy home screen, an unwanted name, or when a player asks for a clean start.

/tablet wipe <imei>

/tablet wipe 351234567890123           -- in-game chat
tablet wipe 351234567890123            -- server console (no slash)

Who can use it: admins. Server console: yes — messages print in the console.

What gets reset:

• The tablet's name
• Its battery, back to 100%
• Its home screen layout and wallpaper
• The apps installed on it
• The choices made in its Settings app (notifications and accessibility)

What stays: the item itself and its IMEI. The next time someone uses it, it starts fresh like a new tablet.

If someone is using that tablet right now, their screen resets straight away.

Output:

/tablet notify

Sends a test notification to your own tablet. Use it to check that notifications, banners and sounds work.

/tablet notify <app> [#id] <message>

App IDs you can always test with:

Apps from other resources work too. Use the app ID that resource registers.

/tablet notify tablet_settings Hello from the admin team
/tablet notify tablet_settings #test First version
/tablet notify tablet_settings #test This replaces the first version

Who can use it: admins. Server console: no — from the console it prints "This command must be run in-game."

Output:

• Success: no chat message. The notification titled "Test notification" arrives on your tablet. It drops in as a banner if the tablet is open, or as a small bubble at the bottom right of your screen if it's put away. Tapping the banner, or the notification in the tablet's notification tray, opens the app.
• Usage: /tablet notify <app> [#id] <message> means the app or the message is missing.

If nothing shows up, check these:

• The app ID is spelled correctly and that app exists on your tablet.
• Notifications → Enabled is on in the settings editor.
• In your tablet's Settings app, that app's notifications are switched on, and Do Not Disturb is off.
• The app is installed on your tablet. Notifications for apps you haven't installed are kept but not shown.

oxide-tablet:mapmode

Shows or changes how the Maps app draws the main map and Cayo Perico. This is the same setting as Map mode in the settings editor (Apps → Map App), so use whichever is easier.

oxide-tablet:mapmode [mode]

oxide-tablet:mapmode                   -- server console: print the current mode
oxide-tablet:mapmode separate          -- server console: switch to separate island views
/oxide-tablet:mapmode combined         -- in-game chat

Who can use it: admins. Server console: yes.

Output — all replies print in the server console, even when you type the command in game:

• Success: [oxide-tablet] MapMode = separate
• Wrong mode: [oxide-tablet] Use oxide-tablet:mapmode inherit|combined|separate|disabled
• Not an admin (in game): "You do not have permission to change map settings."

Notes:

• The change is saved and reaches open Maps apps right away.
• If the server has only just started, the command may do nothing until the tablet finishes loading its settings. Wait a few seconds and try again.

tablet_testsend

A test command for developers. It opens the tablet's built-in Demo app and sends it a test message.

tablet_testsend

Who can use it: anyone, but it does nothing unless Debug logging is on. Server console: no — it only exists in the player's own game (type it in F8 or chat).

Needs Debug logging: yes. The command doesn't exist until Debug logging has been switched on while that player is online, or the player joins with it on. Once it exists it stays until the player reconnects, but it does nothing while Debug logging is off.

Output: the tablet opens straight into the Demo app. Nothing happens when Debug logging is off.

Leave Debug logging off on a live server. See Advanced: Advanced.

The "Open tablet" key

Players can also open the tablet with a key. Pressing it again puts the tablet away. It follows the same rules as /tablet open.

• Players set their own key in the GTA pause menu under Settings → Key Bindings → FiveM, entry Open tablet.
• It has no key by default. You can choose a default key under Open keybind default in the settings editor. That default only applies to players who have never joined your server before.

The Settings Editor

How the Editor Works

Type /tablet settings in game to open it. This is where you set up everything about the tablet.

Finding your way around

• The left sidebar groups the sections under four headings: Core, Appearance, Advanced and Apps. Click a heading to fold it open or closed, and click a section to show its settings.
• The Basic and Advanced tabs at the top switch between everyday settings and a few rarely needed ones. Everything on this page is on the Basic tab unless it says Advanced tab.
• The Search settings box finds a setting by name.

Changing and saving

Reset to default

Every setting in the left-hand list has a circular arrow button. Clicking it puts that setting back to its value in shared/config.lua and saves it immediately — you don't need to click Save afterwards. Settings that are grouped together (Battery, Home screen, App Store, Push notifications, Held pose) share the one arrow next to the group name, so clicking it resets every setting in that group at once.

Closing

Click Close or press ESC. Changes you haven't saved are thrown away.

When changes take effect

Each table below has a Takes effect column:

• Right away: applies as soon as you save, even on tablets that are already open.
• Next open: applies the next time someone opens a tablet. Tablets that are open now keep the old value until they are put away.

Core: General

The master switch and how ESC behaves.

Core: Tablet Items

Which inventory items open the tablet, and what each one shows.

Each row in Tablet items has:

Core: Devices

Appearance: Home Screen

Limits for the home screens players arrange, and the wallpaper pictures they can choose from.

Each wallpaper row has:

Adding your own picture

• A row with an invalid Id or Image is skipped and doesn't appear in the picker.
• If you remove a picture that someone is using, their tablet goes back to the default wallpaper.

Appearance: App Store

Every tablet has a built-in App Store. Scripts add apps to it, and players choose which ones to install on each tablet.

Appearance: Notifications

Notifications are the pop-up messages that apps send to the tablet.

Inside Sound:

For what players can change themselves (Do Not Disturb, muting single apps, and so on), see Settings App.

Appearance: Animation

The pose and tablet prop players hold while the tablet is open. Other players see this too.

Inside Prop:

If the pose looks wrong after an edit, click the circular arrow next to Held pose to put the whole section, animation and prop alike, back to its defaults.

Advanced: Compatibility

When you need this: if a player's game version doesn't have the tablet prop, the tablet skips the prop and online admins get a message like:

[oxide-tablet] model "prop_cs_tablet" is not on this game build. Set a replacement in /tablet settings.

Add a row with prop_cs_tablet under Replace and a prop your players have under With, then click Save Changes.

Advanced: Advanced

Both settings in this section are on the Advanced tab.

Apps: Map App

Settings for the built-in Maps app. For how Maps works for players, see Maps App.

Step-by-step instructions for adding a location and overriding a detected blip are on the Maps App page.

Permissions

The tablet has one kind of permission: a player is either an admin or not. There are no per-command permissions and no admin levels. Commands marked Everyone need no permission at all, and the server console can always run every command that works there.

The tablet asks o-link whether a player is an admin. A player passes if they have either of these server permissions (called "ACE permissions" in FiveM):

• command
• admin

On ESX, players in an ESX admin group pass as well.

You may not need to change anything. The standard QBCore and QBX server.cfg already gives group.admin the command permission, so your existing framework admins can already use the admin commands.

Making someone an admin

Open your server.cfg (the text file that tells your server what to start and who has which permissions) and add these two lines:

add_principal identifier.license:<id> group.admin
add_ace       group.admin             admin allow

• The first line puts the player in the admin group. Replace <id> with the player's license identifier. You can find it on the player's page in txAdmin; it's the long text after license:.
• The second line gives everyone in the admin group the admin permission. You only need this line once, however many admins you add.

Save the file and restart your server.

If an admin still gets "You do not have permission.", check that the license in server.cfg matches the player exactly, and that you restarted the server after saving.

Next Steps