ONYXDocs
BoutiqueStore Discord

ONYX STUDIO · Documentation

Installer tes
armes ONYX
Install your
ONYX weapons

Tout ce qu’il faut pour mettre tes armes add-on en jeu, quelle que soit ta base : ESX, QBCore, QBox ou autre. Choisis ton pack et ton inventaire : le code est généré pour toi, prêt à copier, avec les images d’inventaire déjà nommées.

Everything you need to get your add-on weapons in game, whatever your base: ESX, QBCore, QBox or anything else. Pick your pack and your inventory: the code is generated for you, ready to copy, with inventory images already named.

ESX · QBCore · QBox ox · qb · qs inventory 128 armes · 24 packs128 weapons · 24 packs Cfx.re escrow

Avant de commencerBefore you start

Quelle est ta base ?Which base do you run?

Les armes ONYX marchent sur tous les serveurs FiveM : la ressource elle-même ne dépend d’aucun framework. Ce qui change d’une base à l’autre, c’est uniquement l’endroit où tu déclares les armes pour que ton inventaire les reconnaisse. Repère ta ligne :

ONYX weapons work on every FiveM server: the resource itself does not depend on any framework. The only thing that changes from one base to another is where you declare the weapons so your inventory recognises them. Find your row:

FrameworkInventaireInventoryCe que tu modifiesWhat you edit
ESX Legacyox_inventory (par défaut)(default)ox_inventory/data/weapons.luaox_inventory →
QBox (qbx_core)ox_inventoryox_inventory/data/weapons.luaox_inventory →
QBCoreox_inventoryox_inventory/data/weapons.lua uniquementonlyox_inventory →
QBCoreqb-inventory, ps-inventory, lj-inventoryqb-core/shared/items.lua + weapons.luaqb-inventory →
ESX / QBCoreqs-inventory (Quasar)qs-inventory/shared/items.luaqs-inventory →
ESX (ancien)(older)sans inventaire (loadout ESX)no inventory (ESX loadout)es_extended · Config.WeaponsESX →
TousAnycodem, tgiann, core_inventory, ak47…la même méthode, adaptéethe same method, adaptedAutreOther →
Standaloneaucunnonerien : la ligne ensure suffitnothing: the ensure line is enoughInstallerInstall →
Tu ne sais pas lequel tu as ?Not sure which one you have?

Ouvre ton dossier resources : si tu y trouves ox_inventory, c’est ox_inventory. Sinon cherche qb-inventory, qs-inventory, etc. Ton framework se voit aussi au nom du dossier principal : es_extended (ESX), qb-core (QBCore) ou qbx_core (QBox).

Open your resources folder: if you find ox_inventory, you run ox_inventory. Otherwise look for qb-inventory, qs-inventory, etc. Your framework shows in the core folder name: es_extended (ESX), qb-core (QBCore) or qbx_core (QBox).

01 · Récupérer ton packGet your pack

Télécharger depuis Cfx.reDownload from Cfx.re

Les armes ONYX sont livrées par le système officiel de FiveM (Cfx.re escrow). Après ton achat sur la boutique, le pack est ajouté au compte Cfx.re avec lequel tu t’es connecté au moment de payer.

  1. Va sur portal.cfx.re et connecte-toi avec le même compte Cfx.re que lors de l’achat.
  2. Ouvre Assets, puis Granted Assets.
  3. Clique sur Download à côté de ton pack (par exemple onx_halloween_pack) : tu obtiens un fichier .zip.

Avec l’abonnement ALL ACCESS, tu reçois une seule ressource, onx_all_weapon_pack, qui contient toutes les armes. Elle reste active tant que l’abonnement l’est.

ONYX weapons are delivered through FiveM’s official system (Cfx.re escrow). After you buy on the store, the pack is added to the Cfx.re account you signed in with at checkout.

  1. Go to portal.cfx.re and sign in with the same Cfx.re account you used to buy.
  2. Open Assets, then Granted Assets.
  3. Click Download next to your pack (for example onx_halloween_pack): you get a .zip file.

With the ALL ACCESS membership you get a single resource, onx_all_weapon_pack, that holds every weapon. It stays active as long as the membership does.

Ce qu’il faut pour que ça marcheWhat you need for it to work

Le bon compteThe right account

