Documentation
Installation guide — please follow each step carefully and exactly as described to ensure the script works correctly on your server. Skipping or modifying steps may cause the system to not function properly, so follow it step by step.
To download the assets needed for this script, you must access the official Cfx.re portal, where all assets purchased through Tebex are managed.
Open the Cfx.re granted assets page: https://portal.cfx.re/assets/granted-assets.
This page contains all assets linked to your Cfx.re purchases.
Sign in using the same Cfx.re account you used when purchasing the asset.
If you use a different account, the assets will not appear.
In the granted assets list, locate and download:
Crosshair
These two packages are required to install the full housing system.
These files include the models, materials, and visual resources required for the proper operation of the housing system.
This script requires some mandatory dependencies to function correctly. Make sure to download and extract them inside your server’s main directory, keeping their original folder structure intact.
Get up and running in just a few minutes. Follow the steps below to install the resource, configure the required dependencies, and verify that everything is working correctly on your server. Once completed, all features will be available in-game and ready to use.
Place qs-crosshair/ inside your server's resources/ directory.
resources/
└── [crosshair]/
└── qs-crosshair/Add the following lines to your server.cfg in this exact order:
ensure oxmysql
ensure ox_lib
ensure qs-crosshairRestart your server to load the resource.
Check the server console and confirm that the qs-crosshair startup banner appears successfully, showing the resource version and status.
This script includes an essential database required for its operation.You must import it before starting your server, preferably using HeidiSQL or any other manager compatible with MariaDB/MySQL.
CREATE TABLE IF NOT EXISTS `qs_crosshair_admin_config` (
`id` INT UNSIGNED NOT NULL PRIMARY KEY,
`config_json` LONGTEXT NOT NULL,
`updated_at` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
CREATE TABLE IF NOT EXISTS `qs_crosshair_share_codes` (
`code` VARCHAR(32) NOT NULL PRIMARY KEY,
`cfg_json` LONGTEXT NOT NULL,
`name` VARCHAR(64) NOT NULL,
`owner_license` VARCHAR(128) NOT NULL,
`created_at` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
INDEX `idx_qscrosshair_codes_created_at` (`created_at`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
CREATE TABLE IF NOT EXISTS `qs_crosshair_players` (
`license` VARCHAR(128) NOT NULL PRIMARY KEY,
`cfg_json` LONGTEXT NULL,
`enabled` TINYINT(1) NOT NULL DEFAULT 1,
`updated_at` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
All settings are in qs-crosshair/config/main.lua. The file uses semantic markers so you know what is safe to change:
Marker | Description |
|---|---|
| Safe to modify. Intended for server owners and administrators. |
| Informational content. No action required. |
| Advanced configuration. Modify only if you understand the impact. |
| Core functionality. Editing is not recommended. |
| Automatically managed by the system. Do not modify. |
These are the most frequently customized options:
Setting | Description |
|---|---|
| Changes the command used to open the interface. Default: |
| Changes the default key binding. Default: |
| Maximum distance for the Share Nearby feature. Default: |
| Notification system to use. Supported values: |
| ACE permission required to access the admin panel. Default: |
The Admin tab is visible only to players whose FiveM ace includes Config.Admin.AceGroup (default group.admin).
Grant from the server console or txAdmin:
add_principal identifier.license:XXXXXXXXXXXXXXXXXX group.adminReplace XXXXXXXXXXXXXXXXXX with the player's FiveM license identifier. You can find it via F8 while connected, or from the txAdmin player list.
To use a different ace group (for example a custom crosshair.admin), edit Config.Admin.AceGroup in config/main.lua and grant that ace to your admin players.
If you need to gate access, fire side-effects, or integrate with another script, use the hook files — they are not encrypted.
Location client/custom/main.lua.
-- Return false to block a specific player from opening the panel.
function OnBeforeOpen()
-- Example: block panel during active PvP event
-- if IsInPvpZone() then return false end
return true
end
-- Called immediately after the panel opens.
function OnAfterOpen() end
-- Called whenever the active crosshair build changes.
-- cfg is the full CrosshairCfg table.
function OnApply(cfg) endLocation server/custom/main.lua.
-- Called when a player loads and their library is hydrated.
function OnPlayerLoad(src) end
-- Called when a player successfully sends a build to another player.
function OnShareSent(sender, recipient, build) end
-- Called when an admin saves a panel setting (key/value pair).
function OnAdminSave(admin, key, value) end