Installation
1. Download Resource
Download the purchased resource from CFX Portal - the official site of FiveM with purchased resources.
2. Import Database Tables
This is a very important step - without it, the script will not work properly. Depending on the framework you are using (ESX, QBCORE or QBOX), select the appropriate section below and paste the SQL code into your database.
SQL for Database
-- Table for global purchased chains (limited edition tracking)
CREATE TABLE IF NOT EXISTS `orbit_purchased_chains` (
`id` INT(11) NOT NULL AUTO_INCREMENT,
`item` VARCHAR(50) NOT NULL,
`label` VARCHAR(100) NOT NULL,
`buyer_name` VARCHAR(100) NOT NULL,
`buyer_identifier` VARCHAR(100) NOT NULL,
`purchase_date` TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
PRIMARY KEY (`id`),
UNIQUE KEY `unique_item` (`item`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
-- Table for tracking players with stolen chains (legacy - kept for compatibility)
CREATE TABLE IF NOT EXISTS `orbit_chain_stolen` (
`identifier` VARCHAR(100) NOT NULL,
`stolen_at` TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
PRIMARY KEY (`identifier`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
-- Table for tracking currently equipped chains (persistence system)
-- This table stores what chain the player is wearing so it persists across disconnects/restarts
CREATE TABLE IF NOT EXISTS `orbit_equipped_chains` (
`identifier` VARCHAR(100) NOT NULL,
`item` VARCHAR(50) NOT NULL,
`label` VARCHAR(100) NOT NULL,
`drawable` INT(11) NOT NULL,
`texture` INT(11) NOT NULL,
`equipped_at` TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
PRIMARY KEY (`identifier`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;3. Add Required Items
Add the items to your inventory system’s item file or database, then copy the images from orbit-chains/install/images into your inventory’s image folder.
ESX Installation
-- ============================================
-- ESX ORBIT CHAINS COMPLETE INSTALLATION
-- ============================================
-- This file contains everything needed for ESX
--
-- STEP 1: Run the SQL below in your database
-- ============================================
-- [[[ STEP 1: SQL DATABASE SETUP ]]]
-- Run this SQL in your database (phpMyAdmin, HeidiSQL, etc.):
-- Add chain items to ESX items table
INSERT INTO `items` (`name`, `label`, `weight`, `rare`, `can_remove`) VALUES
('gold_chain', 'Gold Chain', 1, 0, 1),
('silver_chain', 'Silver Chain', 1, 0, 1),
('diamond_chain', 'Diamond Chain', 1, 0, 1),
('platinum_chain', 'Platinum Chain', 1, 0, 1),
('stolen_chain', 'Stolen Chain', 1, 0, 1);
print("========================================")
print("ESX Orbit Chains Installation Complete")
print("========================================")
print("1. Run the SQL in your database")
print("2. Restart your server")
print("========================================")OX Inventory Installation
-- ============================================
-- OX INVENTORY ORBIT CHAINS COMPLETE INSTALLATION
-- ============================================
-- This file contains everything needed for OX Inventory
--
-- STEP 1: Add the Lua items to ox_inventory
-- STEP 2: Add the image files
-- ============================================
-- [[[ STEP 1: ADD TO OX INVENTORY ]]]
-- Copy and paste this code into: ox_inventory/data/items.lua
-- Add it with the other items, usually at the bottom or in alphabetical order
['gold_chain'] = {
label = 'Gold Chain',
weight = 200,
stack = false,
allowArmed = true,
consume = 1,
client = {
event = 'orbit-chains:useItem',
}
},
['silver_chain'] = {
label = 'Silver Chain',
weight = 200,
stack = false,
allowArmed = true,
consume = 1,
client = {
event = 'orbit-chains:useItem',
}
},
['diamond_chain'] = {
label = 'Diamond Chain',
weight = 250,
stack = false,
allowArmed = true,
consume = 1,
client = {
event = 'orbit-chains:useItem',
}
},
['platinum_chain'] = {
label = 'Platinum Chain',
weight = 300,
stack = false,
allowArmed = true,
consume = 1,
client = {
event = 'orbit-chains:useItem',
}
},
['stolen_chain'] = {
label = 'Stolen Chain',
weight = 300,
stack = false,
allowArmed = true,
consume = 1,
client = {
event = 'orbit-chains:useStolenChain',
}
},
-- [[[ STEP 2: ADD CHAIN IMAGES ]]]
-- You need PNG image files for each chain
-- Place them in: ox_inventory/web/images/
-- Required images:
-- - gold_chain.png
-- - silver_chain.png
-- - diamond_chain.png
-- - platinum_chain.png
-- - stolen_chain.png
print("========================================")
print("OX Inventory Orbit Chains Installation Complete")
print("========================================")
print("1. Add Lua code to ox_inventory/data/items.lua")
print("2. Add chain images to ox_inventory/web/images/")
print("3. Restart ox_inventory and orbit-chains")
print("========================================")4. Configuration
Configure config.lua to match your server framework and preferences, and add your own vapes as needed.
5. Start Resource
To start a resource in your server.cfg, ensure that it begins after your framework has been initiated. For instance, if you are using a framework like es_extended, you should start resource after it, like so:
Last updated