Flück

{:links-list}

INSTALLATION

  1. Open the downloaded ZIP product file and drop the BigDaddy-Fluck folder somewhere in your resources folder.
  2. Add your product key (get it here) to the key1 setting in settings.ini.
  3. Install and start BigDaddy-Gizmo. This is required for camera placement and repositioning.
  4. Configure your database connection and start one supported database resource: oxmysql, mysql-async, or ghmattimysql. Fluck automatically creates its required tables.
  5. Configure administrator and terminal permissions as described below. If using framework alerts, inventory items, or CAD integration, start those resources before Fluck too.
  6. Add start BigDaddy-Fluck to your server.cfg after its dependencies.

Example startup order when using oxmysql:

ensure oxmysql
ensure BigDaddy-Gizmo
start BigDaddy-Fluck

DO NOT RENAME THE FOLDER.

Leave the resource folder named BigDaddy-Fluck.

{:is-danger}

COMPATIBILITY/INTEGRATION

Fluck is a license plate reader and vehicle detection camera system. Place cameras around your server, search recorded vehicle movements, create vehicle BOLOs, and receive alerts when a matching vehicle passes a camera or a camera is vandalized.

RESOURCE / INTEGRATION REQUIREMENT
BigDaddy-Gizmo Required for camera placement and repositioning
oxmysql, mysql-async, or ghmattimysql One is required for persistent cameras, detections, BOLOs, and activity records. The running provider is detected automatically
Qbox, QBCore, or ESX Optional. Used to select recipients of local alerts by job and duty status
Standalone Supported without a framework. Local alerts are shown to occupants of emergency-class vehicles
ox_inventory or qb-inventory Optional. Used to check the configured vandalism item
Sonoran CAD Optional. Requires configuration in server.sonoran.lua as well as Provider=sonoran
Custom CAD Optional. server.custom.lua is a template that must be completed for your CAD

CONFIGURATION

settings.ini

The values below match the supplied settings file, with the product key and internal synchronization value replaced by placeholders. Restart the resource after changing settings.

SETTING DEFAULT DESCRIPTION
[licensing]
key1 your product key Enter the product key from your account
[settings]
UseAcePermissions true Require ACE permissions for camera administration and the LEO terminal. Setting this to false allows all players to use those functions
AcePermission command ACE permission required for camera placement, camera administration, camera zone visualization, and the local alert test command
debug true Enables debugging output. Set to false for normal use unless support asks you to enable it
DesyncKey supplied value Internal synchronization key. Do not change this value
[cameras]
PlacementCommand fluckcamera Command used to place a camera. Just the commandname without /
CameraModel whit_bd_fluckcam Camera model. Keep the supplied model for the included camera assembly
DefaultDetectionDistance 45 Detection distance in meters for command-placed cameras. Valid camera distances are 5 to 250 meters
DefaultFieldOfView 70 Detection cone width in degrees for command-placed cameras. Valid camera fields of view are 10 to 180 degrees
DetectionIntervalMs 250 Time between vehicle detection checks, in milliseconds
DetectionZonesCommand fluckzones Command used to toggle camera angle and field-of-view visualization for the current player. Just the commandname without /. Uses camera administrator permission and starts off each session
ShowBlips true Show short-range camera map blips to players. Enabled cameras appear as Fluck Camera; vandalized cameras appear as Fluck Camera (Offline). Administratively disabled cameras have no blip. If this setting is omitted, blips default to off
[alerts]
Enabled true Enable local alerts. CAD alerts are handled separately by the selected CAD bridge
Framework auto Local alert eligibility. Valid values are auto, qbox, qbcore, esx, and standalone. Auto checks Qbox, QBCore, then ESX; without one, it uses standalone eligibility
Jobs police,sheriff,state Comma-separated job names allowed to receive local alerts when using a framework
RequireOnDuty true Require on-duty status when the framework supplies a duty value. If no duty value is provided, the allowed job is sufficient
DisplayDurationMs 8000 Local alert display time in milliseconds, limited to 2500 through 30000
DuplicateCooldownSeconds 30 Suppress repeated local alerts with the same type, camera, and plate within this interval. Set to 0 to disable suppression; maximum is 3600 seconds
VandalismEnabled true Enable local camera vandalism alerts. This does not disable vandalism itself
BoloEnabled true Enable local BOLO hit alerts
SoundEnabled true Play a sound when a local alert is received
TestCommand fluckalerttest Command used to send a test BOLO alert through local alert routing
[terminal]
Command fluck Command used to open the LEO terminal, without /
AcePermission command ACE permission required to search detections and manage BOLOs
[inventory]
VandalismItem blank Item a player must possess to vandalize a camera. Leave blank for no requirement. Checked with ox_inventory or qb-inventory; without either resource running, this requirement is not enforced. The item is not consumed
[bolos]
Provider standalone standalone manages BOLOs inside Fluck. sonoran uses the Sonoran bridge. custom uses your completed custom CAD bridge