La clé de ton serveur (sv_licenseKey dans server.cfg) doit avoir été créée sur le compte Cfx.re qui possède le pack. Sinon, le serveur refuse de lancer la ressource.

Your server key (sv_licenseKey in server.cfg) must have been created on the Cfx.re account that owns the pack. Otherwise the server refuses to start the resource.

Un serveur à jourAn up-to-date server

Les ressources protégées demandent des artifacts FXServer récents. Si ton serveur a plusieurs mois de retard, mets-le à jour avant d’installer.

Protected resources need recent FXServer artifacts. If your server is several months behind, update it before installing.

02 · Installer la ressourceInstall the resource

Déposer et lancer le packDrop in and start the pack

  1. Décompresse le .zip, puis place le dossier onx_…_pack dans ton dossier resources. Tu peux ranger tous tes packs dans un dossier [onyx] (les crochets en font une catégorie).
  2. Ne renomme pas le dossier et ne modifie pas les fichiers du dossier stream : ils sont protégés.
  3. Ajoute le pack dans server.cfg, après ton framework et ton inventaire.
  4. Redémarre complètement le serveur (pas seulement un refresh), puis reconnecte-toi.
  1. Unzip the .zip, then place the onx_…_pack folder in your resources folder. You can keep all your packs in an [onyx] folder (brackets make it a category).
  2. Do not rename the folder and do not edit files in the stream folder: they are protected.
  3. Add the pack to server.cfg, after your framework and your inventory.
  4. Fully restart the server (not just a refresh), then reconnect.
resources/ └─ [onyx]/ ├─ onx_halloween_pack/ │ ├─ fxmanifest.lua │ ├─ client.lua ← noms affichés (modifiable)← display names (editable) │ ├─ meta/ ← réglages des armes (modifiables)← weapon settings (editable) │ ├─ stream/ ← modèles et textures (protégés)← models and textures (protected) │ └─ README.txt └─ onx_frostbite_pack/
server.cfg
# ONYX STUDIO · add-on weapons
ensure onx_halloween_pack
ensure onx_frostbite_pack

# or start the whole [onyx] folder at once:
# ensure [onyx]
ImportantImportant

Si tu as l’abonnement ALL ACCESS, lance uniquement onx_all_weapon_pack. Ne lance jamais en même temps un pack séparé : ce sont les mêmes armes, elles entreraient en conflit.

If you have the ALL ACCESS membership, start only onx_all_weapon_pack. Never start a separate pack at the same time: they contain the same weapons and would conflict.

Sur un serveur standalone (sans framework), c’est terminé : les armes existent dans le jeu et n’importe quel script peut les donner avec leur nom de spawn. Sur les autres bases, il reste à les déclarer dans ton inventaire.

On a standalone server (no framework), you are done: the weapons exist in the game and any script can give them by spawn name. On other bases, you still need to declare them in your inventory.

03 · Configurer l’inventaireSet up your inventory

Ton code, généré pour ta baseYour code, generated for your base

Coche les packs que tu as achetés et choisis ton inventaire. Tout ce que tu dois coller apparaît en dessous, fichier par fichier, avec le chemin exact. Les valeurs (poids, munitions, durabilité) sont celles fournies dans le README de chaque pack.

Tick the packs you bought and choose your inventory. Everything you need to paste shows up below, file by file, with the exact path. The values (weight, ammo, durability) match the README shipped with each pack.

A Tes packsYour packs

B Ton inventaireYour inventory

C Options

Nom affiché dans l’inventaireName shown in the inventory
Format de ton qb-coreYour qb-core format

Astuce : chaque bloc a un bouton Télécharger qui te donne un fichier .lua avec exactement le même contenu, pratique pour l’ouvrir à côté du tien.

Tip: every block has a Download button that gives you a .lua file with exactly the same content, handy to open next to yours.

04 · Images d’inventaireInventory images

Des PNG déjà prêtsReady-made PNGs

Chaque image est détourée sur fond transparent et porte exactement le nom de spawn de l’arme, en majuscules : WEAPON_ONX_HGLOCK.png. Tu les déposes, et l’image apparaît avec l’arme dans l’inventaire, sans rien renommer.

Every image is cut out on a transparent background and named exactly like the weapon’s spawn name, in uppercase: WEAPON_ONX_HGLOCK.png. Drop them in and the image shows up with the weapon in the inventory, with nothing to rename.

