Features

What oxide-tablet does in game: what players see, what they can do, and how the settings you choose change that. For every setting and its default value, see Configuration.

What the Tablet Is

oxide-tablet puts a tablet on your players' screens. It has a home screen, an App Store, notifications and a few built-in apps. Other resources can add their own screens to it as apps (full-screen programs) and widgets (small live cards on the home screen). The tablet works with QBCore, ESX and QBX through o-link, the bridge you install once so Oxide resources work on any of those frameworks.

• One Tablet, Many Apps — Any resource that supports the tablet can put its screen on it as an app, so players open those screens from one device instead of separate windows. No apps from other resources ship with the tablet; each one comes from the resource that adds it
• Real, Physical Tablets — Each tablet item gets its own serial number (an IMEI) the first time it is used. Its home screen, installed apps and settings stay with that item, even when it changes hands
• Personal Home Screens — Players arrange apps and widgets across pages, fill a dock, pick a wallpaper and name their tablet
• Notifications — Apps post alerts that show as banners, collect in a tray and pop up as small bubbles when the tablet is put away
• Admin Settings Menu — Admins change almost every setting in game with /tablet settings, with no restart

Opening and Closing the Tablet

A large tablet appears in the middle of the screen and the game behind it dims. While it is open, the player's mouse controls the tablet, and their character holds a tablet prop (see Hold Animation and Prop).

Ways to Open It

• Tablet items — The items listed in Config.Items open the tablet when used. The default item is tablet.
• Keybind — There is no key by default. Players bind one in Settings → Key Bindings → FiveM → Open tablet in the GTA pause menu. You can set a default key for new players with Config.OpenKey.
• Several tablets in one inventory — Using an item opens that exact tablet. The keybind and /tablet open open the tablet in the lowest inventory slot.
• No tablet — With Config.RequireItem on, a player without a tablet item who presses the key sees "You don't have a tablet."
• Opened by another resource — A resource that opens its own app does not need the player to hold a tablet item or to have installed that app. The app stays on screen until the player goes back to the home screen.

Ways to Close It

• Press the keybind again, or use the tablet item again.
• Press ESC on the home screen.
• The tablet also closes by itself when:
  • the player dies or is downed (see below)
  • the tablet item leaves their inventory while it is open, for example when it is dropped, stolen or seized (checked every 5 seconds for tablets that have an IMEI)
  • the battery runs out (see Battery)
  • the player logs out or switches character
  • an admin turns the tablet off (Config.Enabled)
  • the admin opens the /tablet settings menu

What ESC Does

Each press of ESC closes one thing at a time, starting with whatever is on top:

1. The notification tray.
2. An app's page in the App Store (goes back to the list).
3. A drag in progress, an open panel (App Library, Widgets, Wallpaper, Rename) or edit mode on the home screen.
4. With an app open: goes back to the home screen when Config.EscapeBehavior is 'home' (the default), or puts the tablet away when it is 'close'.
5. On the home screen: puts the tablet away.

The round home button on the tablet's bottom edge works the same way, except it never puts the tablet away: it closes the tray, leaves the app, or closes a panel or edit mode.

Dead or Downed Players

• A dead or downed player cannot open the tablet. They see "You can't use a tablet while you're down."
• If a player dies or goes down with the tablet open, it closes within about half a second.
• This works when your death or ambulance script reports death and downed status through o-link.

The Home Screen

The home screen is what players see when the tablet opens.

• Clock — The time and date come from the player's own computer clock, not the in-game clock.
• Battery — A tablet item with an IMEI shows its real charge, and the bar inside the icon turns red at 20% or less. See Battery. On a tablet without a battery, or with battery drain turned off, the icon is decoration that drifts slowly with the time of day.
• Changing pages — Click a page dot, press the left or right arrow key, or scroll sideways (or hold Shift and scroll).
• Nothing installed yet — While only the App Store and Settings are on the tablet, the home screen suggests opening the App Store.

The Default Layout

A tablet that has never been edited arranges itself:

1. The Calendar and ID widgets come first, at small size.
2. Apps follow in the order their resources asked for.
3. The dock is only used when there are more apps than the dock can hold. Then the first 4 apps go into the dock, or fewer if the dock is smaller than that.
4. Apps installed later land in the first free space on the pages.

Editing the Home Screen

Players customize their own home screen. Everything they change is saved to the tablet item (or to their character — see Where Things Are Saved).