OPTIONAL SETTINGS

These settings are supported by the resource but are not present in the supplied settings.ini. Add a missing section if needed, or add the setting under its existing section. The defaults below apply when the settings are omitted.

SETTING DEFAULT DESCRIPTION
[alerts]
HistoryCommand fluckalerts Command used to open recent local alert history
HistoryKey F7 Default key for local alert history. Leave blank to skip registering a key binding. Players can change an existing binding in their FiveM key settings
[data]
RetentionDays 7 Number of days to keep detection, BOLO alert, and camera activity history. Limited to 3 through 7 days
[bolos]
CacheRefreshSeconds 60 Refresh interval for the local database BOLO cache, limited to 60 through 3600 seconds. This is not a CAD polling interval
[vandalism]
Enabled true Enable vandalism and repair commands
VandalismCommand vandalizecamera Command used to vandalize a nearby camera
RepairCommand repaircamera Command used to repair a nearby vandalized camera
InteractionDistance 2.25 Distance in meters within which a camera can be selected for vandalism or repair
VandalismDurationMs 8000 Vandalism action duration in milliseconds, with a minimum of 1000
RepairDurationMs 12000 Repair action duration in milliseconds, with a minimum of 1000
CooldownSeconds 10 Cooldown after a successful interaction for the same player and camera, with a minimum of 1 second
RepairAcePermission blank Separate ACE permission required to repair cameras. Blank allows anyone to repair them
RepairItem blank Optional required repair item. Item checks support ox_inventory and qb-inventory; repair consumes one item only with ox_inventory. A configured repair item blocks repair if neither inventory is running

PERMISSIONS

The supplied file uses command for both administrator and terminal access. To give officers terminal access separately from camera administration, change these values in settings.ini:

[settings]
UseAcePermissions=true
AcePermission=bigdaddy.fluck.admin

[terminal]
Command=fluck
AcePermission=bigdaddy.fluck.leo

Keep your other settings in those sections. Add the following to server.cfg, replacing the example group names with the groups your server uses:

add_ace group.admin bigdaddy.fluck.admin allow
add_ace group.admin bigdaddy.fluck.leo allow
add_ace group.leo bigdaddy.fluck.leo allow

Assign players to the appropriate groups using your server's permission setup. Framework jobs select local alert recipients; they do not automatically grant terminal access. Repair access uses its own RepairAcePermission setting and is unrestricted by default.

CAD INTEGRATION

Leave Provider=standalone to create and manage BOLOs entirely within Fluck and use the included local alerts.

For Sonoran CAD:

  1. Set [bolos] Provider=sonoran in settings.ini.
  2. Open server.sonoran.lua and configure the SonoranConfig table.
  3. Set enabled=true, enter your vehicle BOLO recordTypeId and recordOwner, and check the Sonoran resource name, which defaults to sonorancad.
  4. Map the fields entries to the field UIDs in your Sonoran record: plate, make, model, primaryColor, secondaryColor, and notes. Color fields use numeric GTA color indexes.
  5. Start the configured Sonoran resource before Fluck and enable the record push events needed to import additions, edits, and removals.

