Installation Guide

1

Install (or update) dependencies and optional

Verify all dependencies below are started before this script in your server.cfg.Required

Resource	Purpose
oxmysql	Database driver for player data, ranking, and match history. Download oxmysql​
Framework	One of: qb-core, qbx_core (QBox), es_extended (ESX Legacy)
Inventory	One of: ox_inventory, qb-inventory, qs-inventory

Optional

Resource	Purpose
ox_lib	Enhanced notifications. Download ox_lib​
ox_target or qb-target	Target-based board interaction (alternative to DrawText)

2

Install cdev_ludus and create a new subfolder or extract folder to server's root

nstall resource from Portal

After installing, you should get a zip file with the name shown below.

• cdev_ludus.pack.zip

Create a new subfolder optional step, but is highly recommended.

If you haven’t already, create a new subfolder named [cdev] in your server’s root resources directory. Unzip (extract) this script into the newly created [cdev] subfolder.

3

Add ACE permission

Open your server.cfg and add the following ACE permission:

add_ace group.admin cdev_ludus.admin allow

or

add_ace identifier.license:xxxxxxxxxxxx cdev_ludus.admin allow

Important: If you are on the Qbox framework, the recommended place to paste the above permission is inside the permissions.cfg file instead of server.cfg.

4

Update server.cfg & perform a full restart

Once all other steps are completed, open your server.cfg & add ensure cdev_ludus to the very bottom of your resource start list (after oxmysql, your framework, inventory, and target if used). Finally, perform a full server restart. Failure to perform a full restart after installation will cause errors.

Note: Once completed, use /ludusgaming in-game to open the hub, or use the Ludus board item to place a table and play!

Database: tables are created automatically on first start (cdev_ludus_players, cdev_ludus_match_history, cdev_ludus_player_history). No manual SQL import is required.

5

Add the Ludus board item

The item name must match LudusConfig.Item.name (default: ludus_board). Follow the guide for your inventory:

Ox Inventory

Location: ox_inventory → data → items.lua

1. Open resources/[ox]/ox_inventory/data/items.lua

2. Add the item inside the return table (with other items):

['ludus_board'] = {
    label = 'Ludus Board',
    weight = 500,
    stack = true,
    close = true,
    consume = 0,
    description = 'Use to place a Ludus table. Aim, rotate, then press E to confirm.',
    server = {
        export = 'cdev_ludus.useLudusBoard'
    }
},

Important: keep consume = 0. The resource removes the item when placement starts and returns it if you cancel. Do not set consume = 1.

1. Add the image ludus_board.png to your inventory's images folder (e.g. ox_inventory/web/images/).

2. Save the file and perform a full server restart.

Qb Inventory

Location: qb-core → shared → items.lua

1. Open resources/[qb]/qb-core/shared/items.lua

2. Add the item inside the QBCore.Shared.Items table:

['ludo_board'] = {
    name = 'ludo_board',
    label = 'Ludo Board',
    weight = 500,
    type = 'item',
    image = 'ludo_board.png',
    unique = false,
    useable = true,
    shouldClose = true,
    description = 'Use to place a Ludo table. Aim, rotate, then press E to confirm.',
},

1. Add the image ludo_board.png to your inventory's images folder (e.g. qb-inventory/html/images/).

2. Save the file and perform a full server restart.

QS Inventory

Location: depends on your framework:

• QBCore: qb-core → shared → items.lua

• ESX: qs-inventory → shared → items.lua

1. Open the items file for your framework.

2. Add the Ludo board item in the same format as your other items. Example:

['ludo_board'] = {
    name = 'ludo_board',
    label = 'Ludo Board',
    weight = 500,
    type = 'item',
    image = 'ludo_board.png',
    unique = false,
    useable = true,
    shouldClose = true,
    description = 'Use to place a Ludo table. Aim, rotate, then press E to confirm.',
},

1. Add ludo_board.png to your inventory's images folder.

2. Save the file and perform a full server restart.

If you have a custom framework, custom notify, custom inventory, and custom target, please read our configuration documentation so you can understand how to adapt it by clicking the link below.

6

Stream models checklist

Ensure the resource includes the stream/ folder with the Ludus models and cdev_board_game.ytyp.

Default models:

Prop	Model name
Board	cdev_board
Dice	cdev_player_dice
Pawns	cdev_player_red / blue / green / yellow

Furniture uses native GTA props (prop_table_02, prop_chair_02). Stake chips use Diamond Casino props (vw_prop_chip_*) with a cash-pile fallback.

Do not rename stream files unless you also update LudusConfig.Props in public/shared/config.lua.