Entering Edit Mode

Any of these turns on edit mode:

• Click the pen icon in the bottom corner.
• Right-click an empty part of the home screen.
• Press and hold an app or widget for half a second. It also picks the item up so the player can drag it.

In edit mode, apps and widgets wiggle, the status bar is replaced by an edit toolbar, and each item gets a small minus button. Press Done (or ESC) to finish.

What Players Can Do

A message in the toolbar warns "Changes will not be kept" when there is nowhere to save them (no tablet item and no loaded character).

App Library

The App Library lists every app on the tablet in three groups, with a search box:

• On home screen — Apps on a page or in the dock. Each has Remove from home.
• Not on home screen — Apps that did not fit anywhere. Each has Add to home.
• Hidden — Apps the player took off the home screen. Each has Add to home.

Clicking an app's icon opens it. When the App Store is on, an Open App Store button sits at the bottom.

Wallpaper

The wallpaper panel has two rows:

• Presets — 8 built-in dark backgrounds: Oxide (the default), Ember, Rust, Forge, Midnight, Graphite, Carbon and Slate.
• Images — Pictures you add in Config.Home.wallpapers. If you have not added any, the row says "Your server has not added any wallpaper images."

The Default button puts the Oxide preset back. Players can only choose from this list; they cannot paste their own image links. If you later remove an image from the list, players who picked it go back to the default wallpaper. See Configuration → Home Screen to add images.

Renaming

• Players can name a tablet that was opened from an item. The name is 1 to 40 characters.
• The name shows in the App Store sidebar, on the ID widget, and in the Settings app.
• The name belongs to the tablet item, so it moves with the item when it changes hands.
• A tablet opened without an item (keybind with Config.RequireItem off, or opened by another resource) has no name to change.

Limits

If you lower Config.Home.maxPages or Config.Home.dockSize, no apps are lost. Apps from the removed pages or dock slots move into the App Library, under Not on home screen, and drop back onto a page the next time the player edits their home screen. Widgets on a removed page are taken off and can be added again.

Widgets

Widgets are small cards on the home screen that show live information. Players choose which widgets to place, at which size, and on which page. Nothing is added to their screen without them choosing it.

Widget Sizes

Each widget decides which of these sizes it allows.

Built-in Widgets

The Widgets Panel

Widgets from Other Resources

• A widget can belong to an app. Tapping it opens that app, and it shows the app's badge.
• A widget that belongs to an app only appears while that app is installed and available to the player. When the app goes away, the widget disappears, and it comes back in the same spot when the app returns.
• A widget whose data has not arrived yet shows a loading placeholder.

Built-in Apps

The tablet ships with three apps of its own.

An app ID is the short internal name of an app. You use app IDs in Config.Items and Config.Store.preinstalled.

Settings App

Players use the Settings app to control how notifications reach them (Do Not Disturb, banners, sound, volume and per-app mutes), to turn on accessibility options (reduce motion, larger text, bold text), to rename the tablet, and to reset the layout or their settings. Their choices are saved with the tablet item, or with the character when there is no item.

See Settings App for everything the Settings app does.

Maps App

Maps shows a map of the city with places players can search and set a GPS waypoint to. Admins add public places and rename or restyle existing map blips from /tablet settings, and Maps can also list the location blips each player already has on their game map. It draws the GPS route to the current waypoint.

See Maps App for everything the Maps app does.

The App Store

Apps from other resources do not appear on a tablet by themselves. Each tablet has an App Store where players install the apps they want. This keeps home screens tidy and lets two players carry very different tablets.

How It Works

• Per tablet — Installing an app on one tablet does not install it on any other tablet. When there is no tablet item, installs are saved to the character instead.
• Uninstalled apps — Their widgets and notifications are hidden too.
• Not saved — When there is no tablet item and no loaded character, the store warns "Installs will not be kept".

Browsing the Store

The store's sidebar also shows the tablet's name and how many apps are installed.

Preinstalled Apps

Apps you list in Config.Store.preinstalled are installed on every normal tablet. They show a Built-in lock in the store and players cannot uninstall them. They still follow the app's own job or gang rules (see Who Sees Which Apps).

When the App Store Is Turned Off

With Config.Store.enabled = false:

• The App Store app disappears from every tablet.
• Every app a player is allowed to use appears on their home screen automatically.
• Players cannot install or uninstall anything.
• Installs players made earlier are kept in the database and come back if you turn the store on again.

