Integrating LD Refund System with ESX and QB Core Frameworks

LD Refund System is designed to work seamlessly with the most popular FiveM frameworks. Whether you're running ESX Legacy, QB Core, or a hybrid setup, this guide walks you through the integration process from initial configuration to your first successful refund.

Before you begin

• Ensure your framework is up to date (ESX 1.9+ or QB Core latest)
• Have your LD Refund System license key ready
• Back up your database before making any changes
• Prepare a test character for validation

ESX Legacy integration

ESX Legacy uses the modern shared object pattern. LD Refund System auto-detects your ESX installation and configures exports accordingly.

-- config.lua
Config = {}
Config.Framework = 'esx' -- Auto-detected, but can be forced
Config.ESXExport = 'es_extended' -- Your ESX resource name
Config.InventorySystem = 'auto' -- Supports ox_inventory, esx_inventory, qs-inventory

After setting your configuration, the system automatically hooks into ESX player loading events, money functions, and inventory APIs. No manual exports required.

QB Core integration

QB Core's modular design makes integration straightforward. LD Refund System connects through the QBCore object and respects your existing permission structure.

-- config.lua
Config = {}
Config.Framework = 'qbcore' -- Auto-detected
Config.QBExport = 'qb-core' -- Your QB Core resource name
Config.InventorySystem = 'auto' -- Supports qb-inventory, ox_inventory, qs-inventory

Database configuration

Both frameworks require database access for player lookups. LD Refund System uses your existing database connection and creates its own tables for refund tracking. No modifications to framework tables are needed.

1. Ensure oxmysql or mysql-async is properly configured
2. Run the provided SQL migration script
3. Verify the connection with /ldrefund testdb in-game
4. Check the server console for any permission errors

Common integration issues

Framework not detected

If auto-detection fails, check that your framework resource starts before LD Refund System. Add the dependency to your fxmanifest.lua or adjust your resource load order in server.cfg.

Items not appearing in inventory

Verify that item names in your refund match your inventory system's item registry exactly. Case sensitivity matters. Use /ldrefund validateitems to check for mismatches.

Money refunds showing wrong account

Configure the correct money account names for your framework. ESX typically uses 'money' and 'bank', while QB Core uses 'cash' and 'bank'. Check your framework's documentation for exact account names.

With proper integration, your staff can issue refunds from Discord and players receive items instantly in-game. The entire flow takes seconds, not hours.