Configuration Reference

Every setting in oxide-pestcontroljob, what it does, and its factory default.

How Settings Work

Settings are edited in-game with the /pestcontrol settings command (admins only). Changes save to your database and apply instantly, with no restart needed.

The editor groups settings into six categories (Core, Economy, Vehicles, World, Gameplay, Presentation) and has a search box. Everyday settings are on the Basic tab; finer tuning is on the Advanced tab. Every setting has a Reset to default button.

The config files in the shared/ folder are factory defaults. The first time the resource starts, every value is imported from the files into the database (the oxide_settings table). From then on, the database is the source of truth and editing the files has no effect on settings that are already stored. Only brand-new settings added by a future update are imported from the files.

This applies to everything, including the depot and the property list. Once the resource has started even once, /pestcontrol settings is the way to change a setting on a running server.

Settings marked "File only"

A few settings are not shown in the editor (they're marked File only below). They are still stored in the database. To change one after the first start:

1. Edit the value in its config file and save the file.
2. Restart the whole server.
3. Open /pestcontrol settings and press Reset to default on the setting that holds it (for example Wasps → Wasp nests for anything in Config.Wasp).

Reset to default copies the whole setting from the file as it was when the server started. Any part of that setting you had changed in the editor goes back to the file's value too, so re-enter those changes afterwards.

When changes take effect

Most changes apply immediately. A few apply later:

• Levels, the van's model and appearance, and uniforms apply at the next clock-in.
• Properties, site layout and the call timer apply to new calls. A call in progress keeps the property and layout it started with.

The tables below document every setting and its factory default.

Config File Map

Distances are in metres, times in seconds, and amounts in dollars, unless noted.

General Settings

File: shared/config.lua | In the editor: Core → General

Config.Debug = false
Config.usePhone = true
Config.shiftSummary = 'text'     -- 'nui' or 'text'
Config.menuStyle = 'nui'         -- 'nui' or 'menu'
Config.MaxSlotsPerLocation = 3
Config.DebugForceSpecies = 'off' -- 'off', 'roach', 'rat' or 'wasp'

Below these settings, the same file lists fixed names the job uses internally (shift states, pests, property kinds and call stages). Don't change those.

Job Settings

File: shared/config/job.lua

Crew

In the editor: Core → Crew

Config.Crew = {
    maxSize = 2,
    inviteTimeout = 60,
    coopBonusPercent = 0.15,
}

Payment

In the editor: Economy → Payment

The waste, pet bowl, vegetable bed and sting charges are treatment charges: they come off the shift pay at clock-out. See Payment for how a call's pay is worked out.

Config.Payment = {
    basePay = {
        roach = 90,
        rat   = 100,
        wasp  = 130,
    },
    kindMultiplier = {
        house      = 1.0,
        restaurant = 1.2,
        warehouse  = 1.4,
    },
    distanceBonusPerUnit = 0.25,
    speedBonusAmount = 25,
    fullFindBonus = 40,
    glueTrapBonus = 8,
    wasteCostPerUnit = 2,
    exclusionPenalty = 40,
    stingPenalty = 20,
    wrongTreatmentFactor = 0.4,
    missedNestFactor = 0.7,
    vehicleDestroyFine = 200,
    streakBonusPerDay = 10,
    maxStreakDays = 7,
    gasFeePercent = 0.05,
    taxPercent = 0.10,
    payoutAccount = 'bank',
    fineAccount = 'cash',
}

Complaints

In the editor: Core → Complaints (Advanced tab)

Config.Complaints = {
    maxComplaints = 3,
    timeoutMinutes = 30,
    callbackPenalty = 1,
    exclusionPenalty = 1,
    vehicleDestroyPenalty = 1,
    deathPenalty = 1,
    decayPerJob = 1,
    callbackDelaySeconds = 90,
}

Timer

In the editor: Economy → Calls & Dispatch → Call timer

Config.Timer = {
    baseTime = 420,
    timePerDistanceUnit = 0.20,
    expiredPenalty = 0.85,
}

-- timeLimit = baseTime + math.floor(distance * timePerDistanceUnit)

Calls

In the editor: Economy → Calls & Dispatch → Call dispatch

The cancel cooldown is a floor, not an extra delay on top: after a cancel, the next call arrives once both the normal 15 to 45 second gap and the cooldown have passed.

Config.Calls = {
    minIntervalSeconds = 15,
    maxIntervalSeconds = 45,
    responseTimeSeconds = 30,
    maxMissedCalls = 3,
    cancelCooldownSeconds = 60,
    arrivalMargin = 15.0,
    maxTravelSpeed = 50.0,
    speciesWeights = {
        roach = 45,
        rat   = 35,
        wasp  = 20,
    },
}

Unlocks

In the editor: Economy → Progression → Unlocks

The level each part of the job opens at.

Houses are always open.

Config.Unlocks = {
    restaurant = 2,
    warehouse = 3,
    exclusions = 2,
    wasp = 3,
    speciesHint = 3,
    ladderFall = 4,
    fullFindBonus = 5,
}

Levels

File: shared/config/levels.lua | In the editor: Economy → Progression → Levels

Config.Levels is the list of levels, lowest first (row 1 is level 1). Each level has:

Keep requiredJobs increasing from row to row. There must be at least one level.

Config.Levels = {
    [1] = { title = 'level.trainee',              requiredJobs = 0,   payMultiplier = 1.0,  tipChance = 0.10, tipRange = { 5, 15 },  pingRadius = 12.0, wasteAllowance = 0.6 },
    [2] = { title = 'level.technician',           requiredJobs = 15,  payMultiplier = 1.1,  tipChance = 0.15, tipRange = { 5, 20 },  pingRadius = 9.0,  wasteAllowance = 0.45 },
    [3] = { title = 'level.senior_technician',    requiredJobs = 40,  payMultiplier = 1.2,  tipChance = 0.25, tipRange = { 10, 30 }, pingRadius = 6.0,  wasteAllowance = 0.3 },
    [4] = { title = 'level.field_specialist',     requiredJobs = 80,  payMultiplier = 1.35, tipChance = 0.30, tipRange = { 10, 40 }, pingRadius = 4.0,  wasteAllowance = 0.2 },
    [5] = { title = 'level.master_exterminator',  requiredJobs = 150, payMultiplier = 1.5,  tipChance = 0.40, tipRange = { 15, 50 }, pingRadius = 0.0,  wasteAllowance = 0.15 },
}

The titles show as Trainee Technician, Technician, Senior Technician, Field Specialist and Master Exterminator.

Locations

File: shared/config/locations.lua | In the editor: World → Locations

Config.Locations is the list of depots. The job ships with one, Bugstars Pest Control. Each entry is a complete, independent depot with its own clerk, map blip, van spot and technician slots.

Config.Locations = {
    {
        name = 'location.depot',
        coords = vector3(870.00, -2170.45, 30.50),
        heading = 175.0,
        vehicleSpawn = vec4(874.00, -2177.50, 30.00, 265.0),
        menuCamera = { distance = 3.2, angle = 12.0, elevation = 6.0, fov = 45.0 },
    },
}

Adding a second depot

1. Open /pestcontrol settings and go to World → Locations.
2. Add a row. Give it a name.
3. Use Place in world on Clerk spot: it previews the clerk and also sets Facing.
4. Use Place in world on Van spawn: it previews the van.
5. Press Save Changes. The new clerk and blip appear right away, facing the way you set.

The shift menu's camera follows the clerk on its own. To change the shot, use Set up in world on Menu camera and press Save Changes.

Each depot gets its own technician slots (Config.MaxSlotsPerLocation, 3 by default, so two depots means six technicians in total). A shift belongs to the depot the player clocked in at: that's where their van spawns.

You can edit, reorder or delete depots while technicians are on shift. A shift keeps its depot as long as the depot keeps either its name or its clerk spot. If you delete a depot (or change its name and its clerk spot in the same save), the shifts there end straight away and are paid, and the players are told their depot was removed.

Calls are shared, not per depot. The property list is one list for the whole job, and dispatch picks from all of it no matter which depot a player clocked in at. A second depot does not need properties of its own. If it's far from the shipped properties, you may want to add a few near it (see Properties), so its technicians aren't always driving across the map. Pay and the timer both scale with distance, so far-away calls aren't unfair, just slow.

Properties

File: shared/config/properties.lua | In the editor: World → Properties

Config.Properties is every place a call can be sent. The job ships with 12 (see Properties for the list). The list stays on the server: players' games only receive the property their call is at.

Config.Properties = {
    {
        label = 'Forum Drive (Strawberry)',
        kind = 'house',
        center = vector3(-15.90, -1430.82, 29.67),
        radius = 21.29,
        segments = {
            { a = vector3(-20.22, -1443.39, 29.62), b = vector3(-7.05, -1443.39, 31.17) },
            -- ...one row per wall run, all the way round
        },
        wasp = {
            { nest = vector4(-14.20, -1443.24, 32.61, 0.00), ladder = vector4(-14.20, -1443.94, 29.82, 0.00) },
        },
        exclusions = {
            { kind = 'petbowl', coords = vector4(-21.22, -1434.77, 29.65, 180.00) },
            { kind = 'vegbed', coords = vector4(-13.49, -1423.93, 29.69, 180.00) },
        },
    },
    -- ...the other 11 properties
}

Adding a property

The easiest way is in the world: in /pestcontrol settings → World → Properties, press Add in world under the list, or Edit in world on a property, and fly round it. Everything below is drawn where it is, and the editor says what's wrong before you save. See Admin Tools.

To do it with the form instead:

1. Open /pestcontrol settings and go to World → Properties.
2. Add a row. Type a Name and choose a Kind.
3. Center: use Place in world and pick the middle of the building at ground height. Set a Radius that covers the building and its yard.
4. Foundation line: add one row per stretch of outside wall. For each row, place From and To on the ground about 0.4 metres out from the wall. Go all the way round the building, corner to corner.
5. Wasp nest spots (optional): place Nest under an eave, with its heading facing the wall. Place Ladder on the ground below it, facing the wall. The eave must be about 2.3 to 4.0 metres above the ladder spot, and the ladder spot within 1.5 metres of the point under the nest. The editor refuses a spot the stepladder can't reach and says which property and spot it is, and by how much it is too high, too low or too far.
6. No-spray spots (optional): choose Pet bowl or Vegetable bed and place the Spot by the foundation line.
7. Press Save Changes. The property can be picked for new calls straight away.

The editor refuses a property that's missing a name, a kind, a centre, a radius or a foundation line, that has a run shorter than 0.5 metres or a spot with no position, or that has a wasp nest spot the stepladder can't reach. The message says which property (and which wasp spot) needs fixing. Use Teleport here on any point to go and check it.

Site Layout and No-Spray Spots

File: shared/config/sites.lua | In the editor: World → Properties (Advanced tab)

Config.Sites (Site layout)

How signs are laid out around a property when the crew arrives, and how many finish the inspection. Applies to new calls.

Config.Sites = {
    signs = { house = 7, restaurant = 9, warehouse = 11 },     -- besides the nest
    required = { house = 4, restaurant = 5, warehouse = 6 },  -- signs to log before the inspection is done
    spacing = 1.6,
    nestPull = 8.0,
    strays = 0.08,
    spotStep = 1.5,
    mix = {
        rat = {
            { kind = 'droppings_rodent', weight = 4 },
            { kind = 'gnaw', weight = 3 },
            { kind = 'grease', weight = 3 },
        },
        roach = {
            { kind = 'droppings_roach', weight = 6 },
            { kind = 'grease', weight = 4 },
        },
    },
    renderDistance = 80.0,
}

Config.Exclusions (No-spray spots)

What stands on a no-spray spot, and how close the spray may come.

Config.Exclusions = {
    petbowl = { model = 'm25_1_prop_m51_dog_bowl_full', radius = 0.9 },
    vegbed = { model = 'prop_veg_crop_02', radius = 1.6 },
}

Vehicle

File: shared/config/vehicles.lua | In the editor: Vehicles → Vehicle

Model and appearance changes apply at the next clock-in.

Every gear option on the van (take the torch, the sprayer, bait stations, glue traps, the ladder or the foam can, refill the sprayer, return the sprayer) only shows to a technician standing behind the van. Both rear doors open, a short progress bar plays while they reach in, and the doors shut again afterwards. If the crew partner is still reaching in, the doors stay open until they are done. If you change the van's model, check rear.doors and rear.offset fit the new one.

Config.Vehicle = {
    model = 'burrito2',
    plate = 'BUGSTARS',
    healthCheckInterval = 1000,
    destroyedThreshold = 150,
    damageChargeRate = 0.50,
    damageChargeThreshold = 950,
    livery = -1,
    extras = nil,
    rear = {
        doors = { 2, 3 },
        offset = -3.4,
        radius = 1.5,
        durationMs = 1500,
        anim = { dict = 'mini@repair', clip = 'fixing_a_player', flag = 1 },
    },
}

Clerk, Blips and Waypoints

File: shared/config/visuals.lua | In the editor: World → NPCs & Blips

Config.NpcModel = 's_m_y_pestcont_01'
Config.NpcScenario = 'WORLD_HUMAN_CLIPBOARD'

Config.Blip = { enabled = true, sprite = 273, color = 2, scale = 0.8 }
Config.EventBlip = { sprite = 463, color = 1, scale = 1.2 }

Config.Waypoints = {
    heightOffset = 5.0,
    updateInterval = 0,
    scaleMin = 0.5,
    scaleMax = 1.0,
    scaleNearDist = 30.0,
    scaleFarDist = 300.0,
}

Gear, Inspection and HUD

File: shared/config/gear.lua

Config.Kit (Gear)

In the editor: Gameplay → Gear (Advanced tab)

The torch and the backpack tank. Where technicians take them from is set under Vehicle (Config.Vehicle.rear).

Config.Kit = {
    renderDistance = 60.0,
    tank = {
        male = 'oxide_pest_sprayer_tank_m',
        female = 'oxide_pest_sprayer_tank_f',
        bone = 24818,
        outlet = {
            male = vec3(-0.3776, -0.2304, -0.1698),
            female = vec3(-0.3746, -0.2151, -0.1698),
        },
        hideInVehicles = true,
    },
    torch = {
        model = 'prop_scn_police_torch',
        bone = 60309,                       -- left hand
        offset = vec3(0.0, 0.0, 0.0),
        rotation = vec3(0.0, 0.0, 0.0),
        bulb = vec3(0.219, 0.0, 0.0),       -- the beam starts here
        anim = { dict = 'amb@world_human_security_shine_torch@male@base', clip = 'base', flag = 49 },
    },
}

Config.Inspection (UV inspection)

In the editor: Gameplay → Inspection

The signs only show for the crew working the call. Each sign is a model that shows in any light, and its glowing twin takes its place while the technician's own beam is on it. Signs at a wall sit at the foot of the wall, on the ground in front of it, and follow the ground's slope.

Config.Inspection = {
    claimRange = 2.6,
    claimAngle = 20.0,
    claimHoldMs = 500,
    serverRange = 3.5,
    serverAngle = 75.0,
    minGapMs = 600,
    minSecondsOnSite = 2,
    beamPitch = -15.0,
    cone = {
        range = 9.0,
        angle = 26.0,
    },
    light = {
        r = 150, g = 90, b = 255,
        distance = 12.0,
        brightness = 8.0,
        hardness = 0.0,
        radius = 18.0,
        falloff = 30.0,
    },
    glow = {
        r = 170, g = 110, b = 255,
        lightRange = 1.4,
        lightIntensity = 3.0,
    },
    spots = {
        droppings_rodent = { floor = { model = 'oxide_pest_sign_droppings_rodent', uv = 'oxide_pest_sign_droppings_rodent_uv', centre = vec3(0.0, 0.0, 0.004), sink = 0.001 } },
        droppings_roach = { floor = { model = 'oxide_pest_sign_droppings_roach', uv = 'oxide_pest_sign_droppings_roach_uv', centre = vec3(0.0, 0.0, 0.003), sink = 0.001 } },
        gnaw = { wall = { model = 'oxide_pest_sign_gnaw', uv = 'oxide_pest_sign_gnaw_uv', centre = vec3(0.0, 0.002, 0.0234), sink = 0.004 } },
        grease = { wall = { model = 'oxide_pest_sign_grease', uv = 'oxide_pest_sign_grease_uv', centre = vec3(0.0, 0.003, 0.0585), sink = 0.004 } },
        nest_rat = {            -- the burrow
            wall = { model = 'oxide_pest_sign_burrow', uv = 'oxide_pest_sign_burrow_uv', centre = vec3(0.0, 0.06, 0.02), sink = 0.015 },
            floor = { model = 'oxide_pest_sign_burrow_ground', uv = 'oxide_pest_sign_burrow_ground_uv', centre = vec3(0.0, 0.0, 0.02), sink = 0.015 },
        },
        nest_roach = { wall = { model = 'oxide_pest_sign_harborage', uv = 'oxide_pest_sign_harborage_uv', centre = vec3(0.0, 0.02, 0.01), sink = 0.004 } },
    },
    ground = {
        sink = 0.004,
        maxTilt = 30.0,
        wallGap = 0.01,
        step = 0.12,
    },
    pingIntervalMs = 2000,
}

Card positions

In the editor: Presentation → HUD → Card positions

Where the stage card (top left) and the findings card (top right) sit when no server HUD places them. Each card has its own position.

Most servers keep their HUD in the top corners, so both cards start lower. When Oxide HUD runs (with o-link 1.12.1 or newer), it places both cards itself and Config.HudLayout isn't used. See On-screen cards and Oxide HUD.

Config.HudLayout = {
    topLeft = { top = 30, side = 3 },   -- the stage card
    topRight = { top = 30, side = 3 },  -- the findings card
}

Config.UseHudAccent = true

Treatment

File: shared/config/treatment.lua

Config.Spray (Backpack sprayer)

In the editor: Gameplay → Treatment → Backpack sprayer

The two shipped patterns:

File only

These control how the hose, the wand and the spray are drawn and animated. They aren't in the editor. Leave them alone unless you are fitting your own wand model.

Config.Spray = {
    tankUnits = 60.0,
    needPerMetre = 0.8,
    minCoverage = 0.85,
    reach = 4.0,
    hitWidth = 1.75,
    harborageNeed = 2.0,
    harborageRadius = 1.2,
    exclusionUnits = 0.8,
    exclusionAngle = 25.0,
    coverageUpdateMs = 500,

    length = 3.0,
    warnAt = 0.95,
    maxTargets = 4,
    renderDistance = 60.0,
    fxDistance = 30.0,
    maxRopes = 6,
    tickMs = 1000,
    leashSlack = 3.0,
    teleport = 30.0,
    hitsInterval = 800,

    rope = { radius = 0.0075, sections = 6, uvScale = { 1.0, 20.0 }, type = 4, slack = 0.25 },
    pressure = { minRangeScale = 0.8, sputterBelow = 0.05 },
    pitch = { min = -50.0, max = 15.0, offset = 0.0 },

    patterns = {
        {
            name = 'fan',
            speed = 5.0, gravity = 9.81, maxReach = 3.2, splashRadius = 0.8,
            flow = 1.0,
            fx = { asset = 'core', name = 'water_cannon_spray', scale = 0.18 },
        },
        {
            name = 'stream',
            speed = 8.0, gravity = 9.81, maxReach = 5.5, splashRadius = 0.4,
            flow = 0.7,
            fx = { asset = 'core', name = 'water_cannon_jet', scale = 0.05 },
        },
    },

    splash = { asset = 'core', name = 'ent_sht_water', scale = 0.3, interval = 300 },

    models = { nozzle = 'oxide_pest_sprayer_wand' },
    hand = { bone = 28422, offset = vec3(0.0, 0.0, 0.0), rotation = vec3(0.0, 0.0, 0.0) },
    sockets = {
        tip = vec3(0.7403, -0.0396, 0.0845),
        inlet = vec3(-0.1549, -0.0098, -0.0177),
    },
    nozzleFallback = {
        model = 'prop_hose_nozzle',
        hand = { bone = 28422, offset = vec3(0.3879, -0.0207, 0.0444), rotation = vec3(-6.52, 61.71, 86.95) },
        sockets = { tip = vec3(0.0, -0.165, 0.0), inlet = vec3(0.0, 0.165, 0.0) },
    },
    anim = {
        dict = 'anim@weapons@heavy@space_cannon', clip = 'aim_low_loop', flag = 49,
        aims = {
            { clip = 'aim_low_loop', pitch = -35.0 },
            { clip = 'aim_med_loop', pitch = 4.0 },
            { clip = 'aim_high_loop', pitch = 49.0 },
        },
    },
    keys = { spray = 24, patternUp = 241, patternDown = 242, putBack = 194 },
}

Config.Devices (Bait stations and glue traps)

In the editor: Gameplay → Treatment → Bait stations & glue traps

Config.Devices = {
    bait = { model = 'oxide_pest_bait_station', max = 4 },
    glue = { model = 'oxide_pest_glue_trap', max = 4 },
    placeRange = 5.0,
    spacing = 1.5,
    placeAnim = { dict = 'amb@medic@standing@kneel@base', clip = 'base', flag = 1 },
    placeDuration = 1800,
}

Config.Treatment (Report rules)

In the editor: Gameplay → Treatment → Report rules (Advanced tab)

What a report counts as the right treatment and a treated nest.

Config.Treatment = {
    runwayDistance = 1.2,
    runwaySignRange = 4.5,
    minStations = 2,
    burrowRange = 4.0,
    glueRange = 2.5,
}

Config.Report (Filing the report)

In the editor: Gameplay → Treatment → Filing the report

Filing the report at the van takes a few seconds of paperwork: the technician holds a clipboard and writes on it, with a progress bar, and other players see the clipboard and the animation. Cancelling the bar files nothing. The server pays the call only once the paperwork has had its full time.

Other players see the clipboard with every progress bar that shows a held prop: ox_lib, oxide-progressbar, QBCore's progressbar and zsxui. esx_progressbar, lation_ui, keep-progressbar and wasabi_uikit show no props, so with those the animation plays without the clipboard.

Config.Report = {
    durationMs = 4000,
    anim = { dict = 'amb@world_human_clipboard@male@base', clip = 'base', flag = 49 },
    prop = { model = 'p_cs_clipboard', bone = 60309, offset = vec3(0.0, 0.0, 0.0), rotation = vec3(0.0, 0.0, 0.0) },
}

Wasps

File: shared/config/wasp.lua | In the editor: Gameplay → Wasps → Wasp nests

File only

Config.Wasp = {
    nestModel = 'oxide_pest_wasp_nest',
    foamedModel = 'oxide_pest_wasp_nest_foamed',
    ladderModel = 'prop_paint_stepl01',
    nestHeight = 0.322,
    swarmFx = { asset = 'core', name = 'ent_amb_insect_swarm', scale = 1.0 },

    can = {
        model = 'prop_cs_spray_can',
        bone = 28422,
        offset = vec3(0.0, 0.0, -0.03),
        rotation = vec3(0.0, 0.0, 0.0),
        nozzle = vec3(0.0, 0.0, 0.14),
    },
    foamFx = { asset = 'core', name = 'weap_extinguisher', scale = 0.45 },

    ladderRange = 2.5,
    climb = {
        reach = 2.1,
        tolerance = 0.25,
        maxSpotOffset = 1.5,
        gap = 0.05,
        backLegs = 0.19,
        standBack = 0.08,
        steps = {
            { height = 0.28, depth = 0.54 },
            { height = 0.58, depth = 0.49 },
            { height = 0.87, depth = 0.43 },
            { height = 1.17, depth = 0.37 },
            { height = 1.49, depth = 0.20 },
        },
        anim = { dict = 'amb@prop_human_movie_bulb@base', clip = 'base', flag = 1 },
    },
    camera = {
        out = 1.55,
        down = 0.85,
        fov = 50.0,
    },

    killSeconds = 6.0,
    nestRadius = 0.17,
    agitation = {
        base = 0.04,
        miss = 0.22,
        calm = 0.10,
    },
    push = {
        strength = 0.10,
        rate = 0.8,
    },
    sampleMs = 100,
    minSampleMs = 70,
    maxAimSpeed = 4.0,
    keepOnSting = 0.5,
    idleTimeoutMs = 5000,
    sting = {
        damage = 10,
        fallDamage = 15,
        shake = 'jolt_SHAKE',
        shakeAmplitude = 0.8,
    },

    scrape = {
        model = 'prop_cs_trowel',
        residue = 100.0,
        perStroke = 6.0,
        strokeLength = 0.05,
        minStrokeMs = 120,
        reach = 0.22,
        hand = { bone = 28422, offset = vec3(0.0, 0.0, 0.0), rotation = vec3(0.0, 0.0, 0.0) },
    },
}

Uniforms

File: shared/config/outfits.lua | In the editor: Presentation → Uniforms

An optional work uniform. When it's on, a Put On Uniform button appears in the shift menu while on shift. The player's own clothes come back when they press Remove Uniform or when the shift ends for any reason.

Config.uniformsEnabled = false

Config.PestControlOutfitMale = {
    components = {},
    props = {},
}

Config.PestControlOutfitFemale = {
    components = {},
    props = {},
}

The outfits ship empty on purpose. The numbers for a piece of clothing depend on the clothing packs your server runs, so a number that gives a work shirt on one server can give something else, or nothing, on another. You need to find your own.

How an outfit is written

Each outfit has two lists:

• components: clothing. Each row has a component_id (the clothing slot), a drawable (which item) and a texture (which colour or pattern of that item).
• props: accessories. Each row has a prop_id (the accessory slot), a drawable and a texture.

List only the slots you want to change. Slots you leave out keep the player's own clothes.

The slot numbers are fixed in GTA:

Step 1: find your numbers

1. Join your server on a male character.
2. Open your server's clothing menu (for example a clothing store) and put together the work outfit you want.
3. For each piece, write down its slot, the item number (drawable) and the colour or texture number your clothing menu shows.
4. Do the same on a female character. Male and female clothing use different numbers, so you need both.

Step 2: enter the outfits

In the settings editor (works on a running server):

1. Type /pestcontrol settings and go to Presentation → Uniforms.
2. Switch to the Advanced tab.
3. Open Male outfit. Under Components, press Add for each clothing piece and fill in Component (the slot), Drawable and Texture. Under Props, do the same for any hat, glasses or other accessory, using Prop, Drawable and Texture.
4. Open Female outfit and do the same with your female numbers.
5. Press Save Changes.

Or in the file (best before the job's first start):

Open shared/config/outfits.lua and add one line per piece, inside the right list, then save:

Config.PestControlOutfitMale = {
    components = {
        -- one line per clothing piece, with your own numbers:
        -- { component_id = SLOT, drawable = ITEM, texture = COLOUR },
    },
    props = {
        -- one line per accessory, with your own numbers:
        -- { prop_id = SLOT, drawable = ITEM, texture = COLOUR },
    },
}

Replace SLOT, ITEM and COLOUR with your numbers and remove the -- at the start of each line you use. After the job has started once, a file change only applies after you restart the server and press Reset to default on Male outfit or Female outfit in the editor (see How Settings Work), so the editor is easier.

Step 3: turn uniforms on

1. In /pestcontrol settings, go to Presentation → Uniforms on the Basic tab.
2. Turn on Uniforms (Config.uniformsEnabled).
3. Press Save Changes.

Step 4: test it

1. Clock in at the depot.
2. Talk to the clerk again and press Put On Uniform. You should change into the outfit and see "Work uniform equipped."
3. Press Remove Uniform or clock out. Your own clothes come back.

If a piece looks wrong or invisible, its numbers don't exist in your clothing packs for that body. Check them in your clothing menu and correct them in the editor.

Model Compatibility

File: shared/config/models.lua | In the editor: Presentation → Compatibility → Model replacements

Every model the job spawns is checked before it loads. If one doesn't exist on a player's game build (older builds lack the newer props), it's skipped with a warning instead of freezing, and online admins get a notification naming it, once:

[oxide-pestcontroljob] model "m25_1_prop_m51_dog_bowl_full" is not on this game build. Set a replacement in /pestcontrol settings.

Nothing is replaced automatically. You choose the replacement:

Config.ModelSwaps = {
    { from = 'm25_1_prop_m51_dog_bowl_full', to = 'prop_cs_bowl_01' },  -- example: a different pet bowl
}

In the editor, add a row under Model replacements: Replace is the model name exactly as the warning shows it, With is a model your game build has.

Base-game models the job uses, all replaceable:

The job's own models (oxide_pest_sprayer_tank_m, oxide_pest_sprayer_tank_f, oxide_pest_sprayer_wand, oxide_pest_bait_station, oxide_pest_glue_trap, oxide_pest_wasp_nest, oxide_pest_wasp_nest_foamed and the oxide_pest_sign_* signs with their _uv twins) ship in the resource's stream/ folder. If one of those is reported missing, the warning says the install is incomplete: check the stream/ folder is there and restart the whole server.

Config.ModelHints and Config.SettingsCommand in the same file only set the wording of these warnings. Leave them alone.

Tutorials

File: shared/config/tutorials.lua | In the editor: Presentation → Tutorials (Advanced tab)

Config.Tutorials holds 19 first-time tips, keyed by moment (first_clockin, first_arrival, first_inspection, first_signs, first_findings, first_spray, first_wasp, first_climb, first_scrape, first_callback and so on). Each one has:

The tip text itself lives in locales/en.json, so it can be translated.

Text and Translations

The text players see, including notifications, menus, the stage card, the findings card, the call card, phone messages, tutorials, the property editor's card and the settings editor's buttons, lives in locales/en.json. The names and help text of the settings themselves, the property names and the server console messages are not in the locale file. See Translations for how to add a language.

Server Rate Limits

The server has built-in protection against spammed actions (clocking in and out, accepting calls, logging signs, placing devices, filing reports and so on). Each action has a short cooldown so a player, or a cheat tool, can't fire it repeatedly. These limits are built in and need no configuration. If a player triggers one by clicking too fast, the action is ignored, sometimes with a "Please wait" message. They can simply try again a moment later.

Next Steps