Configuration Guide: Nail Trap System

This guide will help you configure the Nail Trap System to match your server’s framework, targeting system, and inventory preferences.

Configuration Guide

This guide will help you configure the GOD - Nail Trap System to match your server's framework, targeting system, and gameplay preferences.

Configuration File

All configuration is done in J0-nailScript/shared/config.lua.

Core Framework Selection

Set your core framework based on your server:

J0.Core = "QBCore" -- Options: "QBCore", "ESX", "Qbox"

Available Options:

• "QBCore" → Use this for a qb-core-based server

• "ESX" → Use this if your server runs on es_extended

• "Qbox" → Select this if your server is using qbox_core

Framework-Specific Notes:

QBCore / Qbox:

• Uses qb-core exports

• Native useable item registration

• Framework notifications

ESX:

• Uses es_extended exports

• Requires manual useable item registration (see Installation Guide)

• Uses ox_lib notifications

Targeting System Selection

Select the targeting system your server uses:

J0.Target = "ox_target" -- Options: "ox_target", "qb-target", "interact"

Available Options:

• "ox_target" → Uses ox_target for interacting with nails (Recommended)

• "qb-target" → Uses qb-target as the interaction method

• "interact" → Uses a basic interaction system instead of a targeting resource

Targeting System Details:

ox_target:

• Recommended for best compatibility

• Uses addLocalEntity and removeLocalEntity

• Distance: 8.5 units

qb-target:

• Alternative targeting solution

• Uses AddTargetEntity and RemoveTargetEntity

• Distance: 8.5 units

interact:

• Basic interaction system

• Uses AddLocalEntityInteraction and RemoveLocalEntityInteraction

• Distance: 6.0 units, Interact Distance: 4.0 units

Inventory System Selection

Choose the inventory system that matches your server:

J0.Inventory = 'qb' -- Options: "qb", "ox"

Available Options:

• "qb" → Use this if you have qb-inventory installed

• "ox" → Use this if you are running ox_inventory

Inventory System Details:

qb-inventory:

• Uses framework functions: Functions.AddItem / Functions.RemoveItem

• Server-side useable item registration

• Item configuration in shared/items.lua

ox_inventory:

• Uses export functions: exports.ox_inventory:AddItem / RemoveItem

• Client-side export functions for item usage

• Item configuration in data/items.lua

Nails System Settings

Customize how the nails function in-game:

J0.NailsCfg = {
    CleanUp = 10, -- Time (in minutes) before deployed nails automatically disappear
    DamagePerNail = 33.335 -- Damage percentage applied to a vehicle's tire upon contact with a nail
}

CleanUp

Description: Defines how long (in minutes) nails will stay on the ground before they are automatically removed.

Default: 10 minutes

Recommended Values:

• 5 minutes - For fast-paced servers

• 10 minutes - Balanced gameplay (default)

• 15 minutes - For longer tactical scenarios

• 30 minutes - Extended roadblock scenarios

Note: Setting this too high may cause performance issues if many nails are deployed. Setting it too low may remove nails before they're useful.

DamagePerNail

Description: Determines how much tire damage a single nail will cause when a vehicle's wheel makes contact with it.

Default: 33.335 (approximately 33.33%)

How It Works:

• Damage is cumulative per tire

• Each nail contact adds this percentage to the tire's damage

• When damage reaches 100%, the tire bursts instantly

• With default value: 3 nails = 100% damage (tire burst)

Recommended Values:

• 25.0 - 4 nails needed to burst tire (more realistic)

• 33.335 - 3 nails needed to burst tire (default, balanced)

• 50.0 - 2 nails needed to burst tire (more effective)

• 100.0 - 1 nail instantly bursts tire (very effective)

Calculation Example:

Tire Damage = (Number of Nail Contacts) × DamagePerNail
If Tire Damage >= 100, then Tire Bursts

Complete Configuration Example

Here's a complete configuration example for a QBCore server with ox_inventory and ox_target:

J0 = {}

-- Core framework selection
J0.Core = "QBCore"

-- Targeting method selection
J0.Target = "ox_target"

-- Inventory system selection
J0.Inventory = 'ox'

-- Nails system settings
J0.NailsCfg = {
    CleanUp = 10, -- Nails disappear after 10 minutes
    DamagePerNail = 33.335 -- Each nail does 33.335% tire damage
}

Advanced Configuration

Custom Prop Model

If you want to use a different nail prop model, contact support for assistance with custom prop integration. The system supports custom prop models but requires proper configuration.

Nail Package Maximum Uses

The maximum number of nails per package can be customized. Contact support for assistance with adjusting this setting.

Damage Detection Range

The damage detection range can be customized. Contact support for assistance with adjusting detection ranges and thresholds.

Tire Contact Threshold

The tire contact threshold determines how close a tire needs to be to a nail for damage to occur. Contact support for assistance with customizing this setting.

Configuration Best Practices

1. Test After Changes: Always test configuration changes in a development environment first

2. Balance Settings: Adjust DamagePerNail and CleanUp to match your server's gameplay style

3. Performance: Monitor server performance when adjusting detection ranges

4. Framework Match: Ensure framework selection matches your actual server setup

5. Inventory Match: Verify inventory system matches your installed inventory resource

Verifying Configuration

After making changes:

1. Restart the J0-nailScript resource

2. Check server console for any configuration errors

3. Test nail placement and damage in-game

4. Verify targeting interactions work correctly

5. Confirm inventory items function properly

Troubleshooting Configuration

Script Not Working After Config Change

• Verify syntax is correct (no typos, proper quotes)

• Check console for Lua errors

• Ensure all values are valid (numbers for CleanUp and DamagePerNail)

Wrong Framework Behavior

• Double-check J0.Core matches your framework

• Verify framework resource is running

• Check framework exports are available

Targeting Not Working

• Verify targeting system is installed and running

• Check J0.Target matches your installed targeting system

• Ensure targeting resource is started before J0-nailScript

Inventory Issues

• Confirm J0.Inventory matches your inventory system

• Verify inventory resource is running

• Check item exports/functions are working

---

Configuration complete! Your Nail Trap System is customized for your server. ⚙️