Configuration Reference

Reference for the current oxide-animalcontroljob config layout.

Config File Map

General Settings

File: shared/config.lua

Enums

ShiftState

• idle
• waiting
• on_call
• working

JobType

• aggressive_animal
• stray_capture
• wildlife_removal
• deceased_pickup

Job Settings

File: shared/config/job.lua

Crew

Payment

Base pay by job type

Config.Payment.basePay = {
    [JobType.AGGRESSIVE_ANIMAL] = 85,
    [JobType.STRAY_CAPTURE]     = 70,
    [JobType.WILDLIFE_REMOVAL]  = 110,
    [JobType.DECEASED_PICKUP]   = 55,
}

Complaints

Timer

Current timer formula:

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

Calls

The cancel cooldown is a floor, not an extra delay on top: after a cancel, the next call arrives once both the normal 15–45 second gap and the cooldown have passed. Raise it if you want cancelling a call to cost the player some time; set it to 0 if you'd rather they get back to work immediately. See Cancelling a Call in the feature guide for what cancelling does.

Levels

File: shared/config/levels.lua

Each level entry defines:

• title
• requiredJobs
• payMultiplier
• tipChance
• tipRange

Default progression is 5 levels from Volunteer through Chief Officer.

Locations

File: shared/config/locations.lua

Shelter delivery point

Config.ShelterDeliveryPoint = vector3(-1139.70, -319.82, 37.67)

This is used for all live animal transport jobs that require shelter delivery.

Office fields

Config.Locations is the list of animal control offices. The resource ships with 1, but each entry is a complete, independent office — its own dispatcher NPC, map blip, truck spawn, and worker slots.

Each entry contains:

Adding a second office

Every office in the list is treated the same way, so adding one is a copy-paste job:

The new office appears on its own, automatically: its dispatcher NPC spawns, its map blip is drawn, and it gets its own set of worker slots (Config.MaxSlotsPerLocation, 3 by default — so two offices means six workers total, three at each).

A shift belongs to the office the player clocked in at: that's where their truck spawns and which office's slot they take up.

Calls are shared, not per office. Config.Events (see below) is one global list of animal reports, and dispatch picks from all of it no matter which office a player clocked in at. A second office does not need its own event list and there is no way to tie an event to a specific office. What you may want instead is a few extra entries in Config.Events near the new office, so its workers aren't always driving across the map — pay and the job timer both scale with distance, so far-away calls aren't unfair, just slow.

Drop-offs are shared too: Config.ShelterDeliveryPoint is a single shelter for the whole job, so workers from every office deliver captured animals to the same place.

Events

File: shared/config/events.lua

Each event defines a dispatchable animal report.

The default package contains 55 events. Dispatch groups events by shared scene coordinates to reduce repeated locations back-to-back.

Event count by type

Vehicle

File: shared/config/vehicles.lua

Animals

File: shared/config/animals.lua

Animal models

Config.Animals maps model names to display name and health values. The default package includes 14 animal models (dogs, cats, coyote, mountain lion, panther, deer).

Tranquilizer

Stealth detection

Animal behavior

Per-job behavior settings live in Config.AnimalBehavior. Each job type defines:

• task type
• detection and escape radii
• spook and flee distances
• wander behavior
• NPC reaction radii

Animal loading

Props

File: shared/config/props.lua

This file controls:

• bait prop model and placement range
• bait scent particle effect
• bait player attachment offsets
• deceased bag model and durations
• deceased bag carry animation
• capture, bait placement, load, and unload progress bar animations

Primary props:

• bait (dog bowl)
• deceasedBag (bin bag)

Visuals

File: shared/config/visuals.lua

NPC and blips

• Config.NpcModel
• Config.NpcScenario
• Config.Blip
• Config.EventBlip
• Config.DeliveryBlip

Reporting NPC models

Config.ReportingNpcModels contains 16 possible civilian models for the person who reported the animal incident.

Reporting NPC behavior

Config.ReportingNPC controls:

• stand offset from animal
• animation cycle (beckoning, frightened, hand gestures)
• thank-you animation
• far-away scenario
• animation distance threshold

Safety zones

Config.SafetyZone controls:

• whether safety zones run (enabled)
• the slow-traffic rings around active job scenes (speedZones — each entry sets a radius and a speed)

Waypoints

Config.Waypoints controls marker height, scaling, and render timing.

Outfits

File: shared/config/outfits.lua

Optional on-duty uniform applied through o-link.clothing when the player clocks in and reverted on clock-out / death / disconnect.

The default values are placeholders (drawable = 0, texture = 0) — replace them with valid IDs from your clothing pack before enabling. The previous appearance is snapshotted on apply and restored on revert via o-link.clothing.SetAppearance / o-link.clothing.Revert.

Tutorials

File: shared/config/tutorials.lua

Config.Tutorials contains 16 first-time guidance prompts. Each entry defines:

• icon
• title
• body
• position
• duration

Server Rate Limits

The server has built-in protection against spammed actions (clocking in/out, accepting calls, capturing animals, and so on). Each action has a short cooldown so a player — or a cheat tool — can't fire it repeatedly. These limits are hard-coded in server/main.lua and don't need any configuration. If a player triggers one by clicking too fast, they simply get a "slow down" message.

Next Steps