Addon Weapons

To add an addon weapon to the Weapon Mod Workbench, follow these steps:

1. Open the Configuration File

Navigate to src/weapons.json.

2. Add Your Weapon

Add a new entry to the JSON file with the following structure:

Required Fields:

• name: The display name of the weapon. Example: "Custom Pistol"

• hashKey: The hash key of the weapon. Example: "WEAPON_COMBATPISTOL"

• modelHashKey: The hash key for the weapon's prop model. Example: "w_pi_combatpistol"

• components: An object defining the weapon’s components. Each component must include:

  • name: Display name of the component. Example: "Extended Clip"
  • nameGXT: The GXT identifier used to match the component with inventory items. Example: "WCT_CLIP2" See the full list of GXT names here.
  • hashKey: Hash key of the component. Example: "COMPONENT_COMBATPISTOL_CLIP_02"
  • modelHashKey: The prop model's hash key. Example: "w_pi_combatpistol_mag2"
  • isDefault: Boolean indicating whether this component is equipped by default. Example: false
  • attachBone: The bone to which this component attaches. Example: "WAPClip"

• tints: An array of available tints. Each tint must include:

  • name: Name of the tint. Example: "Red"
  • nameGXT: The GXT identifier used to link the tint with inventory items. Example: "WM_TINT0" See the full list of tint GXT names here

Optional Fields:

• _nxtgnfivem: An object for additional properties:

  • offset: A vector offset for the weapon. Example: [0.0, 0.0, 0.0]
  • disabled: Boolean to disable the weapon. Example: false
  • noDisplay: Boolean to hide the weapon prop. Example: false

3. Save and Reload

After saving your changes, restart the resource. Your custom weapon should now be available in the Weapon Mod Workbench.