# Configuration

### Optional Add-Ons

This is the configuration details for all the configs for the optional add-on area. These will explain what they do and some extra details about them.

| Config Name          | What it does                                                                                                      | Extra Details                                                                            |
| -------------------- | ----------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| DiscordLink          | This is where you would put your discord link for when someone gets banned!                                       | N/A                                                                                      |
| NotificationSystem   | This is where you decide which notification system you would like to use.                                         | This supports chat messages, old mythic notify, new mythic notify, and tnotify.          |
| ChatNotifications    | This enables global chat notifications for kick/bans                                                              | N/A                                                                                      |
| Framework            | This allows you to utilize framework plugins. Without picking a framework non of the framework plugins will work. | This supports only esx and qbcore                                                        |
| ShowJoinCard         | This allows you to decide whether you would like to use our custom adaptive card or not.                          | N/A                                                                                      |
| ESXEventNames        | This is all the event names for esx. You only need to change these if you changed your esx event names.           | This has a list of events that the anticheat would use for detections and general works. |
| QBEventNames         | This is all the event names for qbcore. You only need to change these if you changed your qbcore event names.     | This has a list of events that the anticheat would use for detections and general works. |
| BanSystem            | This where you decide what systems of bans you want.                                                              | This supports Json, Sql, and event (sends and event for another script to ban)           |
| KickSystem           | This where you decide what systems of kicks you want.                                                             | This supports Json, Sql, and event (sends and event for another script to ban)           |
| SqlType              | This where you decide what sql system you are using                                                               | This supports mysql, and oxmysql                                                         |
| UsingScreenshotBasic | This is where you setup if you want images on bans in discord. You must have screenshot basic for this            | This supports if you changed the name of the resource as well                            |

### Discord Bot

This is where all the configurations for the discord bot configs are. These will explain all the important parts of the discord bot configs and what they do. You must go to installation to get most of these configs correct.

| Config Name          | What it does                                                                             | Extra Details                                                  |
| -------------------- | ---------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
| BotToken             | This is where you put discord bot token                                                  | You must follow installation instructions on how to get this   |
| GuildID              | This is a webhook from the channel you want commands in                                  | You must create a webhook for the channel you want commands in |
| ChannelID            | This is the channel ID from the channel you want commands in                             | This must be the same channel that the webhook is in           |
| WaitEveryTick        | This is the wait for how long it sends a message                                         | Advise not to go lower                                         |
| WaitForRateLimit     | This is the wait for the rate limiter on discord                                         | Advise not to go lower                                         |
| Prefix               | This is the bot prefix you would like                                                    | Please keep it to one letter                                   |
| AdminDiscordIDS      | This is where you put all the ids of the people you want to allow to use the discord bot | Just get their id and paste it inside of the table             |
| RemoveCommand        | This is if you want it to remove the command message sent!                               | N/A                                                            |
| SendBanDm            | This is if you want it to send ban messages in discord dms as well!                      | N/A                                                            |
| BanOnDiscordIfBanned | This is if you want the script to ban the user on discord as well when banned in game!   | N/A                                                            |

### Kick To Ban Configs

This is all the configuration details for the kicks turning into bans. They will explain what they do and some extra details about them

| Config Name           | What it does                                                                                                      | Extra Details                                               |
| --------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
| MaxKicksBeforeBan     | This is the amount of kicks it takes to auto ban someone. If you set to 0 it will not ban someone for kick amount | We suggest you leave this on as it can help prevent modders |
| MaxKicksBeforeBanTime | This is the length of the ban for getting banned for amount of kicks                                              | We supports 1 day, 3 days, 1 week, and permanent            |

### Kick / Ban/ None Messages

This is the configuration details for all the kick, ban, and no punishment messages! They will explain what each category is for

| Config Name          | What it does                                                   | Extra Details |
| -------------------- | -------------------------------------------------------------- | ------------- |
| CustomBanHelpMessage | This is what is displayed on ban message                       | N/A           |
| BanMessages          | The message for server name that is shown on ban message       | N/A           |
| KickMessages         | The message for server name that is shown on kick message      | N/A           |
| Messages             | These are all the different ban/kick reason messages           | N/A           |
| NotifMessages        | These are all the different  reason messages for no punishment | N/A           |

### Other Messages

This is the configuration details for all the other type of messages

| Config Name     | What it does                                                                    | Extra Details |
| --------------- | ------------------------------------------------------------------------------- | ------------- |
| Emojis          | These are the emojis used in the script                                         | N/A           |
| OtherTexts      | These are the other messages used in console messages and some discord messages | N/A           |
| CommandMessages | These are the messages used in all the commands                                 | N/A           |

###


---

# 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://outlaw-development.gitbook.io/outlaw-product-documentation/product-information/anti-cheat/configuration.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.
