Integrations — Crosshair Creator | Quasar Store | Quasar Store

Integrations — Crosshair Creator | Quasar Store | Quasar Store

How Integrations Work#

Crosshair Creator does not talk to your framework at all. A crosshair is a personal visual setting, so players are recognised by their license: identifier and admins by an ace. That is why the same install runs unchanged on any server:

Layer	Supported	Without it
Framework	Any — QBCore, Qbox, ESX, ox_core, ND_Core, vRP or none	Nothing changes.
Database	`oxmysql`

Value	Shows the message with
`'original'`	The script's own toast, top centre, styled to match the panel. The default and the recommended choice.
`'interface'`	The qs-interface notification hub. Falls back to ox_lib if qs-interface is not started.
`'qs'`	qs-notify. Falls back to ox_lib if it is not started.
`'ox_lib'`	`lib.notify`.
`'esx'`	The ESX notification event.
`'custom'`	Your own system, through `OnCustomNotify` in `client/custom/main.lua`.

lua

-- config/main.lua
Config.NotificationType     = 'custom'
Config.NotificationDuration = 5000 -- ms

-- client/custom/main.lua
function OnCustomNotify(title, description, nType, duration, icon)
    -- nType is 'success' | 'error' | 'inform' | 'warning'
    exports['okokNotify']:Alert(title, description, duration, nType)
end

Embed	Sent when
Feature Enabled / Disabled — green / red	A feature toggle is flipped. Shows which feature and its new state.
Official Crosshair Updated / Cleared — blue / orange	The official crosshair is set or removed. Shows its share code.
Server Identity Updated — purple	The server name, logo or default theme colour changes. Lists every field changed.

Function	Called
`OnBeforeOpen()`	Before the panel opens. Return `false` to keep it closed — behind a job, a duty state, a safe zone.
`OnAfterOpen()`	Right after the panel is shown.
`OnApply(cfg)`	Every time a crosshair becomes active — a preset, a library build, the builder, or an export.
`OnCustomNotify(title, description, nType, duration, icon)`	For every message, when `Config.NotificationType = 'custom'`.

lua

-- client/custom/main.lua — only on-duty players may open the panel (QBCore)
function OnBeforeOpen()
    local PlayerData = exports['qb-core']:GetCoreObject().Functions.GetPlayerData()
    if PlayerData.job and PlayerData.job.onduty then return true end
    Notify('Unavailable', 'You must be on duty to open the crosshair panel.', 'warning')
    return false
end

-- A sound every time a crosshair is applied
function OnApply(cfg)
    PlaySoundFrontend(-1, 'SELECT', 'HUD_FRONTEND_DEFAULT_SOUNDSET', true)
end

Function	Called
`OnShareSent(senderSrc, recipientSrc, buildName)`	When a player sends a build to a nearby player.
`OnAdminSave(adminSrc, action, payload)`	After every admin change. `action` is `'save_feature'`, `'save_official'` or `'save_identity'`. Ships with the Discord audit log inside.

lua

Config.Dynamics.FireFeedback = {
    ExpandPerShot  = 0.5,   -- how much the gap and arms grow per shot (0.5 = 50%)
    ExpandMax      = 2.0,   -- the cap, as a multiple of the base size
    HoldDurationMs = 200,   -- how long it stays open after the last shot
    DecayPerMs     = 0.005, -- how fast it shrinks back afterwards
    RateLimitMs    = 50,
    PollIntervalMs = 50,
}

Config.Dynamics.LowAmmo = {
    HalfMagRatio   = 0.5,   -- orange at or below this share of a full magazine
    CriticalRounds = 5,     -- red at or below this many rounds (empty included)
    PollIntervalMs = 250,
}

Config.Dynamics.TargetDetect = {
    PollIntervalMs = 100,   -- how often the reticle checks what it is on
}

lua

Config.Share = {
    DefaultRadiusM = 30,   -- how far "nearby" reaches, in metres
    MaxRadiusM     = 100,  -- the most a player can ask for; the server clamps it
    CooldownMs     = 2000, -- how often one player may refresh the nearby list
    TTLSeconds     = 60,   -- how long an incoming build waits before it expires
    MaxPerMinute   = 5,    -- builds one player may send per minute

    CodeTTLDays              = 30,  -- how long a QSR code keeps working
    MaxCodesPerLicensePerDay = 100, -- new codes one player may register per day
}