> For the complete documentation index, see [llms.txt](https://acestudios.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://acestudios.gitbook.io/docs/inventory-and-items/compensation-stashes/configuration.md).

# Configuration

Configure ace\_compstashes through Config.lua.

All settings are in `ace_compstashes/Config.lua`.

## Settings

| Option                  | Type    | Default                | Description                                                                        |
| ----------------------- | ------- | ---------------------- | ---------------------------------------------------------------------------------- |
| `FrameWork`             | string  | `"QB"`                 | Framework. QBCore is the only supported framework.                                 |
| `InventoryExport`       | export  | `exports.ox_inventory` | Your inventory export.                                                             |
| `SaveStashesToJsonFile` | boolean | `true`                 | Saves created stashes to `.json` files so they survive restarts and interruptions. |
| `RemindPlayersOnJoin`   | boolean | `true`                 | Tells players who join that a compensation stash is waiting for them.              |
| `adminmenu`             | string  | `'stashmenu'`          | Command that opens the stash management menu.                                      |
| `OpenCompCmd`           | string  | `'opencomp'`           | Command that opens compensation stashes.                                           |
| `CreateCompCmd`         | string  | `'createcomp'`         | Command that creates compensation stashes.                                         |
| `ClearStashCmd`         | string  | `'emptystash'`         | Command that clears stashes.                                                       |
| `OpenStashCmd`          | string  | `'openstash'`          | Command that opens a stash by name (global).                                       |
| `ClaimStashCmd`         | string  | `"claimcomp"`          | Command players use to claim their compensation stash.                             |
| `Config.DebugMode`      | boolean | `false`                | Enables debug output.                                                              |

## Stash settings

```lua
StashSettings = {
    MaxWeight = 10000,
    slots = 25,
    label = 'Compensation Stash - ',
},
```

| Option      | Default                   | Description                                                             |
| ----------- | ------------------------- | ----------------------------------------------------------------------- |
| `MaxWeight` | `10000`                   | Maximum weight of each compensation stash (ox\_inventory weight units). |
| `slots`     | `25`                      | Slots in each compensation stash.                                       |
| `label`     | `'Compensation Stash - '` | Prefix for the stash label.                                             |

## Admin licenses

```lua
AdminLicense = {
    ["license:youradminlicensehere"] = true,
},
```

Use this list if you **don't** manage permissions with the `AceStashManage` ACE. Replace the placeholder with real `license:` identifiers.

## Discord logs

```lua
DiscordLogs = {
    logActions = true,

    openAdminMenu = "",
    createCompStash = "",
    OpenGlobalStash = "",
    ClearStash = "",
    ClaimStash = "",
},
```

| Webhook           | Triggered when                           |
| ----------------- | ---------------------------------------- |
| `openAdminMenu`   | The stash menu is opened                 |
| `createCompStash` | A compensation stash is created          |
| `OpenGlobalStash` | A global stash is opened by name         |
| `ClearStash`      | A stash is cleared or deleted            |
| `ClaimStash`      | A player claims their compensation stash |

Set `logActions = false` to turn off logging. You can use the same webhook URL for several actions.