The included bridge creates, updates, and removes corresponding CAD records for Fluck BOLOs, imports record changes through Sonoran push events, and sends BOLO hits and vandalism as CAD 911 calls. Its import path uses push events; it does not fetch all existing CAD BOLOs at startup.

For another CAD, set Provider=custom and complete the functions in server.custom.lua for loading, creating, updating, and closing BOLOs and reporting camera hits and vandalism. Set CustomCad.enabled=true after completing the integration. Selecting custom alone does not connect a CAD.

CAD MODE CHANGES ALERT DELIVERY.

With Provider=sonoran or Provider=custom, live BOLO and vandalism alerts are sent to the CAD bridge instead of the local alert system. Configure and enable the selected bridge before using that provider. Local alert settings and local alert history do not control CAD notifications.

{:is-info}

HOW TO PLAY

COMMANDS

These are the default command names. Commands with a matching configuration setting can be renamed.

COMMAND / KEY INFO
/fluckadmin Open the Camera Manager. Requires camera administrator permission
/fluckcamera [name] Place a camera using BigDaddy-Gizmo. The optional name can contain spaces. Requires camera administrator permission
/fluckzones Toggle nearby online camera angle and field-of-view visualization for yourself. Requires camera administrator permission when ACE checks are enabled
/fluck Open the LEO terminal to search detections and manage BOLOs. Requires terminal permission
/fluckalerts Open the last 10 received local alerts from the current session
F7 Default key for local alert history
/fluckalerttest Send a test BOLO alert to eligible local alert recipients. Requires camera administrator permission when ACE checks are enabled; also available from the server console without /
/vandalizecamera Vandalize a nearby online camera, subject to the configured item requirement
/repaircamera Repair a nearby vandalized camera, subject to any configured repair permission and item requirement
Escape Close the terminal, Camera Manager, or alert history panel

PLACING AND MANAGING CAMERAS

  1. Go to the location where you want a camera.
  2. Use /fluckadmin and select ADD CAMERA. Enter a name, detection distance, and field of view, then save to begin placement. Alternatively, use /fluckcamera Mission Row to place a camera with that name and the configured default range and field of view.
  3. Position and rotate the camera using the BigDaddy-Gizmo controls, then confirm placement. Aim the lens toward the traffic you want to record.
  4. Use /fluckzones to show the camera's detection angle and field of view. Drive through the cone to check the result, then use /fluckzones again to hide the visualization.

Camera zone visualization is off at the start of each session and after a resource restart. The command only changes your own view and draws zones for online cameras within 300 meters. Rename the command with [cameras] DetectionZonesCommand. This replaces the old ShowDetectionZones setting, which is no longer used.

Set [cameras] ShowBlips=true to display short-range camera map blips, or false to hide them, then restart the resource. Blips are visible to players without requiring camera administrator permission. Vandalized cameras retain a blip marked (Offline); administratively disabled cameras have no blip. The zone visualization command does not toggle map blips.

The Camera Manager lists camera names, IDs, coordinates, ranges, fields of view, and status. Use EDIT to change the name or detection settings, WAYPOINT to locate a camera, REPOSITION to move it, or ENABLE / DISABLE to change its administrative state. DELETE permanently removes the camera after confirmation.

STATUS MEANING
ONLINE Enabled and recording vehicles that enter its detection cone
OFFLINE Vandalized and requires repair before recording can resume
DISABLED Disabled by an administrator. Its world model is removed while disabled

Enabling a vandalized camera does not repair it. Camera placement and status are saved in the database.

SEARCHING VEHICLE DETECTIONS

Open /fluck and search by plate, make/model, camera, direction, primary or secondary color, minimum or maximum MPH, and date/time range. Plate and make/model searches support partial text.

