> For the complete documentation index, see [llms.txt](https://kierandev.gitbook.io/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kierandev.gitbook.io/documentation/tmc-resources/porch-piracy/config-options.md).

# Config Options

## Debug

```lua
-- Prints debugs into console & adds map blips
Config.Debug = true
```

## Props

```lua
-- Randomly chooses from this table of props
Config.Props = {
    `prop_cs_cardbox_01`,
    `prop_cs_box_clothes`,
    `prop_box_ammo01a`,
    `ng_proc_box_01a`,
    `prop_cs_package_01`,
    `prop_cardbordbox_03a`,
}
```

## Progressbar

```lua
Config.ProgressBar = {
    Duration    = 3000,
    Animation   = {
        dict = "random@domestic",
        anim = "pickup_low",
    },
    Settings = {
        canCancel        = true,
        disableMovement  = true,
        disableCarMovement = true,
        disableMouse     = false,
        disableCombat    = true,
        ragdollCancel    = false,
    },
}

```

## Prompt

```lua
Config.Prompt = {
    Title       = "Steal Parcel",
    Description = "Take the parcel from the porch",
    Icon        = "fa-solid fa-box",
    AutoComplete = true,
}
```

## Cooldown

```lua
Config.Cooldown = {
    -- How many seconds before a single prop re-spawns after being stolen
    PropCooldown = 15 * 60,   -- 15 minutes (seconds)
    PlayerCooldown = {
        Enabled        = true,
        AmountCanRob   = 5,          -- steals allowed before cooldown
        PlayerCooldown = 30 * 60,    -- cooldown length in seconds after limit
        CooldownNotify = true,       -- tell the player how many steals remain
    },
}
```

## Loot

```lua
Config.Loot = {
    {
        name   = "Common",
        Chance = 80,
        Items  = {
            { item = "bandage",          min = 1, max = 2 },
            { item = "painkillers",      min = 1, max = 2 },
            { item = "lighter",          min = 1, max = 1 },
            { item = "earbuds",          min = 1, max = 1 },
            { item = "file",             min = 1, max = 1 },
            { item = "sandwich",         min = 1, max = 2 },
            { item = "water_bottle",     min = 1, max = 2 },
            { item = "pen",              min = 1, max = 2 },
        },
    },
    {
        name   = "Uncommon",
        Chance = 45,
        Items  = {
            { item = "repairkit",        min = 1, max = 1 },
            { item = "bikerepairkit",    min = 1, max = 1 },
            { item = "screwdriverset",   min = 1, max = 1 },
            { item = "cleaningkit",      min = 1, max = 1 },
            { item = "wallet",           min = 1, max = 1 },
            { item = "radio",            min = 1, max = 1 },
            { item = "sunglasses",       min = 1, max = 1 },
            { item = "book",             min = 1, max = 2 },
        },
    },
    {
        name   = "Rare",
        Chance = 20,
        Items  = {
            { item = "phone",            min = 1, max = 1 },
            { item = "tablet",           min = 1, max = 1 },
            { item = "handheld_console", min = 1, max = 1 },
            { item = "headphones",       min = 1, max = 1 },
            { item = "game_console",     min = 1, max = 1 },
            { item = "multimeter",       min = 1, max = 1 },
            { item = "vpn",              min = 1, max = 1 },
            { item = "camera",           min = 1, max = 1 },
        },
    },
    {
        name   = "SuperRare",
        Chance = 8,
        Items  = {
            { item = "laptop",        min = 1, max = 1 },
            { item = "cash_roll",     min = 1, max = 2 },
            { item = "rolex",         min = 1, max = 1 },
            { item = "diamond_ring",  min = 1, max = 1 },
            { item = "cryptostick",   min = 1, max = 1 },
            { item = "luxury_purse",  min = 1, max = 1 },
            { item = "bluray_player", min = 1, max = 1 },
            { item = "gold_chain",    min = 1, max = 1 },
        },
    },
}
```

## Spawn Settings

```lua
Config.SpawnSettings = {
    -- Spawn a fixed number of parcels chosen randomly from all locations
    CertainAmount = {
        Enabled = false,
        Amount  = 10,
    },
    -- OR spawn one parcel at every location (overrides CertainAmount if both true)
    AllLocations = {
        Enabled = true,
    },
}
```

## Locations

```lua
Config.SpawnLocations = {
    -- Mirror Park
    { coords = vec3(1061.024,  -378.7052, 68.230751), groundOffset = 0.0, placeOnGround = true },
    { coords = vec3(1029.679,  -409.5428, 65.94532),  groundOffset = 0.0, placeOnGround = true },
    { coords = vec3(879.27557, -498.7658, 57.872051), groundOffset = 0.0, placeOnGround = true },
    { coords = vec3(943.79211, -463.8686, 61.395732), groundOffset = 0.0, placeOnGround = true },
    { coords = vec3(1056.4864, -448.1791, 66.257492), groundOffset = 0.0, placeOnGround = true },
    { coords = vec3(1089.8304, -484.6492, 65.658569), groundOffset = 0.0, placeOnGround = true },
    { coords = vec3(1203.1767, -557.7044, 69.400764), groundOffset = 0.0, placeOnGround = true },
    { coords = vec3(1200.366,  -576.1002, 69.139091), groundOffset = 0.0, placeOnGround = true },
    { coords = vec3(1206.7606, -620.4238, 66.438629), groundOffset = 0.0, placeOnGround = true },
    { coords = vec3(1271.299,  -682.833,  66.027656), groundOffset = 0.0, placeOnGround = true },
    { coords = vec3(1301.4558, -573.4405, 71.732254), groundOffset = 0.0, placeOnGround = true },
    { coords = vec3(1366.9986, -605.3023, 74.706993), groundOffset = 0.0, placeOnGround = true },
    -- Grove Street
    { coords = vec3(-32.57817, -1846.773, 26.19342),  groundOffset = 0.0, placeOnGround = true },
    { coords = vec3(5.0762286, -1884.075, 23.697265), groundOffset = 0.0, placeOnGround = true },
    { coords = vec3(100.83341, -1912.461, 21.407426), groundOffset = 0.0, placeOnGround = true },
    -- Vespucci Canals
    { coords = vec3(-1009.028,  -1014.717, 2.15031),   groundOffset = 0.0, placeOnGround = true },
    { coords = vec3(-1065.348,  -1053.763, 6.4116396), groundOffset = 0.0, placeOnGround = true },
    { coords = vec3(-1114.689,  -1068.91,  2.1503565), groundOffset = 0.0, placeOnGround = true },
    { coords = vec3(-1115.826,  -1195.874, 6.6835594), groundOffset = 0.0, placeOnGround = true },
    { coords = vec3(-1035.859,  -1128.694, 2.1585822), groundOffset = 0.0, placeOnGround = true },
    { coords = vec3(-885.2077,  -1071.27,  2.1617767), groundOffset = 0.0, placeOnGround = true },
}
```

## Dispatch

```lua
Config.Dispatch = {
    Enabled     = true,
    Chance      = 50,   -- % chance per theft that dispatch fires
    jobType     = "police",
    title       = "Porch Piracy in Progress",
    description = "A resident has reported a porch piracy in progress. Someone just stole their parcel!",
    urgency     = 1,
}
```

## Agro Peds

```lua
Config.AgroPeds = {
    Enabled = true,
    Chance = 100,
    Models = {
        `a_f_o_genstreet_01`,
        `a_m_m_bevhills_02`,
        `a_f_y_runner_01`,
        `a_f_y_hipster_01`,
        `a_f_y_hiker_01`,
    },
    Weapons = {
        `weapon_bat`,
        `weapon_knife`,
    },
    PedHealth = 200,
    StopChasingRange = 50,  -- If player gets this far away, the ped stops chasing
}
```

## Notifications

```lua
Config.Notifications = {
    OnCooldown = {
        message = "You are on cooldown. Try again later.",
        type    = "error",
        duration = 3000
    },
    CooldownRemaining = {
        -- %d will be replaced with the number of steals remaining
        message = "You can steal %d more parcel(s) before cooldown.",
        type    = "info",
        duration = 3000
    },
    StopChasingRange = {
        message = "I'll Get you next time",
        type    = "speech",
        duration = 3000      
    }
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://kierandev.gitbook.io/documentation/tmc-resources/porch-piracy/config-options.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
