⚙️Installation Guide
Install (or update) dependencies and optional
Verify all dependencies below are started before this script in your server.cfg.
Required
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
ox_lib
Enhanced notifications. Download ox_lib
ox_target or qb-target
Target-based board interaction (alternative to DrawText)
Install cDev_Checkers and create a new subfolder or extract folder to server's root
Install resource from Portal
After installing, you should get a zip file with the name shown below.
cdev_checkers.pack.zip
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.
Add ACE permission
Open your server.cfg and add the following ACE permission:
add_ace group.admin cdev_checkers.admin allowor
add_ace identifier.license:xxxxxxxxxxxx cdev_checkers.admin allowImportant: 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.
Update server.cfg & perform a full restart
Once all other steps are completed, open your server.cfg & add ensure cdev_checkers 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 the command /checkersranking in-game to open the leaderboard, or use the checkers board item to place a board and play!
Add the checkers board item
The item name must match CheckersConfig.Item.name (default: checkers_board). Follow the guide for your inventory:
Location: ox_inventory → data → items.lua
Open
resources/[ox]/ox_inventory/data/items.luaAdd the item inside the return table (with other items):
['checkers_board'] = {
label = 'Checkers Board',
weight = 500,
stack = false,
close = true,
consume = 0,
description = 'Use to play checkers with a nearby player. Place it, then use E to open and choose side.',
server = {
export = 'cdev_checkers.useCheckersBoard'
}
},Add the image
checkers_board.pngto your inventory's images folder (e.g.ox_inventory/web/images/.Save the file and perform a full server restart. Failure to perform a full restart after installation will cause errors.
Location: qb-core → shared → items.lua
Open
resources/[qb]/qb-core/shared/items.luaAdd the item inside the
QBCore.Shared.Itemstable:
['checkers_board'] = {
name = 'checkers_board',
label = 'Checkers Board',
weight = 500,
type = 'item',
image = 'checkers_board.png',
unique = false,
useable = true,
shouldClose = true,
description = 'Use to play checkers with a nearby player. Place it, then use E to open and choose side.',
},Add the image
chess_board.pngto your inventory's images folder (e.g.qb-inventory/html/images/Save the file and perform a full server restart. Failure to perform a full restart after installation will cause errors.
Location: depends on your framework:
QBCore:
qb-core→shared→items.luaESX:
qs-inventory→shared→items.lua
Open the items file for your framework.
Add the chess board item in the same format as your other items. Example (adjust to match your file structure):
Add
checkers_board.pngto your inventory's images folder.Save the file and perform a full server restart. Failure to perform a full restart after installation will cause errors.
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.
Last updated