Installation
Add a weapon to your server. No framework, inventory or other resource is needed for the weapon itself.
Every weapon is an addon with its own spawn name, so vanilla weapons and your other resources keep working alongside it. The steps are the same for each one; the examples use the Reaper's Scythe (md_scythe, WEAPON_SCYTHE).
Download it
Download the weapon from the Cfx.re Portal under Granted Assets, and put its folder (for example
md_scythe) in your server'sresourcesfolder.Add it to server.cfg
Add it after your framework and inventory, so they are running before it starts:
server.cfg ensure md_scytheRestart the server
Do a full restart, not
refreshorrestart md_scythe: weapon metas only load when the server starts.
Then add it to your framework so players can hold it in their inventory.
What's in the folder
| Path | What it is |
|---|---|
stream/ | The model and, for animated weapons, its effect. Encrypted by Asset Escrow. |
meta/ | Weapon metas: name, stats and animations. Open, so you can change stats. |
cl_weaponNames.lua | Gives the weapon its in-game name. Keep it running. |
install/ | Item snippets for QBCore, ox_inventory, ESX, qs, core, tgiann, CodeM and ak47, each inventory's icons, a 512 px icon and a vMenu entry. |
README.md | This guide, written for that weapon, with its own spawn name in every snippet. |
Spawn names
Each weapon's spawn name is on its release page and at the top of its README.md, in the form WEAPON_NAME. Item names are the same in lower case for QBCore (weapon_scythe) and upper case for ox_inventory and ESX (WEAPON_SCYTHE).