Curated Tablet Items

A tablet item with an apps list in Config.Items is a curated device: a tablet built for one purpose, such as a work-issued tablet that only runs one app.

• It shows only the apps in its list, plus the Settings app.
• It has no App Store. Nothing can be installed or uninstalled on it.
• Config.Store.preinstalled does not add anything to it.
• Listed apps still follow their own job or gang rules. A job-specific tablet handed to a civilian shows nothing but Settings.

See Configuration → Tablet Items for how to set one up.

What Players See, by Setup

Who Sees Which Apps

An app can limit who is allowed to use it. The resource that adds the app sets these rules, not the tablet's config.

• Jobs — Only players with one of the listed jobs.
• On duty — With a job rule, the player can also be required to be on duty.
• Gangs — Only members of one of the listed gangs.
• Jobs or gangs — When an app lists both, belonging to either one is enough.

These rules apply everywhere on the tablet:

• The App Store only lists apps the player is allowed to use.
• The home screen only shows allowed apps. An installed app hides when the player loses access (for example going off duty) and comes back in the same spot when they regain it.
• If the player loses access while the app is open, it closes and the tablet goes back to the home screen.
• Notifications and widgets for an app the player cannot use stay hidden.

Some resources handle this another way: they only add their app for players who qualify, such as boss menus that only appear for bosses.

Notifications

Apps post notifications to the tablet, and the tablet shows them. Notifications are kept in each player's game while they play, whether the tablet is open or not.

While the Tablet Is Open

• Banner — A card drops in under the status bar with the app's icon, name, a title and the message. It stays for Config.Notifications.toastDuration (5 seconds by default).
  • Hovering over it pauses the timer.
  • Clicking it opens the app.
  • Swiping it up, or clicking its X, hides the banner. The notification stays in the tray.
  • No banner shows for an app that is already on screen, unless that app asks for one.
  • Several banners arriving together queue up and show one after another.
• Bell — The status bar shows a bell with the number of notifications (99+ above 99). It is highlighted when something new arrived since the tray was last opened.
• Tray — Tap the status bar to open the tray.
  • Notifications are grouped by app, newest first.
  • Click one to open its app. The notification is removed.
  • Click the X on one to dismiss it, the X on an app group to clear that app, or Clear all.
  • Tap the status bar again, or an empty area, to close the tray.

While the Tablet Is Put Away

• Bubbles — A small card springs in at the bottom right of the game screen. Up to 3 stack, newest on top, and each disappears after Config.Notifications.toastDuration.
• Bubbles are only a heads-up. The notification waits in the tray for the next time the tablet is opened.
• Bubbles only appear for apps installed on the tablet the player carried when their character loaded, or on the tablet they last opened. Preinstalled apps always qualify, and so does every allowed app when the App Store is off.
• Turn bubbles off for everyone with Config.Notifications.showWhenClosed = false.

Sound

• A short sound plays with each banner or bubble. The tablet ships its own sound file, so no audio resource is needed.
• Loudness is your volume (Config.Notifications.sound.volume) multiplied by the player's own volume slider in the Settings app. Players can make it quieter, never louder.
• Turn sound off for everyone with Config.Notifications.sound.enabled = false.

App Badges

• An app's icon shows a red number badge. It is whichever is larger: the count the app sets itself, or the number of notifications waiting for that app.
• A widget that belongs to the app shows the same badge.

Player Controls

In the Settings app, players can turn on Do Not Disturb, turn off banners and bubbles, turn off sound, change the volume, and switch notifications off for individual apps. See Settings App.

How Long Notifications Last

Notifications are not saved to the database. A notification disappears when:

• the player taps or dismisses it
• the player logs out or switches character
• the app that sent it is removed, or its resource stops
• the player has more than Config.Notifications.maxStored (100 by default); the oldest go first

With Config.Notifications.enabled = false, apps cannot post notifications at all.

Tablet Devices and IMEI Numbers

Every tablet item becomes its own device. This lets a tablet keep its layout, apps and settings no matter who is holding it.

How a Tablet Gets Its IMEI

Players can check a tablet's IMEI:

• /tablet device shows the name and IMEI of the tablet they are carrying (the one in the lowest slot). A tablet that has never been used says it has not been activated yet.
• The ID widget and the Settings app's About page show the IMEI of the open tablet.

What Belongs to a Tablet

Dropped, Traded, Stolen or Seized