InventaireInventoryDossier des imagesImage folderÀ savoirGood to know
ox_inventoryox_inventory/web/images/Le nom du fichier doit être identique au nom de l’arme. Rien d’autre à faire.The file name must match the weapon name. Nothing else to do.
qb-inventoryqb-inventory/html/images/Le champ image du code généré pointe déjà vers ce fichier.The image field in the generated code already points to this file.
ps-inventory · lj-inventoryps-inventory/html/images/ · lj-inventory/html/images/Comme qb-inventory.Same as qb-inventory.
qs-inventoryqs-inventory/html/images/Le champ image pointe déjà vers ce fichier.The image field already points to this file.
AutresOthersle dossier d’images de ton inventaireyour inventory’s image folderCherche où se trouve weapon_pistol.png et mets les images à côté.Find where weapon_pistol.png lives and put the images next to it.
ESX sans inventaireno inventory·Pas d’images d’armes dans ce mode.No weapon images in this mode.
L’image ne change pas ?Image not updating?

Vérifie la casse (WEAPON_ONX_… en majuscules, extension .png en minuscules), redémarre la ressource de l’inventaire puis reconnecte-toi. Si l’ancienne image reste affichée, vide le cache de FiveM.

Check the case (WEAPON_ONX_… in uppercase, .png extension in lowercase), restart the inventory resource, then reconnect. If the old image still shows, clear the FiveM cache.

05 · Tester en jeuTest in game

Vérifier en une commandeCheck with one command

Connecte-toi avec un compte admin, puis donne-toi une arme. Remplace 1 par ton ID joueur.

Join with an admin account, then give yourself a weapon. Replace 1 with your player ID.

InventaireInventoryArmeWeaponMunitionsAmmo
ox_inventory/giveitem 1 WEAPON_ONX_HGLOCK 1/giveitem 1 ammo-9 100
qb-inventory/giveitem 1 weapon_onx_hglock 1/giveitem 1 pistol_ammo 5
qs-inventory/giveitem 1 weapon_onx_hglock 1/giveitem 1 pistol_ammo 5
ESX sans inventaireno inventory/giveweapon 1 WEAPON_ONX_HGLOCK 250

Ce que tu dois voirWhat you should see

  • L’arme apparaît dans l’inventaire avec son image.
  • Une fois équipée, elle est bien tenue en main et s’affiche avec son nom dans la roue des armes.
  • Le rechargement marche avec les munitions indiquées dans la section Munitions.
  • The weapon shows in the inventory with its image.
  • Once equipped, it sits properly in the hand and shows its name in the weapon wheel.
  • Reloading works with the ammo listed in the Ammo section.

Un souci ? Va voir le dépannage.

Something off? Check troubleshooting.

Aller plus loinGoing further

MunitionsAmmo

Les armes ONYX utilisent les munitions de base de ton inventaire : tu n’as aucun nouvel item de munitions à créer.

ONYX weapons use your inventory’s standard ammo: there is no new ammo item to create.

ox_inventory

ItemUtilisé parUsed by
ammo-9pistolets, certains SMGpistols, some SMGs
ammo-45SMG
ammo-riflefusils et carabinesrifles and carbines
ammo-rifle2ONX EMBER-47
ammo-shotgunfusils à pompeshotguns
ammo-snipersnipers
ammo-50ONX MAGMA .50

QBCore · qs-inventory

ammotypeItem
AMMO_PISTOLpistol_ammo
AMMO_SMGsmg_ammo
AMMO_RIFLErifle_ammo
AMMO_SHOTGUNshotgun_ammo
AMMO_SNIPERsnp_ammo

Le type exact de chaque arme est indiqué dans la liste des armes. Tu peux changer de munition : sur ox_inventory, modifie ammoname ; sur QBCore, modifie ammotype dans items.lua et weapons.lua.

Each weapon’s exact ammo is shown in the weapon list. You can switch ammo: on ox_inventory, change ammoname; on QBCore, change ammotype in items.lua and weapons.lua.

Aller plus loinGoing further

Personnaliser tes armesCustomise your weapons

Le nom dans la roue des armesThe name in the weapon wheel

Il se trouve dans le fichier client.lua du pack, qui reste modifiable. Change seulement le texte entre guillemets, puis redémarre le serveur.

It lives in the pack’s client.lua file, which stays editable. Only change the text between quotes, then restart the server.

