Config Settings

Config Settings

🧹 Cleaning Scripts Configuration Guide

This documentation provides a comprehensive overview of the shared/config.lua for the FRKN Clean Job script. Use this guide to customize interaction modes, job locations, clothing, and overall mechanics.

shared/config.lua

---

1. Interaction and Target Settings

This section defines how players interact with the world: either through 3D text UI or third-party target scripts.

• interactionMode: Defines the global interaction type (e.g., "textui" or "target").

• textUISettings.name: The text UI system to use ("ox_lib", "drawtext3d", "qb-core", "okokTextUI").

• targetSettings.name: Set this to "qb-target" or "ox_target".

• TargetText: Customize the labels and icons (FontAwesome) for various interactions like starting a mission, talking to the NPC, and operating machinery.

2. Blip and Ped Settings

Configure the main NPC and map blips for the job center.

• BlipSettings: Adjust the sprite (e.g., 457), color (3), scale, and label for map blips. It also includes default mission vehicle blip configurations.

• PedSettings: Defines the job giver's spawn coordinates (coords), model (a_m_m_business_01), and localized map blip.

3. Vehicle and Fuel Settings

Controls the properties of the vehicles spawned for multi-location cleaning missions.

• VehicleFuel.enabled: Automatically set fuel levels when mission vehicles are spawned (true or false).

• VehicleFuel.fuelExport: The fuel export layout your server uses (supports "LegacyFuel", "cdn-fuel", "ox_fuel", "ps-fuel", or false for native only).

4. Item Integration

Links inventory items to their required tools. These must match the names in your inventory!

• Items: Defines standard required tools: drone, trash_grabber, water_gun, squeegee, broom.

5. Work Clothes & Props

Customize the animations and visual representation of the player during missions.

• WorkClothes: Enable auto-applying uniforms (autoApply = true). Define clothing component arrays for male and female peds under each mission type (e.g., window, streetcleaning, cleanjob).

• SprayBackpack / BroomAttach: Fine-tune bone attachments, positioning (pos), and rotation (rot) specifically for cleaning props and backpack items to ensure perfect alignment.

6. Mission Configuration (Locations & Difficulties)

The Missions table acts as the backbone of the script, offering extensive customization for where and how players work.

Each category (e.g., ["window"], ["cleanjob"]) contains multiple cleaningSpots, which define:

• label, desc, image: UI references for the job tablet.

• earnMoney, earnXp: Payouts and experience point rewards per job.

• single / drone / cleanjob: Toggles specific mission logics (like skipping squeegees, enabling UAV flight, or single-spot stationary tasks).

• locations: An array of individual dirt spots (camPos, heading, dirtConfig), deciding exactly where players have to aim their tools to clean the spot (supports "oil", "moss", "trash", "blood", "graffiti", etc.).

7. Global Settings

• Language: Localization toggle (e.g., 'en' or 'tr'). Modify locales/*.lua for deep translation.

• MaxPlayers: Maximum lobby size for multiplayer missions.

• LevelMultiplier: Adjust scaling of rewards or difficulty points.

• CancelCommand: The chat command players can use to forcefully end their mission ("cancelclean" by default).