> ## Documentation Index
> Fetch the complete documentation index at: https://docs.projectx.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Step by step instructions to install the Tasks resource

## Installation Steps

<Steps>
  <Step title="Extract and place the resource">
    Extract the script from the zip file and place it into your standalone folder or a folder that starts before your scripts.
  </Step>

  <Step title="Configure the resource">
    Open `config.lua` and adjust the settings to your liking. See the configuration section below for details.
  </Step>

  <Step title="Add to server.cfg">
    Add the following to your `server.cfg`:

    ```cfg theme={null}
    ensure projectx-tasks
    ```
  </Step>
</Steps>

## Configuration

Below is the full configuration file with explanations for each option.

```lua theme={null}
Config = Config or {}

Config = {
    ToggleCommand = {
        Enabled = true,
        Command = "toggletasks",
        Keybind = 'J',
        KeybindDescription = 'Toggle Task List'
    }
}
```

### Toggle Command Settings

<ParamField path="ToggleCommand.Enabled" type="boolean" default="true">
  Enable or disable the command and keybind to toggle the task list visibility. Set to `false` to completely disable the toggle feature.
</ParamField>

<ParamField path="ToggleCommand.Command" type="string" default="toggletasks">
  The command players can use to toggle the task list on/off (e.g., `/toggletasks` in chat)
</ParamField>

<ParamField path="ToggleCommand.Keybind" type="string" default="J">
  The keybind to toggle the task list. Set to `''` (empty string) or comment out to disable keybind functionality while keeping the command active.
</ParamField>

<ParamField path="ToggleCommand.KeybindDescription" type="string" default="Toggle Task List">
  Description text shown in the FiveM keybinds menu to help players identify what the keybind does
</ParamField>