onx_halloween_pack/client.lua
local labels = {
    WT_ONX_HGLOCK = "Glock hanté",   -- texte affiché / displayed text
    WT_ONX_HSMG = "SMG hantée",
}

Le nom affiché dans l’inventaire est un autre réglage : c’est le label que tu as collé à l’étape 03.

The name shown in the inventory is a separate setting: it is the label you pasted in step 03.

Poids et durabilitéWeight and durability

Ils se règlent dans ton inventaire : weight (en grammes) et durability sur ox_inventory, weight et Config.DurabilityMultiplier sur QBCore.

They are set in your inventory: weight (in grams) and durability on ox_inventory, weight and Config.DurabilityMultiplier on QBCore.

Dégâts, chargeur, cadenceDamage, magazine, fire rate

Chaque arme a son fichier meta/onx_…/weapons.meta, lui aussi modifiable. Les réglages les plus utiles : <Damage value="…"/>, <ClipSize value="…"/> et <TimeBetweenShots value="…"/>. Fais une copie du fichier avant d’y toucher.

Each weapon has its own meta/onx_…/weapons.meta file, also editable. The most useful settings: <Damage value="…"/>, <ClipSize value="…"/> and <TimeBetweenShots value="…"/>. Make a copy of the file before you edit it.

À ne pas modifierDo not change

Le nom de l’arme (<Name>), le modèle (<Model>), le nom du dossier de la ressource et les fichiers du dossier stream. Changer l’un d’eux casse l’arme ou bloque la ressource.

The weapon name (<Name>), the model (<Model>), the resource folder name and the files in the stream folder. Changing any of them breaks the weapon or blocks the resource.

Aller plus loinGoing further

Mises à jourUpdates

  1. Quand un pack est mis à jour, retélécharge-le depuis portal.cfx.re → Assets → Granted Assets.
  2. Si tu avais modifié client.lua ou des fichiers .meta, garde-en une copie.
  3. Remplace l’ancien dossier par le nouveau, remets tes fichiers modifiés, puis redémarre le serveur.
  1. When a pack is updated, download it again from portal.cfx.re → Assets → Granted Assets.
  2. If you had edited client.lua or .meta files, keep a copy.
  3. Replace the old folder with the new one, put your edited files back, then restart the server.

Avec ALL ACCESS, les nouvelles armes arrivent dans onx_all_weapon_pack. Reviens sur le configurateur : il est toujours à jour, il te suffit d’ajouter les lignes des nouvelles armes.

With ALL ACCESS, new weapons land in onx_all_weapon_pack. Come back to the configurator: it is always up to date, just add the lines for the new weapons.

Aller plus loinGoing further

DépannageTroubleshooting

La console affiche « You lack the required entitlement »The console shows “You lack the required entitlement”

La clé de ton serveur n’appartient pas au compte Cfx.re qui possède le pack. Crée ta clé (sv_licenseKey) sur le compte qui a fait l’achat, ou rachète avec le compte du serveur. Si tu as payé avec le mauvais compte, contacte-nous sur Discord avec ton numéro de transaction Tebex.

Your server key does not belong to the Cfx.re account that owns the pack. Create your key (sv_licenseKey) on the account that made the purchase, or buy with the server’s account. If you paid with the wrong account, contact us on Discord with your Tebex transaction ID.

« Failed to verify protected resource » ou la ressource ne démarre pas“Failed to verify protected resource” or the resource won’t start

Ton serveur est trop ancien, ou les fichiers protégés ont été modifiés. Mets à jour tes artifacts FXServer, puis retélécharge le pack et remplace le dossier complet sans rien renommer.

Your server is too old, or the protected files were modified. Update your FXServer artifacts, then download the pack again and replace the whole folder without renaming anything.

L’arme est invisible ou je n’ai rien en mainThe weapon is invisible or my hands are empty

La ressource n’est pas lancée, ou elle a démarré après ta connexion. Vérifie l’orthographe de la ligne ensure, regarde la console du serveur au démarrage, puis redémarre et reconnecte-toi.

The resource is not started, or it started after you joined. Check the spelling of the ensure line, read the server console at startup, then restart and reconnect.

Avec ox_inventory, l’arme disparaît dès que je la sorsWith ox_inventory, the weapon disappears as soon as I draw it

