Installation

Installation#

🧠 Installation Guide

1. Deployment: Drag and drop the frkn-cleanjob, frkn-cleanlib, and frkn-cleanlib2 folders into your server's resources directory.

frkn-cleanjob
frkn-cleanlib
frkn-cleanlib2

resources

2. Configuration: Add ensure commands for the scripts to your server.cfg. Important: Ensure the libraries before the main job script.

ensure frkn-cleanlib
ensure frkn-cleanlib2
ensure frkn-cleanjob

server.cfg

3. Database: Import the provided SQL files (window.sql) to enable necessary database tables for the scripts, if not already configured via your framework.

Required Dependencies

To ensure the script functions correctly, make sure the following resources are installed and started in your server.cfg:

• ox_lib
• qb-core / es_extended / qbx_core
• ox_target / qb-target (optional, based on your config)
• frkn-cleanlib
• frkn-cleanlib2

[!IMPORTANT] Resource Restart Required: For the script and its internal mechanics (like NativeUI menus, target zones, and props) to initialize properly after the first installation or after making configuration changes, you must restart the server or manually restart the resources listed above. Use the command ensure [resource-name] in your server console to refresh them.

This script relies heavily on frkn-cleanlib and frkn-cleanlib2 for its core mechanics (like raycasting, syncing dirt meshes, and prop management). These libraries must be started before frkn-cleanjob!

⚠️ Dispatch Notification — WEAPON_SPRAYGUN #

This script uses WEAPON_SPRAYGUN for cleaning missions. Most dispatch systems detect this as a "shots fired" event and send false alerts to players.

To prevent this, you need to whitelist/ignore WEAPON_SPRAYGUN in your dispatch script's config.

Weapon Info #

Examples #

Note: Every dispatch script has a different config structure. Find the example that matches yours below.

cd_dispatch / cd_dispatch2 #

📁 config.lua → Look for Config.WeaponBlacklist

lua`WEAPON_SPRAYGUN`, -- Cleaning spray gun

ps-dispatch #

📁 shared/config.lua → Look for Config.BlacklistedWeapons

lua[`WEAPON_SPRAYGUN`] = true, -- Cleaning spray gun

qs-dispatch #

📁 config.lua → Look for Config.IgnoreWeapons

lua`WEAPON_SPRAYGUN`, -- Cleaning spray gun

core_dispatch / rcore_dispatch #

📁 config.lua → Look for Config.IgnoredWeapons

lua"WEAPON_SPRAYGUN", -- Cleaning spray gun

If your dispatch is not listed above, search your config for keywords like Blacklist, Whitelist, Ignore, or Filter and add WEAPON_SPRAYGUN to that list.