Configuration Guide

This guide explains how to configure GOD - Crosshair Generator to suit your server's needs.

Config File Location

The main configuration file is located at:

god-crosshair/shared/config.lua

Config Structure

The configuration is divided into two main sections:

1. DefaultSettings

These are the default values applied to new players when they first join the server.

2. WhitelistedWeapons

This array contains all weapon hashes that will display the crosshair when equipped.

Default Settings

General Settings

["General"] = {
    ["Toggle"] = true,              -- Enable/disable crosshair by default
    ["Firing"] = true,              -- Enable firing error simulation
    ["FiringMultiplier"] = 0.00     -- Multiplier for firing error (0.00 = no error)
}

Parameters:

• Toggle: true or false - Whether crosshair is enabled by default

• Firing: true or false - Enable firing error simulation

• FiringMultiplier: 0.00 to 100.00 - How much the crosshair spreads when firing

Lines Settings

["Lines"] = {
    ["Toggle"] = true,              -- Show/hide crosshair lines
    ["Color"] = "#000000",          -- Line color (hex format)
    ["Opacity"] = 1.00,             -- Line opacity (0.00 to 1.00)
    ["Length"] = 2,                 -- Line length (0 to 3.5)
    ["Thickness"] = 0.5,            -- Line thickness (0 to 0.75)
    ["Distance"] = 2                -- Distance between lines (0.0 to 2.5)
}

Parameters:

• Toggle: true or false - Show/hide the crosshair lines

• Color: Hex color code (e.g., #FF0000 for red, #00FF00 for green)

• Opacity: 0.00 (transparent) to 1.00 (opaque)

• Length: Length of each line in viewport width units

• Thickness: Thickness of the lines

• Distance: Gap between the center and the lines

Outlines Settings

["Outlines"] = {
    ["Toggle"] = true,              -- Show/hide outlines
    ["Color"] = "#000000",          -- Outline color (hex format)
    ["Opacity"] = 1.00,             -- Outline opacity (0.00 to 1.00)
    ["Thickness"] = 1.5,            -- Outline thickness (0 to 10)
    ["Blur"] = 0.0                  -- Outline blur effect (0 to 10)
}

Parameters:

• Toggle: true or false - Show/hide outlines around crosshair

• Color: Hex color code for outline

• Opacity: 0.00 to 1.00 - Outline transparency

• Thickness: Thickness of the outline border

• Blur: Blur amount for the outline (creates a glow effect)

Center Dot Settings

["Center Dot"] = {
    ["Toggle"] = true,              -- Show/hide center dot
    ["Color"] = "#000000",          -- Dot color (hex format)
    ["Opacity"] = 1.00,             -- Dot opacity (0.00 to 1.00)
    ["Roundness"] = 10.00,          -- Dot roundness (0.00 to 10.00)
    ["Thickness"] = 0.25,           -- Dot size (0 to 2)
    ["Toggle Shotgun"] = false      -- Enable shotgun crosshair mode
}

Parameters:

• Toggle: true or false - Show/hide center dot

• Color: Hex color code for the dot

• Opacity: 0.00 to 1.00 - Dot transparency

• Roundness: 0.00 (square) to 10.00 (circle) - Shape of the dot

• Thickness: Size of the center dot

• Toggle Shotgun: true or false - Special mode for shotguns

Weapon Whitelist

The WhitelistedWeapons array contains all weapons that will show the crosshair. Only weapons in this list will display the crosshair when equipped.

Adding Weapons

To add a weapon to the whitelist, add its hash to the array:

WhitelistedWeapons = {
    "weapon_pistol",
    "weapon_assaultrifle",
    "weapon_smg",
    -- Add your weapon here
    "weapon_customweapon"
}

Common Weapon Hashes

Here are some common weapon hashes you might want to add:

-- Pistols
"weapon_pistol"
"weapon_pistol_mk2"
"weapon_combatpistol"
"weapon_appistol"
"weapon_snspistol"

-- SMGs
"weapon_smg"
"weapon_smg_mk2"
"weapon_microsmg"
"weapon_assaultsmg"

-- Rifles
"weapon_assaultrifle"
"weapon_assaultrifle_mk2"
"weapon_carbinerifle"
"weapon_carbinerifle_mk2"
"weapon_specialcarbine"

-- Shotguns
"weapon_pumpshotgun"
"weapon_pumpshotgun_mk2"
"weapon_sawnoffshotgun"
"weapon_assaultshotgun"

Removing Weapons

To remove a weapon from the whitelist, simply delete its line from the array.

Example Configuration

Here's a complete example configuration:

Config = {
    Settings = {
        DefaultSettings = {
            ["General"] = {
                ["Toggle"] = true,
                ["Firing"] = false,
                ["FiringMultiplier"] = 0.00
            },

            ["Lines"] = {
                ["Toggle"] = true,
                ["Color"] = "#FFFFFF",
                ["Opacity"] = 1.00,
                ["Length"] = 2.5,
                ["Thickness"] = 0.5,
                ["Distance"] = 1.5
            },

            ["Outlines"] = {
                ["Toggle"] = true,
                ["Color"] = "#000000",
                ["Opacity"] = 1.00,
                ["Thickness"] = 1.5,
                ["Blur"] = 0.0
            },

            ["Center Dot"] = {
                ["Toggle"] = true,
                ["Color"] = "#FFFFFF",
                ["Opacity"] = 1.00,
                ["Roundness"] = 10.00,
                ["Thickness"] = 0.25,
                ["Toggle Shotgun"] = false
            }
        },

        WhitelistedWeapons = {
            "weapon_pistol",
            "weapon_assaultrifle",
            "weapon_smg"
        }
    }
}

Applying Changes

After modifying the configuration:

1. Save the config.lua file

2. Restart the resource: restart god-crosshair in server console

3. Changes will apply to new players immediately

4. Existing players will keep their saved settings (they can reset in-game)

Tips

• Color Codes: Use online color pickers to find hex codes for your desired colors

• Testing: Test different opacity values to find the best visibility

• Performance: Lower blur values improve performance

• Weapon List: Keep the weapon whitelist manageable for better performance

Troubleshooting

Changes Not Applying

• Make sure you saved the file

• Restart the resource: restart god-crosshair

• Check for syntax errors in the config file

Invalid Weapon Hash

• Verify weapon hashes are correct

• Check FiveM documentation for weapon names

• Test with known working weapons first