Installation Guide

This guide will walk you through the installation process of GOD - Crosshair Generator on your FiveM server.

Prerequisites

• A FiveM server with admin access

• Basic knowledge of server configuration files

Step 1: Download and Extract

1. Download the god-crosshair resource package

2. Extract the files to your server's resources folder

resources/
└── god-crosshair/
    ├── client/
    ├── server/
    ├── shared/
    ├── ui/
    └── fxmanifest.lua

Step 2: Add to Server Configuration

1. Open your server.cfg file

2. Add the following line to ensure the resource starts:

ensure god-crosshair

Example server.cfg:

# Resources
ensure god-crosshair
ensure es_extended
# ... other resources

Step 3: Verify Installation

1. Start or restart your FiveM server

2. Check the server console for any errors

3. The resource should load without errors

Expected console output:

[god-crosshair] Resource started successfully

Step 4: Test in-Game

1. Join your server

2. Type /crosshair in the chat to open the crosshair customization menu

3. If the menu opens, installation is successful!

Troubleshooting

Resource Not Starting

Problem: The resource doesn't appear in the server console or fails to start.

Solutions:

• Verify the folder name matches exactly: god-crosshair

• Check that fxmanifest.lua is in the root of the resource folder

• Ensure the ensure command in server.cfg matches the folder name

• Check server console for specific error messages

Menu Not Opening

Problem: The /crosshair command doesn't open the menu.

Solutions:

• Verify the resource is started (check ensure in server.cfg)

• Check F8 console for any JavaScript errors

• Ensure no other crosshair scripts are conflicting

• Restart the resource: restart god-crosshair

Crosshair Not Appearing

Problem: The menu opens but no crosshair appears in-game.

Solutions:

• Make sure you have a weapon equipped (crosshair only shows for whitelisted weapons)

• Check that "Toggle Crosshair" is set to "ON" in the menu

• Verify the weapon you're using is in the whitelist (see Configuration section)

Disabling Other Crosshair Scripts

If you're using other crosshair scripts, you should disable them to avoid conflicts:

1. Find other crosshair resources in your resources folder

2. Remove or comment out their ensure lines in server.cfg

3. Restart your server

File Structure

After installation, your resource structure should look like this:

god-crosshair/
├── client/
│   ├── functions.lua
│   └── main.lua
├── server/
│   └── main.lua
├── shared/
│   ├── config.lua
│   ├── database.json
│   └── savedconfig.json
├── ui/
│   ├── css/
│   │   ├── crosshair.css
│   │   ├── global.css
│   │   └── menu.css
│   ├── js/
│   │   ├── script.js
│   │   └── settings.js
│   ├── index.html
│   └── [image files]
└── fxmanifest.lua

Next Steps

After successful installation:

1. Review the Configuration Guide to customize default settings

2. Check Usage Guide to learn about commands and features

3. Read Editing Localization Files if you want to modify translations