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
-- Stores speed buff timer (how many seconds of buff remaining)
CREATE TABLE IF NOT EXISTS `orbit_vape_state` (
`identifier` VARCHAR(80) NOT NULL,
`vape_name` VARCHAR(50) NOT NULL,
`remaining` INT NOT NULL DEFAULT 0,
`active` TINYINT(1) NOT NULL DEFAULT 0,
`updated_at` INT NOT NULL DEFAULT 0,
PRIMARY KEY (`identifier`, `vape_name`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
-- Stores vape hit durability (backup for inventories without metadata support)
CREATE TABLE IF NOT EXISTS `orbit_vape_hits` (
`identifier` VARCHAR(80) NOT NULL,
`vape_name` VARCHAR(50) NOT NULL,
`slot` INT NOT NULL DEFAULT 0,
`hits` INT NOT NULL DEFAULT 0,
`max_hits` INT NOT NULL DEFAULT 10,
`updated_at` INT NOT NULL DEFAULT 0,
PRIMARY KEY (`identifier`, `vape_name`, `slot`)
) 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-vape/install/images into your inventory’s image folder.
ESX Installation
-- ============================================
-- ESX ORBIT VAPE 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 to ESX items table
INSERT INTO `items` (`name`, `label`, `weight`, `rare`, `can_remove`, `description`)
VALUES ('orbitvape', 'Orbit Vape', 1, 0, 1, 'A premium vape that provides stamina and speed buffs.');
print("========================================")
print("ESX Orbit Vape Installation Complete")
print("========================================")
print("1. Run the SQL in your database")
print("2. Restart your server")
print("========================================")OX Inventory Installation
-- ============================================
-- OX INVENTORY ORBIT VAPE COMPLETE INSTALLATION
-- ============================================
-- This file contains everything needed for OX Inventory
--
-- STEP 1: Add the Lua item to ox_inventory
-- STEP 2: Add the image file
-- ============================================
-- [[[ 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
['orbitvape'] = {
label = 'Orbit Vape',
weight = 35,
stack = true,
close = true,
consume = 1,
server = {
export = 'orbit-vape.useVape'
}
},
-- [[[ STEP 2: ADD ORBITVAPE.PNG IMAGE ]]]
-- You need an orbitvape.png image file
-- Place it in: ox_inventory/web/images/
-- If you don't have one:
-- 1. Create a 100x100px PNG image
-- 2. Name it exactly: orbitvape.png
-- 3. Or copy an existing vape image and rename it
print("========================================")
print("OX Inventory Orbit Vape Installation Complete")
print("========================================")
print("1. Add Lua code to ox_inventory/data/items.lua")
print("2. Add orbitvape.png to ox_inventory/web/images/")
print("3. Restart ox_inventory and your vape script")
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