# Config

**You can change individual values in config.lua**

## Debug

If you see anything wrong and you would like to know more, for example to show in support ticket, you can set `Config.Debug = true` to see more debug info in client (F8) console ingame, or server console.

## ESXFolderName & QBCoreFolderName

if you use ESX/QBCore as your framework and you renamed the folder with the script change the name here if you have naming `es_extended` / `qb-core` you could leave this set to `nil`

## InventoryScripts

This specify inventories compatible with report system. Report system provides integrations for all specified inventories.

```lua
Config.InventoryScripts = {
    ESX_INVENTORY = 'es_extended',
    MF_INVENTORY = 'mf-inventory',
    OX_INVENTORY = 'ox_inventory',
    QB_INVENTORY = 'qb-inventory',
    QS_INVENTORY = 'qs-inventory',
    CHEEZA_INVENTORY = 'inventory',
}
```

## OwnInventorySolution

if you want to skip automatical data gathering from inventories listed in InventoryScripts you could add your own solution in `server/api/inventory.lua` when set to `true`

## SaveReportsToDatabaseInterval

All reports are stored into database in specific interval. You could set the interval here.

You could use this variables

```lua
SECONDS
MINUTE
HOUR
```

## SaveAdminChatToDatabaseInterval

All messages from admin chat are stored into database in specific interval. You could set the interval here.

You could use this variables

```lua
SECONDS
MINUTE
HOUR
```

## AutoDeleteReportAfterDays & AutoDeleteAdminChatMessageAfterDays

If you set this options to number of days with script start all reports/admin chat messages older than that will be automatically deleted from database. This is disabled by default.

!WARNING: always have higher values then HistoryAndStatisticsThrshold and AdminMessagesThreshold

## DefaultReportSystemHideHotkey

Defines hotkey used for partially hiding report system. Use single keyboard keycaps or nil to ignore it.

```lua
Config.DefaultReportSystemHideHotkey = 'k'
Config.DefaultReportSystemHideHotkey = nil
```

## LicenseType

Defines which identifier should be used in report system. You could also choose if you want to use prefix or not.

## SaveServerConsoleWithReport

[Console Logs](https://documentation.rcore.cz/paid-resources/rcore_report/console-logs)

## OpenReportSystemCommand

Command for all players to open report system

## SaveAllReportsCommand

Command accessible by all admins to immediatelly save all reports

## SaveAdminChatCommand

Command accessible by all admins to immediatelly save all messages in admin chat

## UseBasicNotifications

If allowed notifications from ESX/QBCore are used, otherwise server event is triggered

```lua
NotificationType = {
    SUCCESS = 'success',
    WARNING = 'warning',
    ERROR = 'error',
    INFO = 'info',
}

TriggerEvent(triggerName('sendNotification'), playerId, message, type)
```

## PlaySoundWhenNewNotificationArrives

If set to `true` sound from `client/api/notifications.lua` will be played

## HistoryAndStatisticsThreshold

Reports in threshold (not older than specified threshold in DAYS) are listed in reports history and used for statistics.

## AdminMessagesThreshold

Admin Messages in threshold (not older than specified threshold in HOURS) are loaded from database when script is started

## AllowGlobalNotificationAboutOnlineAdmins

When there are no admins left/first admin is online global notifications to all player should be send if set to true

## SendNotificationToJoinedPlayerAboutPendingReports

When set to `true` player will receive notification about pending reports when he joins the server

## SendDiscordLogForReportCreateAfterFirstMessage

if set to `true` discord log about created report will be sent after first message appears in chat

## DisablePlayersInArea

if set to `true` data about playersInArea will not be gathered at all

## MaxPlayerDistanceToGatherPlayerData

Defines in which maximal distance players data should be gathered for report

## WaitBeforeEachDataGatherForPlayersInArea

Defines timeout between each data gather for players in area

## SetAdminDutyOnAfterJoining

if set to `true` admin will be automatically on duty after joining

## SendNotificationsToOffDutyAdmins

if set to `true` all off duty admins will also receive notifications for admins

## SendScreenshotWhenNewReportCreated

if set to `true` screenshot will be automatically sent to report after creation

## QuickReportsCustomWebhooks

It's possible to set custom webhooks for each quick report. They are matched by `reportTitle` which you can find in `client/ui/config.js`.

```lua
SConfig.QuickReportsCustomWebhooks = {
    ['Found a bug'] = 'WEBHOOK',
    ['Rules breaker'] = 'WEBHOOK',
}
```

You don't need to set custom webhooks for all quick reports. Quick reports without custom webhook uses `SConfig.DiscordReportsLogWebhook` instead.


---

# 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://documentation.rcore.cz/paid-resources/rcore_report/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.
