Installation Guide

This guide takes you from a fresh download to a working tablet. Every step says exactly what to do and what you should see when it worked. You don't need to know any Lua — the only files you open are server.cfg, one item file in your inventory, and (optionally) the tablet's settings file.

Prerequisites

Required resources

These must be installed and running on your server. Most servers already run ox_lib and oxmysql.

A supported inventory

The tablet opens from an inventory item, so o-link has to be able to read your inventory. o-link supports these inventory resources: ox_inventory, qb-inventory, ps-inventory, qs-inventory, codem-inventory, core_inventory, origen_inventory, tgiann-inventory, jpr-inventory, ak47_qb_inventory and hex_4_inventory.

Supported frameworks

Everything goes through o-link, so you install one copy of the tablet and it works on whichever framework you run.

Apps from other resources

The tablet comes with three apps of its own: App Store, Settings and Maps. That is everything it ships with. Any other resource can add its own screen as an app, if the version you run supports the tablet. You don't set that up here: when both resources are running, the app shows up in the App Store on its own. Those resources never require the tablet — if you remove it, they go back to their own screens.

Installation Steps

Load Order

Every Oxide resource uses the same four-part order in server.cfg:

# 1. Framework — everything your framework requires (qb-core, es_extended, qbx_core, etc.)
ensure <framework>

# 2. Scripts — your other resources (phone, inventory, garages, etc.)
ensure <your-other-scripts>

# 3. o-link — the bridge. Starts after your framework/scripts, before any Oxide resource.
ensure o-link

# 4. Oxide resources — keep these together, ideally in a folder named [oxide]
ensure oxide-tablet

• Your inventory belongs in part 2, above o-link. o-link looks for your framework and inventory at the moment it starts. If they aren't running yet, the tablet item won't work.
• Don't put oxide-tablet above o-link. The tablet lists o-link as a dependency, so starting the tablet first makes the server start o-link early, before your framework. o-link then can't find your framework, and nothing works properly.
• If your Oxide resources are in an [oxide] folder, one ensure [oxide] line in part 4 starts them all. Within part 4 the order doesn't matter — the tablet and the resources that add apps find each other whichever starts first.
• If you restart o-link while the server is running, restart oxide-tablet afterwards too. Restarting the whole server is the safest option.

Framework Setup

What the tablet item needs

The tablet opens when a player uses an inventory item. By default that item is named tablet. The item must be set up like this:

You don't set up the IMEI yourself. The first time a tablet is used, the tablet writes the IMEI onto the item automatically.

Item icon

A ready-made icon ships in this resource at itemimages/tablet.png. Copy it into your inventory's image folder:

If a tablet.png is already in that folder, you can keep the one you have or replace it with this one. Without any icon the item still works — it just shows a blank picture.

Database Setup

You don't need to import anything. The tablet creates its tables automatically the first time it starts:

A copy of these table definitions ships in sql/install.sql. You only need it if your database user isn't allowed to create tables. In that case, import sql/install.sql once using your database manager (the program you use to look at your server's database, such as HeidiSQL, phpMyAdmin, or the database page in your hosting panel). The file is safe to run on a database that already has these tables: it only creates tables that are missing.

Configure Before the First Start

Open shared/config.lua (the tablet's settings file) and look at these three settings. Everything else can wait; the full list is in Configuration.

Config.RequireItem

Config.RequireItem = true

• true (default): the keybind and /tablet open only work while the player carries a tablet item.
• false: anyone can open the tablet with the keybind or /tablet open, with no item. Home screens are then saved per character. Using a tablet item still works as normal.

An app that its own resource opens directly (through that resource's own command, item or menu) never needs a tablet item.

Config.Items

Config.Items = {
    { item = 'tablet', apps = {} },
}

This is the list of inventory items that open the tablet.

• item is the item name exactly as your inventory spells it.
• apps = {} (empty) makes a normal tablet. Players install apps from the App Store.
• A filled-in apps list makes a locked tablet. It shows only the apps listed (plus the Settings app), and the App Store isn't offered. App names are app IDs from the resource that adds the app, listed in that resource's documentation.

Here is an example with a second item. It turns a work-issued item into a tablet that only shows one app:

Config.Items = {
    { item = 'tablet', apps = {} },
    { item = 'work_tablet', apps = { 'their_app' } },   -- only that one app
}

Every item you list must also exist in your inventory and be set up as described in Framework Setup.

Config.OpenKey

Config.OpenKey = ''

The default key that opens the tablet. It's empty by default, which means no key is bound. Players can still bind their own key in game: Esc → Settings → Key Bindings → FiveM → Open tablet.

To set a default key, put the key name in the quotes, for example Config.OpenKey = 'F10'. A default only applies to players who have never joined your server. Anyone who has joined before keeps their own binding.

Good to know: the App Store

Apps from other resources don't appear on anyone's home screen by themselves. Each player installs them from the tablet's App Store. If you'd rather every tablet had certain apps, or every app installed automatically, see Config.Store in Configuration.

Custom Wallpapers (Optional)

The tablet has 8 built-in wallpapers. You can add your own images too:

Config.Home = {
    dockSize = 6,
    maxPages = 5,
    wallpapers = {
        { id = 'skyline', label = 'Skyline', url = 'skyline.jpg' },
    },
}

A full https:// web address also works as the url. Plain http:// addresses are not accepted.

Keep an image's id the same once players have picked it. Saved home screens remember the id, not the file name. If you change or remove the id, those players go back to the default wallpaper.

Players pick a wallpaper on the home screen: they right-click the home screen (or press and hold an app, or press the pen button in the corner), then press Wallpaper and choose from Images.

Admin Access

The admin parts of the tablet (/tablet settings, /tablet wipe and /tablet notify) use o-link's admin check. A player passes if they have the admin or command permission. On ESX, members of an ESX admin group pass too.

• Most QBCore and QBX servers already give their group.admin group the command permission in server.cfg, so existing admins work straight away.

• Otherwise, add these two lines to your server.cfg, replacing YOUR_LICENSE with the admin's license identifier:

  add_principal identifier.license:YOUR_LICENSE group.admin
  add_ace group.admin admin allow

The full command list is in Admin Tools.

Verification

[INFO][oxide-tablet][boot] tablet ready
  {"items":1,"requireItem":true}

/giveitem YOUR_ID tablet 1

If any step doesn't match what you see, go to Troubleshooting.

Next Steps