Installation

🎉 Dime Skills v1.9.0 - Advanced skill system for FiveM servers

This guide covers fresh installation of Dime Skills v1.9.0.

Upgrading from v1.7.x? See the Migration Guide instead. Database migration is required!

Prerequisites

Before installing Dime Skills, ensure you have:

Server Requirements

FiveM server (artifact 22443 recommended)
Lua 5.4 enabled in your server configuration
MySQL 8.0+ or MariaDB 10.6+ database server

Required Dependencies

Important

Both dependencies MUST be installed and started before Dime Skills.

ox_lib

overextended/ox_lib

375

Required Features:

UI components (context, notify, etc.)
Callback system
Locale system
Utility functions

Installation:

# Download latest release from GitHub
# Extract to your resources folder
# Add to server.cfg: ensure ox_lib

oxmysql

overextended/oxmysql

343

Required Features:

Async MySQL queries
Transaction support
Prepared statements
Connection pooling

Configuration Required: Ensure oxmysql is properly configured to connect to your database.

-- In your server.cfg or convar settings
set mysql_connection_string "mysql://user:password@localhost/database"

Framework

Dime Skills supports multiple frameworks:

QBOX (Recommended)
ESX (Legacy/Extended)
OX (Overextended)
QB-Core
Custom (with bridge customization)

Fresh Installation

These steps are for NEW installations only. If you're upgrading from v1.7.x, follow the Migration Guide.

Installation Steps

Download the Resource

After purchasing, download the dime_skills resource from your purchase page.

Extract to Resources Folder

# Extract to your resources directory
cd resources/[your-scripts]
# Extract dime_skills.zip here

Your structure should look like:

fxmanifest.lua

db.sql

Import Database

Import the included SQL file to create the necessary database tables:

-- Using MySQL CLI
mysql -u your_username -p your_database < db.sql

-- Or import through phpMyAdmin/Adminer

The script creates the player_skills table with columns for each skill.

Configure the Resource

Edit shared/config.lua to match your server setup:

return {
    Framework = 'QBOX', -- Change to your framework: QBOX, ESX, OX, QBCORE, Custom
    
    -- Basic settings
    skillNotify = 'UI', -- UI or ox_lib
    keybind = 'U', -- false to disable
    command = 'skills',
    
    Debug = false, -- Enable for troubleshooting
    
    -- Other settings...
}

See the Configuration Guide for detailed config options.

Update server.cfg

Add the resource to your server configuration file:

# Ensure dependencies start first
ensure ox_lib
ensure oxmysql

# Ensure your framework
ensure qbx_core  # or esx, ox, qb-core

# Start dime_skills
ensure dime_skills

Resource order matters! Always start dependencies before dime_skills.

Configure Framework Bridge (if needed)

If you're using a custom framework or need to modify bridge behavior:

Navigate to bridge/client/ or bridge/server/
Find your framework's bridge file (e.g., qbox.lua)
Modify as needed (these files are not escrowed)

-- Example: bridge/server/qbox.lua
function getPlayerIdentifier(source)
    local player = exports.qbx_core:GetPlayer(source)
    return player?.PlayerData?.citizenid
end

Restart Server

Restart your FiveM server to apply changes:

# In server console or txAdmin
restart myserver

# Or using screen/tmux
# Stop and start the server

Verification

After installation, verify everything is working:

Check Console

Look for initialization messages in the server console:

[dime_skills] [INFO] Checking skills database
[dime_skills] [INFO] Skills database verified
[dime_skills] [INFO] Resource started successfully

Test In-Game

Join your server
Press U (or your configured keybind)
The skills UI should open
You should see all configured skills

Check F8 Console

Open the client console (F8) and check for errors:

No red errors related to dime_skills
Skills data loaded successfully

Optional: ox_inventory Integration

If you want to use skill requirements in crafting:

Enable in Config

craftingSkills = true, -- Set to true in config.lua

Configure Recipes

Edit your ox_inventory recipes to include skill requirements:

-- In ox_inventory/data/items.lua or your recipe file
['weapon_pistol'] = {
    duration = 5000,
    skills = {
        required = {
            weaponary = 5  -- Requires level 5 weaponary
        },
        reward = {
            weaponary = 10  -- Grants 10 XP on success
        }
    },
    -- ... other recipe data
}