> For the complete documentation index, see [llms.txt](https://vanishdev.gitbook.io/vanishdev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://vanishdev.gitbook.io/vanishdev/everyday-scripts/escort/configuration.md).

# Configuration

```lua
return {
    -- Feature Toggles
    useTarget = true,                   -- Enable ox_target support
    useKeybind = true,                  -- Enable keybind usage for escorting
    usageKeybind = 'E',                 -- Default keybind to start escorting (keyboard key)
    useCommand = true,                  -- Enable command usage (e.g., /escort)

    -- Permissions
    restrictedJobs = false,            -- Restrict usage to specific jobs (e.g., { 'police', 'ambulance' })
    restrictedCommandGroups = { 
        'group.admin', 
        'group.user' 
    },                                 -- Restrict command to specific ACE groups or identifiers as supported; set to false to disable

    -- Escort Settings
    releaseKeybind = 38,               -- Key to release escorted player (default: E)
    escortDistance = 3.0,              -- Max distance to initiate escort (recommend keeping low)
    escortDeadPlayers = true,          -- Allow escorting dead players
    forceUnarmed = true,               -- Strip escorting player of weapons during escort
    disableControls = true,            -- Disable controls while escorting or being escorted

    -- Disabled controls
    disabledControls = {
        escorting = {
            22, 24, 25, 37, 44, 45, 68, 69, 91, 92, 140, 141, 142, 143, 257, 263, 264
        },
        escorted = {
            22, 23, 24, 25, 37, 44, 45, 68, 69, 75,
            140, 141, 142, 143, 167, 170, 288, 289
        }
    },  

    -- Animations
    anims = {
        escorting = {
            onFoot = {dict = 'amb@code_human_wander_drinking_fat@beer@male@base', anim = 'static'}
        },
        escorted = {
            walk = {dict = 'move_m@brave@a', anim = 'walk'},
            run = {dict = 'move_m@quick', anim = 'walk'},
        }
    }
}
```


---

# 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, and the optional `goal` query parameter:

```
GET https://vanishdev.gitbook.io/vanishdev/everyday-scripts/escort/configuration.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.