# Installation

## SQL

You can find `assets/sql/db.sql` file in assets folder, please insert that sql into your database.

## MySQL setup

In `fxmanifest.lua` select library you want to use for MySQL. Select from either mysql-async or oxmysql.

If you want to use oxmysql

```lua
    '@oxmysql/lib/MySQL.lua',
    -- '@mysql-async/lib/MySQL.lua',
```

If you want to use mysql-async

```lua
    -- '@oxmysql/lib/MySQL.lua',
    '@mysql-async/lib/MySQL.lua',
```

## Screenshot-basic

Screenshot-basic is required for screenshots feature in report chat. [Downloadable here](https://github.com/citizenfx/screenshot-basic)

## Your Logo

You can find logo in `client/ui/logo.{hash}.png`. To set your logo replace it with the new one replace it with your logo and use same name.

Used logo size is 174x56px

## Config setup

Open the `config.lua` file.

### FrameworkResourceName

if you use ESX/QBCore as your framework and you renamed the folder with the script change the name here

```lua
Config.FrameworkResourceName = 'my_es_extended'
```

### Allowed admin groups

All groups specified here have admin permissions. It allows admins to toggle on/off duty and solve reports.

```lua
Config.AllowedGroups = {
    'superadmin', --ESX
    'admin', --ESX
    'god', --QBCore
}
```

All groups specified here have super admin permissions. This grants access to admin statistics with simple overview of their activity.

```lua
Config.SuperAdminGroups = {
    'superadmin',
    'admin',
}
```

## Discord webhooks setup

Open the `sconfig.lua` file

### DiscordPlayersReportScreenshotsWebhook (required)

This webhook is used for screenshots sent by players. It also works as storage for all screenshots and links of those screenshots are used in report chat.

```lua
SConfig.DiscordPlayersReportScreenshotsWebhook = 'WEBHOOK'
```

### DiscordReportsLogWebhook (optional)

This webhook is used for simple preview of newly created reports.

```lua
SConfig.DiscordReportsLogWebhook = 'WEBHOOK'
```


---

# 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/installation.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.