ox_inventory retire les armes qu’il ne connaît pas. L’entrée manque dans data/weapons.lua, elle est mal orthographiée (le nom doit être en majuscules : WEAPON_ONX_…) ou elle a été collée dans Components au lieu de Weapons. Corrige, puis redémarre le serveur.

ox_inventory removes weapons it does not know. The entry is missing from data/weapons.lua, misspelled (the name must be uppercase: WEAPON_ONX_…) or pasted into Components instead of Weapons. Fix it, then restart the server.

QBCore : « item doesn’t exist » ou l’arme ne se donne pasQBCore: “item doesn’t exist” or the weapon can’t be given

Sur QBCore, les noms doivent être en minuscules (weapon_onx_hglock) dans items.lua comme dans weapons.lua. Vérifie aussi qu’il ne manque pas de virgule entre deux lignes. Les fichiers shared ne se rechargent qu’au redémarrage du serveur.

On QBCore, names must be lowercase (weapon_onx_hglock) in both items.lua and weapons.lua. Also check that no comma is missing between two lines. shared files only reload when the server restarts.

QBCore : erreur « attempt to perform arithmetic on a nil value » dans qb-weaponsQBCore: “attempt to perform arithmetic on a nil value” error in qb-weapons

L’arme n’a pas d’usure définie. Ajoute ses lignes dans Config.DurabilityMultiplier de qb-weapons/config.lua (le configurateur les génère à l’étape 3 de l’onglet qb-inventory).

The weapon has no wear value. Add its lines to Config.DurabilityMultiplier in qb-weapons/config.lua (the configurator generates them in step 3 of the qb-inventory tab).

L’image ne s’affiche pas dans l’inventaireThe image doesn’t show in the inventory

Le nom du fichier doit être exactement celui de l’arme, en majuscules, avec .png en minuscules. Vérifie le dossier (voir Images), redémarre l’inventaire et reconnecte-toi. Si besoin, vide le cache de FiveM.

The file name must be exactly the weapon name, in uppercase, with .png in lowercase. Check the folder (see Images), restart the inventory and reconnect. If needed, clear the FiveM cache.

La roue des armes affiche « WT_ONX_… » au lieu du nomThe weapon wheel shows “WT_ONX_…” instead of the name

Le fichier client.lua ne se charge pas, souvent à cause d’une modification (guillemet ou virgule oubliés). Ouvre la console F8 en jeu pour voir l’erreur, ou remets le fichier d’origine.

The client.lua file isn’t loading, often because of an edit (a missing quote or comma). Open the F8 console in game to see the error, or restore the original file.

Je ne peux pas rechargerI can’t reload

Tu n’as pas les bonnes munitions sur toi. Regarde quelle munition utilise l’arme dans la liste des armes (ox_inventory) ou dans la section Munitions (QBCore).

You don’t carry the right ammo. Check which ammo the weapon uses in the weapon list (ox_inventory) or in the Ammo section (QBCore).

Des armes en double ou des comportements bizarresDuplicate weapons or odd behaviour

Tu lances sûrement onx_all_weapon_pack et un pack séparé en même temps. Garde un seul des deux.

You are probably running onx_all_weapon_pack and a separate pack at the same time. Keep only one of them.

Je change de serveur ou d’hébergeurI’m moving to another server or host

Ton pack est lié à ton compte Cfx.re, pas à la machine. Retélécharge-le depuis le portail et utilise une clé de serveur créée sur ce même compte.

Your pack is tied to your Cfx.re account, not to the machine. Download it again from the portal and use a server key created on that same account.

RéférenceReference

Liste des armesWeapon list

Toutes les armes ONYX avec leur nom de spawn exact, leur type, leur poids et leur munition ox_inventory. Clique sur l’icône pour copier un nom, ou sur PNG pour télécharger une image seule.

Every ONYX weapon with its exact spawn name, type, weight and ox_inventory ammo. Click the icon to copy a name, or PNG to download a single image.

Support

Besoin d’aide ?Need help?

Ouvre un ticket sur notre Discord. Pour aller plus vite, donne-nous le nom de ton pack, ton framework et ton inventaire, et une capture de l’erreur (console du serveur ou F8).

Open a ticket on our Discord. To speed things up, send us your pack name, your framework and inventory, and a screenshot of the error (server console or F8).

Ouvrir le DiscordOpen Discord