# Config

```lua
Config = {}

Config.Framework = 'esx' -- 'esx' | 'qb' | 'standalone'
Config.NotificationType = 'esx' -- 'ox' | 'esx' | 'qb' | 'mythic'
Config.Locale = 'en' -- 'en' | 'fi'
Config.DebugMode = false -- false | true

Config.Inventory = 'default' -- 'default' | 'ox'
Config.Target = 'none' -- 'none' | 'ox' | 'qb'
Config.UseOxLib = false -- false | true, remember to add " shared_script '@ox_lib/init.lua' " to fxmanifest.lua if set to true

Config.UseKVPs = Config.Framework == 'standalone' -- should the script use KVPs instead of sql for saving ziplines

Config.Controls = {
    interact = 38, -- E
    remove = 246, -- Y
}

Config.Anims = {
    place = {
        dict = 'weapons@first_person@aim_rng@generic@projectile@sticky_bomb@',
        name = 'plant_floor',
        duration = 1000,
    },
    remove = {
        dict = 'weapons@first_person@aim_rng@generic@projectile@sticky_bomb@',
        name = 'plant_floor',
        duration = 1000,
    }
}

Config.Ziplines = {
    {
        poleModel = `prop_fncsec_02pole`,
        startPos = vector3(930.4150, -1940.3555, 39.1228),
        endPos = vector3(953.3053, -1993.0087, 37.1447),
    },
    {
        poleModel = `prop_fncsec_02pole`,
        startPos = vector3(952.3739, -1995.2802, 37.1468),
        endPos = vector3(932.0899, -2000.2003, 29.2453),
        maxUpwardsAngle = 5.0 -- you can override the max upwards angle for each zipline
    },
    {
        poleModel = `prop_fncsec_02pole`,
        startPos = vector3(874.84, -2113.77, 44.1),
        endPos = vector3(568.82, -2099.38, 49.76),
    },
}

Config.ZiplineItems = {
    zipline = { -- you can copy and paste this down below to add more items with different settings
        item = 'zipline',
        dist = {
            min = 2.0,
            max = 50.0,
        },
        poleModel = `prop_fncsec_02pole`,
        offset = vector3(0.0, 0.0, 0.0),
        removeItem = true,
        durationMultiplier = 1.0,
        angleEffectMultiplier = 1.0,
        maxUpwardsAngle = 45.0,
        persistent = false,
        canRemove = true, -- can the zipline be removed by players
    },
}

Config.ZiplineGun = {
    weaponHash = `WEAPON_GADGETPISTOL`,
    dist = {
        min = 2.0,
        max = 50.0,
    },
    ammoItem = 'zipline_ammo',
    removeItem = true, -- should the ammo item be removed when new zipline is placed
    poleModel = `prop_fncsec_02pole`,
    durationMultiplier = 1.0,
    angleEffectMultiplier = 1.0,
    maxUpwardsAngle = 45.0,
    persistent = false, -- should the ziplines spanwed by the gun be persistent (spawn after restart)
    canRemove = true, -- can the zipline be removed by players
}

Config.GrappleGun = {
    weaponHash = `WEAPON_MARKSMANPISTOL`,
    dist = {
        min = 2.0,
        max = 100.0,
    },
    ammoItem = 'grapple_gun_ammo',
    removeItem = true,
    durationMultiplier = 1.0,
    angleEffectMultiplier = 1.0,
    cooldown = 1000 * 5, -- 5 seconds
    maxUpwardsAngle = 20.0,
}

Config.BaseDurationMultiplier = 1.0 -- multiplier for the duration of the zipline ride
Config.BaseAngleEffectMultiplier = 1.0 -- how much should the angle affect the speed of traveling
Config.BaseMaxUpwardsAngle = 45.0 -- the maximum upwards angle for the zipline

Config.DisabledAreas = {
    --{coords = vector3(-2085.46, -299.77, 12.04), radius = 10.0},
}
```


---

# Agent Instructions: 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://tk-scripts.gitbook.io/docs/tk_zipline/config.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.