Skip to content

Installation

Install Cuxial Tablet step by step: dependencies, the coins account, the media relay, start order and first start.

Cuxial Tablet creates its own tables and adds no inventory items. Before it starts you need the common base, a money account for the coins and, if you want to use the VIP shop, an inventory.

Check the dependencies ​

These resources must be installed and working before you add the tablet:

  • A framework: QBox (qbx_core), QBCore (qb-core) or ESX (es_extended)
  • ox_lib
  • oxmysql
  • cuxial_bridge 2.17.0 or later
  • An inventory: ox_inventory, or qb-inventory on QBCore
  • OneSync enabled on the server

Update Cuxial Bridge to 2.17.0 or later before starting the tablet. The live streams use the media module added in that version.

The optional integrations are listed in the Overview. None of them is needed to start.

Copy the resource ​

Place the cuxial_tablet folder inside your resources directory. Keep the folder name as it is.

Create the coins account ​

The VIP area is paid with a money account of your framework. By default it is called coins; the name is set in vip.account of shared/config.lua. Create it before the first start.

Add coins to the money types of qbx_core:

qbx_core/config/shared.lua
lua
money = {
    moneyTypes = {
        cash = 0,
        bank = 0,
        crypto = 0,
        coins = 0,
    },
    ...
}

Restart the server after editing the framework configuration. If you prefer to use an account that already exists, write its name in vip.account.

Set the language ​

The interface, the notifications and the key names follow the ox:locale convar. en and es are included.

server.cfg
cfg
setr ox:locale "en"

Optional: the media relay for live streams ​

Live streams travel through the media module of Cuxial Bridge. Without a relay, the video is sent through the game server at reduced quality, and the server's upload grows with each viewer. With a relay, broadcasters publish at the full profile set in live.enc and the game server does not touch the video.

The relay is configured in Cuxial Bridge, with three convars read on the server:

server.cfg
cfg
set sd_phone_relay_url "wss://YOUR_RELAY_HOST/PATH"
set sd_phone_relay_key "YOUR_64_CHARACTER_HEX_KEY"
set sd_phone_relay_ttl "45"

Write the relay key with set, never with setr. setr sends the value to every player.

The address must start with ws:// or wss:// and the key must be exactly 64 lowercase hexadecimal characters; anything else is ignored and the streams go through the game server.

Start the resource ​

Start the tablet after the framework, the inventory and Cuxial Bridge:

server.cfg
cfg
ensure oxmysql
ensure ox_lib
ensure qbx_core
ensure ox_inventory
ensure cuxial_bridge
ensure cuxial_tablet

On QBCore, qb-inventory can be replaced by ox_inventory. If you use cuxial_jobs, start it before the tablet so completed jobs give pass XP.

On the first start the tablet creates its twenty tables (cuxial_tablet_*) and writes the factory settings and catalogues into cuxial_tablet_settings. There is no SQL file to import.

Check that it works ​

  1. Join the server and load a character.
  2. Press F1. The tablet opens on the profile page.
  3. Open the VIP page. The coin balance reads 0.
  4. With a staff account, type /tabletadmin. The admin panel opens. Give yourself a few coins from the Operations tab and buy something from the shop.

Next: adjust the catalogues and the rules in Configuration, or learn how each page works in the Features guide.

© Cuxial