Installation Advanced Detailed

Installation Guide

Follow this comprehensive guide to install and set up the GOD - Nail Trap System on your FiveM server.

Prerequisites

Before installing the Nail Trap System, ensure you have the following:

• ox_lib - Required dependency for progress bars and notifications

  • Download: ox_lib on GitHub

  • Ensure it's started in your server.cfg before J0-nailScript

• Framework - One of the following:

  • QBCore

  • ESX (es_extended)

  • Qbox

• Inventory System - One of the following:

  • ox_inventory

  • qb-inventory

• Targeting System (Optional but recommended):

  • ox_target (Recommended)

  • qb-target

  • interact

Step 1: Download and Install

1. Download the J0-nailScript resource

2. Place it in your server's resources folder

3. Ensure the folder structure matches:

   resources/
   └── J0-nailScript/
       ├── client/
       ├── server/
       ├── shared/
       ├── installme/
       └── fxmanifest.lua

Step 2: Add to server.cfg

Add the resource to your server.cfg:

ensure ox_lib
ensure J0-nailScript

Important: ox_lib must be started before J0-nailScript.

Step 3: Configure Framework and Systems

Open J0-nailScript/shared/config.lua and configure:

J0.Core = "QBCore" -- Options: "QBCore", "ESX", "Qbox"
J0.Target = "ox_target" -- Options: "ox_target", "qb-target", "interact"
J0.Inventory = 'qb' -- Options: "qb", "ox"

See the Configuration Guide for detailed configuration options.

Step 4: Add Items to Inventory

For ox_inventory

Add the following items to your ox_inventory/data/items.lua:

['screw_nail'] = {
    label = 'Nail',
    weight = 5000,
    stack = true,
    close = true,
    description = 'A specially crafted nail to do something haha..',
    client = {
        image = 'screw_nail.png',
        export = 'J0-nailScript.useNail'
    },
},

['nailspackage'] = {
    label = 'Nails Package',
    weight = 5000,
    stack = true,
    close = true,
    description = 'A specially crafted nail to do something haha..',
    client = {
        image = 'nailspackage.png',
        export = 'J0-nailScript.useNailPackage'
    },
},

For qb-inventory

Add the following items to your qb-inventory/shared/items.lua:

["screw_nail"] = {
    name = "screw_nail",
    label = "Nail",
    weight = 5000,
    type = "item",
    image = "screw_nail.png",
    unique = false,
    useable = true,
    shouldClose = true,
    combinable = nil,
    description = 'A specially crafted nail to do something haha..',
},

["nailspackage"] = {
    name = "nailspackage",
    label = "Nails Package",
    weight = 5000,
    type = "item",
    image = "nailspackage.png",
    unique = false,
    useable = true,
    shouldClose = true,
    combinable = nil,
    description = 'A specially crafted nail to do something haha..',
},

Step 5: Add Item Images

1. Copy the image files from J0-nailScript/installme/:

   • screw_nail.png

   • nailspackage.png (or use screw_nail.png as placeholder)

2. Place them in your inventory's image directory:

   • ox_inventory: ox_inventory/web/images/

   • qb-inventory: qb-inventory/html/images/

Step 6: ESX Configuration (If Using ESX)

If you're using ESX, you need to add useable items manually. Add this to your ESX configuration or create a separate script:

ESX.RegisterUsableItem('screw_nail', function(source)
    TriggerClientEvent('J0-nailScript:cl:spawnNails', source)
end)

ESX.RegisterUsableItem('nailspackage', function(source)
    TriggerClientEvent('J0-nailScript:cl:spawnNailsPackage', source)
end)

Step 7: Verify Installation

1. Start your server

2. Check console for any errors

3. Ensure ox_lib is loaded before J0-nailScript

4. Verify items appear in your inventory

5. Test placing a nail in-game

Step 8: Custom Prop (Optional)

The script uses a custom prop model. If you have a custom model you'd like to use:

1. Ensure the model is streamed in your server

2. Contact support for assistance with custom prop integration

Troubleshooting Installation

Items Not Appearing

• Verify item names match exactly: screw_nail and nailspackage

• Check inventory system configuration

• Restart inventory resource after adding items

Script Not Working

• Ensure ox_lib is started before J0-nailScript

• Check shared/config.lua for correct framework selection

• Verify console for error messages

Nails Not Spawning

• Check if custom prop model is available and streamed

• Verify targeting system is properly configured

• Check client console for errors

ESX Issues

• Ensure useable items are registered (see Step 6)

• Verify ESX exports are working correctly

Next Steps

After installation:

1. Review the Configuration Guide to customize settings

2. Check the FAQ for common questions

3. Read How It Works for technical details

---

Installation complete! Your Nail Trap System is ready to use. 🚀