Results show vehicle details, colors, occupant count, damage status, camera location, speed, direction, heading, and detection time. Use HISTORY to see up to 250 recent detections for the same plate, or SET WAYPOINT to locate the detecting camera. Use PREVIOUS and NEXT to move through search results.

Cameras record player-driven vehicles entering their detection cones. They do not continuously scan every parked vehicle or NPC vehicle. A vehicle remaining inside a cone is not recorded again on every detection check; it must leave and re-enter for another entry to be recorded, and the server also limits rapid repeat detections.

VEHICLE BOLOS

Open the terminal's BOLOS tab and add a vehicle BOLO. Enter at least one identifying value: plate, make, model, primary color, or secondary color. Notes alone are not enough.

Every identifier you enter must match for an alert to trigger. Plate, make, and model matching uses the full value and ignores letter case; partial search text is not a BOLO wildcard. Leave unknown fields blank to avoid excluding the vehicle you want to find.

Fluck-created BOLOs can be closed, reopened, or deleted from the terminal. CAD-imported BOLOs are marked MANAGE IN CAD and must be managed in the CAD. Active BOLOs are checked against new detections from online cameras.

ALERTS AND HISTORY

In standalone BOLO mode, eligible players receive local BOLO hit and camera vandalism alerts. With a supported framework, eligibility follows Jobs and RequireOnDuty. Without a framework, players must be inside an emergency-class vehicle when the alert arrives.

Press F7 or use /fluckalerts to review the last 10 received local alerts from the current session. Set a waypoint when location information is available, or use CLEAR HISTORY to clear that local list. This panel is separate from the database detection history.

Use /fluckalerttest to check local alert routing. The test still follows the enabled settings, recipient requirements, and duplicate cooldown; it is not a CAD connection test.

VANDALISM AND REPAIRS

Stand near an online camera and use /vandalizecamera. If an item is configured and a supported inventory is running, you must possess that item. The vandalism animation takes 8 seconds by default, after the player moves into position. Successful vandalism knocks the camera offline and reports the incident through the selected alert provider.

To restore it, stand near the camera and use /repaircamera. Repairs take 12 seconds by default, after positioning, and restore recording when complete. Anyone can repair a camera by default; configure RepairAcePermission or RepairItem to restrict repairs. Vandalized cameras remain offline until repaired, including after a resource restart.

TROUBLESHOOTING

PROBLEM CHECK
Commands do not become available Check the server console for licensing errors, verify the product key, and confirm the resource folder is named BigDaddy-Fluck
Camera Manager or terminal denies access Check the relevant ACE setting and the player's group membership. Camera administration and terminal access can use different permissions
Cameras or detections do not load Confirm a supported database provider is started and the database connection works. Check the server console for database errors
Camera placement fails Confirm BigDaddy-Gizmo is started and the supplied streamed camera models are installed
Camera is not recording Check that it is online, inspect its cone with /fluckzones, and drive a player-controlled vehicle through the covered area
Camera zones do not appear Use /fluckzones with camera administrator permission and stand within 300 meters of an online camera. Visualization starts off each session; the old ShowDetectionZones setting no longer enables it
Camera map blips do not appear Set [cameras] ShowBlips=true and restart the resource. Disabled cameras have no blip, and minimap blips are short-range
Local alerts do not appear Check the BOLO provider, alert toggles, job/duty eligibility, and duplicate cooldown. Standalone recipients must occupy an emergency-class vehicle
CAD alerts or imports do not appear Check the selected provider, the bridge's enabled setting, and its configuration. Sonoran imports require record push events; custom CAD functions must be implemented
Vandalism item requirement is ignored Confirm ox_inventory or qb-inventory is running. Without a supported inventory, the vandalism item requirement is bypassed
Camera remains offline after enabling it Repair the camera using /repaircamera. Administrative enable/disable and vandalism are separate states