Configuration Guide

This guide explains all configuration options available in the God-Impound system and how to customize them to fit your server's needs.

📁 Configuration File Location

All configuration is done in: God-Impound/shared/config.lua

⚙️ Configuration Options

Framework Selection

Choose your server's framework:

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

Available Options:

• "QBCore" - For QBCore framework

• "ESX" - For ESX framework

• "Qbox" - For Qbox framework

Police Job Name

Set the job name that can use the impound system:

J0.PolJobName = "police"

Note: Change this to match your server's police job name. Common names:

• "police" - Default

• "lspd" - Los Santos Police Department

• "bcso" - Blaine County Sheriff's Office

• "sheriff" - Sheriff's Office

Impound Ped Location

Configure where the impound NPC ped spawns:

J0.ImpoundPedCoords = vector4(395.17, -1629.32, 28.29, 62.32)

Format: vector4(x, y, z, heading)

How to find coordinates:

1. Go to the desired location in-game

2. Use /tp command or F8 console

3. Note the X, Y, Z coordinates

4. Face the direction you want the ped to face

5. Check heading with a coordinate tool or estimate (0-360 degrees)

Example:

-- Impound lot at Legion Square
J0.ImpoundPedCoords = vector4(195.17, -1640.32, 29.80, 180.0)

Vehicle Spawn Points

Configure where vehicles spawn when retrieved from impound:

J0.VehicleSpawnCoords = {
    {id = 1, x = 401.35, y = -1618.97, z = 28.29, rotation = 48.01},
    {id = 2, x = 403.45, y = -1617.11, z = 28.29, rotation = 58.05}
}

Parameters:

• id - Unique identifier for the spawn point

• x, y, z - Coordinates where vehicle spawns

• rotation - Vehicle heading/rotation (0-360 degrees)

Adding More Spawn Points:

J0.VehicleSpawnCoords = {
    {id = 1, x = 401.35, y = -1618.97, z = 28.29, rotation = 48.01},
    {id = 2, x = 403.45, y = -1617.11, z = 28.29, rotation = 58.05},
    {id = 3, x = 405.50, y = -1615.20, z = 28.29, rotation = 65.00},  -- New spawn point
    {id = 4, x = 407.60, y = -1613.30, z = 28.29, rotation = 70.00}   -- Another spawn point
}

The system randomly selects a spawn point from this list when retrieving vehicles.

Impound Laws

Customize the laws/reasons for vehicle impoundment:

J0.Laws = {
    {id = 1, title = "Inoperable on a scene", description = "Vehicle found on scene in an inoperable state."},
    {id = 2, title = "Unpaid Asset Fees", description = "This vehicle has been flagged as they have not paid their asset fees."},
    {id = 3, title = "Vehicle Scuff", description = "Vehicle in an unrecoverable state."},
    -- Add more laws...
}

Parameters:

• id - Unique law identifier (must be unique, sequential recommended)

• title - Short title shown in menu (brief description)

• description - Detailed explanation of the law violation

Adding Custom Laws:

J0.Laws = {
    -- Existing laws...
    {id = 12, title = "Custom Violation", description = "Detailed description of your custom violation reason."},
    {id = 13, title = "Another Custom Law", description = "Another detailed description."}
}

Removing Laws: Simply delete the law entry from the table. Make sure IDs remain unique if you're not renumbering.

Example Custom Law Set:

J0.Laws = {
    {id = 1, title = "Traffic Violation", description = "Vehicle involved in serious traffic violation."},
    {id = 2, title = "Illegal Parking", description = "Vehicle parked in restricted area."},
    {id = 3, title = "Stolen Vehicle", description = "Vehicle reported as stolen."},
    {id = 4, title = "Evidence Collection", description = "Vehicle held for evidence in ongoing investigation."},
    {id = 5, title = "Abandoned Vehicle", description = "Vehicle abandoned on public property."}
}

Image Logging Service

Configure how proof images are stored:

-- Options: "DC" for Discord webhook, "FM" for FivemManage API
J0.ImageLogService = "DC"

Discord Webhook (Recommended):

J0.ImageLogService = "DC"
J0.ImageLogs = "https://discord.com/api/webhooks/YOUR_WEBHOOK_ID/YOUR_WEBHOOK_TOKEN"

How to get Discord webhook:

1. Go to your Discord server settings

2. Navigate to Integrations → Webhooks

3. Create a new webhook

4. Copy the webhook URL

5. Paste it in J0.ImageLogs

FivemManage API:

J0.ImageLogService = "FM"
J0.ImageLogs = "YOUR_FIVEMANAGE_API_KEY"

🎨 Advanced Customization

Changing Notification Messages

Notification messages are hardcoded in the client files. To customize them, you would need to edit:

• God-Impound/client/client.lua - For client-side notifications

• God-Impound/client/cl_utils.lua - For notification function

Example notification changes:

-- In cl_utils.lua, you can modify the Notify function
Notify = function(msg, typ)
    -- Custom notification logic here
end

Modifying UI Elements

UI elements are in the HTML files:

• God-Impound/html/index.html - Main UI structure

• God-Impound/html/css.css - Styling

• God-Impound/html/script.js - UI functionality

Note: Be careful when modifying UI files as they're part of the escrow protection.

Adjusting Progress Bar Duration

The impound progress bar duration is set in client.lua:

startProgressBar({
    duration = 5000,  -- Change this value (in milliseconds)
    -- ... other options
})

📋 Configuration Checklist

After configuring, verify:

• Framework is set correctly (J0.Core)

• Police job name matches your server (J0.PolJobName)

• Impound ped coordinates are correct (J0.ImpoundPedCoords)

• Vehicle spawn points are configured (J0.VehicleSpawnCoords)

• Laws are customized for your server (J0.Laws)

• Image logging is configured (J0.ImageLogService and J0.ImageLogs)

• All coordinates are tested in-game

• Resource restarted after changes

🔄 Applying Changes

After making configuration changes:

1. Save the config file

2. Restart the resource:

   restart God-Impound

   Or restart your entire server

3. Test the changes in-game to ensure everything works

💡 Tips

• Backup your config before making major changes

• Test coordinates in-game before finalizing

• Use unique law IDs to avoid conflicts

• Keep law descriptions clear for officers to understand

• Add multiple spawn points for better vehicle distribution

• Test image logging to ensure photos are being saved

🆘 Need Help?

If you encounter issues with configuration:

1. Check the FAQ for common problems

2. Verify all syntax is correct (no missing commas, brackets)

3. Check server console for Lua errors

4. Ensure all coordinates are valid numbers

---

Configuration Complete! Your God-Impound system is now customized for your server.