• Dropped or taken while open — The tablet closes within about 5 seconds of leaving the player's inventory.
• Given, sold or stolen — The new holder gets the same device: same name, home screen, installed apps and settings. Nothing is tied to the first owner.
• Moved to another slot — Still the same tablet. The IMEI goes with the item.

Battery

A tablet with an IMEI has a battery.

• It drains while it is out. By default it loses 0.5% a minute, so a full battery lasts 3 hours 20 minutes of use.
• It recharges while it is put away. By default it gains 1.5% a minute. This keeps counting while the player is offline.
• At 0% it shuts off. The tablet puts itself away with the message "The tablet's battery ran out." Trying to open it shows "This tablet's battery is dead. Put it away to let it charge, and ask an admin if it stays flat." It opens again once it has charged back to 1%, which takes about 40 seconds at the factory rate. With the recharge rate set to 0, a flat tablet stays flat until an admin runs /tablet wipe on it or turns battery drain off.
• The charge belongs to the item. Whoever holds the tablet next gets the same battery level.
• Tablets without an IMEI have no battery. That covers the keybind with Config.RequireItem off, a tablet another resource opened for its own app, and inventories that can't save an IMEI on items.

Server owners set the drain and recharge rates, or turn the battery off, under Devices → Battery in /tablet settings. See Configuration → Battery.

Wiping a Tablet

An admin can factory-reset a tablet with /tablet wipe <imei>:

• The name, home screen, installed apps and Settings app choices are cleared, and the battery goes back to 100%.
• The item keeps its IMEI.
• Anyone using that tablet at that moment sees it return to defaults straight away.

See Admin Tools → /tablet wipe for details.

Where Things Are Saved

Sometimes there is no tablet item to save to. The tablet then saves the same things to the player's character instead (in the tablet_profiles database table).

• With Config.RequireItem off, the keybind uses the character's home screen, but using a tablet item still opens that item's own device.
• When the inventory cannot store item data, the tablet logs a warning in the server console that tablets will not keep individual state.

Apps from Other Resources

The tablet ships with three apps of its own: the App Store, Settings and Maps. Everything else on it comes from other resources you install. Each one shows its own screen inside the tablet, so it looks and works the same as it does in its own window.

Opening an App

• Resource stops — When a resource stops or restarts, its apps and widgets leave the tablet, and an open app closes. They come back when the resource starts again.
• Tablet restarts — When oxide-tablet itself restarts, resources that support it add their apps again.

Which Apps You Get

That is up to the resources you run, not to the tablet. Any resource can add apps and widgets through o-link, and an app appears on its own the moment both resources are running. To find out whether a resource you own adds a tablet app, what its app ID is, and who it shows for, read that resource's own documentation.

• Apps from other resources still have to be installed from the App Store, unless you preinstall them or turn the store off.
• A resource that adds an app can still open in its own window when the tablet is not installed. Whether it uses the tablet is set in that resource's own config.
• Want to add an app of your own? See Building Apps and Widgets.

Hold Animation and Prop

While the tablet is open, the player's character holds a tablet in their hands.

• Pose — An upper-body animation that loops, so the player can still walk and drive with the tablet out.
• Prop — A tablet model (prop_cs_tablet by default) attached to the hand. Other players see it.
• Put away — Closing the tablet stops the animation and deletes the prop.
• Every app — The tablet plays the same pose whichever app is on screen, including apps from other resources.
• Missing prop model — If the prop model is not available on your game build, the tablet skips the prop instead of freezing. It prints a warning in the player's F8 console and sends a notification to online admins naming the model and pointing at /tablet settings. Replace the model in Config.ModelSwaps.

Turn the pose and prop off, or change them, in Config.HoldAnimation.

Admin Settings Menu

Admins change the tablet's settings in game by typing /tablet settings.

• The Tablet Settings window lists settings in sections: General, Tablet Items, Devices, Home Screen, App Store, Notifications, Animation, Compatibility, Advanced and Map App.
• The Basic tab shows most settings. The Advanced tab shows the default keybind, the app load timeout and debug logging.
• A search box finds settings by name.
• Press Save Changes to apply. Almost every change takes effect right away, with no restart.
• The reset arrow next to a setting puts it back to its default.
• Opening the menu puts away the admin's own tablet if it is open.

The config file and the menu work together in a specific way. Read How Settings Work before you change anything.

Player Commands and Keybind

See Admin Tools for full command details and permissions.

Next Steps