Oxide Studios

Reference for all admin commands and developer utilities in oxide-animalcontroljob.

Commands Overview

Command	Description	Permission
`/animalcontrolbuilder`	Open the animal control job builder tool	`admin.animalcontroljob` (ACE)
`/animalcontroltutorials`	Toggle tutorial tooltips on/off	None
`/animalcontroltutorialreset`	Reset all tutorial progress (re-show all tooltips)	None

Animal Control Builder

The builder is a context menu for creating office locations and job events without editing config files directly. It provides real-time 3D marker previews, vehicle model testing, and Lua export.

Opening the Builder

/animalcontrolbuilder

Requires the admin.animalcontroljob ACE permission.

Option	Description
New Office	Creates a new office location at your current position
Set Vehicle Spawn	Captures current position as the vehicle spawn point
Finish Location	Validates and saves the current location
Add Aggressive Animal Event	Captures an aggressive animal event at your position
Add Stray Capture Event	Captures a stray capture event at your position
Add Wildlife Removal Event	Captures a wildlife removal event at your position
Add Deceased Pickup Event	Captures a deceased pickup event at your position
Set Shelter Delivery Point	Captures current position as the shelter delivery point
View Status	Shows current builder state and event counts
Undo Last Action	Reverses the most recent action (up to 20)
Import Current Config	Imports existing config into the builder for editing
Edit Event	Opens submenu to delete or reposition events
Export All	Serializes all data to Lua files
Test Vehicle	Spawns a preview vehicle at your position

Workflow

Run /animalcontrolbuilder to open the menu
Click New Office and enter a name — captures your position as office coords
Move to the vehicle spawn point and click Set Vehicle Spawn
Click Finish Location when complete
Move to each event position and use the appropriate Add Event button
Set the shelter delivery point
Use View Status to check progress
Click Export All to save to exported_locations.lua and exported_events.lua

3D Markers

Color	Meaning
Green cylinder	Saved event position
Blue cylinder	Finished location
Cyan cylinder	Active (unsaved) location
Orange cylinder	Shelter delivery point

Event markers display their type and animal model as 3D text within 30m.

Export Format

The export generates two files:

exported_locations.lua:

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

Config.Locations = {
    {
        name = 'location.animal_control_office',
        coords = vector3(-1162.75, -321.83, 37.61),
        heading = 172.06,
        vehicleSpawn = vec4(-1181.48, -340.36, 37.29, 339.7),
    },
}

exported_events.lua:

Config.Events = {
    {
        type = JobType.AGGRESSIVE_ANIMAL,
        label = 'event.new_event',
        animalModel = 'a_c_rottweiler',
        coords = vec4(-1087.74, -266.90, 36.70, -22.3),
        reportingNpc = true,
        requiresDelivery = true,
    },
    {
        type = JobType.WILDLIFE_REMOVAL,
        label = 'event.new_event',
        animalModel = 'a_c_coyote',
        coords = vec4(51.74, -1071.37, 28.40, 143.6),
        reportingNpc = false,
        requiresDelivery = true,
        animalWaypoints = {
            vector3(66.93, -1047.70, 28.43),
            vector3(101.55, -1054.40, 28.33),
        },
    },
}

Copy these into shared/config/locations.lua and shared/config/events.lua respectively.

Tutorial Commands

/animalcontroltutorials

Toggles tutorial tooltips on or off for the local player. When disabled, no new tooltips appear.

/animalcontroltutorialreset

Resets all tutorial progress, clearing the "seen" state for every tooltip. All tutorials will appear again.

Both commands require no permissions and affect only the local player's client-side KVP storage.

Permissions

ACE Permission Setup

Add the following to your server.cfg:

add_ace group.admin admin.animalcontroljob allow

Or for specific players:

add_principal identifier.license:xxxx group.admin

Progression Management

Player progression is stored in the animalcontroljob_progression database table.

Reset a Player's Progression

UPDATE animalcontroljob_progression
SET level = 1, total_jobs = 0, daily_streak = 0, complaints = 0, timeout_until = NULL
WHERE char_id = ?;

Remove a Suspension

UPDATE animalcontroljob_progression SET timeout_until = NULL WHERE char_id = ?;

Clear Complaints

UPDATE animalcontroljob_progression SET complaints = 0 WHERE char_id = ?;

View a Player's Stats

SELECT * FROM animalcontroljob_progression WHERE char_id = ?;

Set a Player's Level

UPDATE animalcontroljob_progression SET level = 3 WHERE char_id = ?;

Next Steps

Features — Understand all features and mechanics
Configuration — Customize all settings
Installation — Set up the resource
Troubleshooting — Common issues and solutions

Admin Guide