> For the complete documentation index, see [llms.txt](https://izaap-studios.gitbook.io/izaap-scripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://izaap-studios.gitbook.io/izaap-scripts/reports/config-files.md).

# Config Files

{% tabs %}
{% tab title="config.lua" %}

```lua
Config = {}

Config.Debug = false

-- Framework: 'auto', 'qb', 'qbx', 'esx', 'standalone'
Config.Framework = 'auto'

-- Available languages: 'es' or 'en'
Config.Lang = 'en'

-- Main command to open the reports panel.
Config.Command = 'reports'

-- Keybind to open the reports panel.
-- Set to false to disable keymapping.
Config.OpenKey = 'F7'

-- Notification system:
-- 'default' = automatic framework notification.
-- 'ox' = ox_lib notification.
-- false = disabled.
Config.NotifyType = 'default'

-- Admin groups allowed to manage reports.
Config.AdminGroups = {
    'god',
    'admin',
    'superadmin'
}

-- ACE permission for admin access.
Config.AcePermission = 'izaap_reports.admin'

-- Maximum characters allowed.
Config.MaxDescription = 500
Config.MaxMessage = 500

-- Allow players to close their own reports.
Config.AllowPlayerCloseOwnReport = true

-- Staff:
-- true = staff must claim the report before sending messages.
Config.RequireClaimToStaffChat = true

-- Discord Avatar:
-- Put your Discord bot token here.
-- The bot does not need to be inside your FiveM server Discord.
-- It only needs access to the Discord API.
Config.DiscordAvatar = {
    enabled = true,

    -- IMPORTANT:
    -- Do not share this token publicly.
    -- If you already exposed it, regenerate it in the Discord Developer Portal.
    botToken = 'YOUR_DISCORD_BOT_TOKEN',

    size = 128,
    cacheMinutes = 30,

    -- Fallback avatar if the player has no Discord avatar or token is empty.
    defaultAvatar = ''
}

-- Report categories.
Config.Categories = {
    bug = {
        label = 'Bug / Error',
        icon = 'fa-bug',
        iconColor = '#f8c82c'
    },

    player = {
        label = 'Report Player',
        icon = 'fa-user-slash',
        iconColor = '#ff8f3d'
    },

    hacker = {
        label = 'Possible Cheater',
        icon = 'fa-shield-halved',
        iconColor = '#ff4d6d'
    },

    question = {
        label = 'Question / Help',
        icon = 'fa-circle-question',
        iconColor = '#4da3ff'
    },

    other = {
        label = 'Other Reason',
        icon = 'fa-ellipsis',
        iconColor = '#b8b8b8'
    }
}

-- Staff custom notification.
Config.StaffNotify = {
    enabled = true,

    -- Staff will be on duty by default.
    defaultDuty = true,

    -- Key to open the latest notified report.
    openKey = 'G',

    -- Notification duration in milliseconds.
    duration = 8500,

    -- Sound file inside your html folder.
    -- Example: html/sound.mp3
    sound = 'sound.mp3',
    volume = 0.65,

    title = 'New Report',
    subtitle = 'Press the key to open the chat'
}

-- Screenshot system.
-- Requires screenshot-basic started before this resource.
Config.Screenshot = {
    enabled = true,

    -- Resource used to take screenshots.
    resource = 'screenshot-basic',

    -- Discord webhook where screenshots will be uploaded.
    -- IMPORTANT:
    -- Use a private webhook and do not share it publicly.
    webhook = 'https://discord.com/api/webhooks/1500586325806547006/xv5NPt8LVDArOW7_byT-G6rj4I90lAuOvcASyOWyrExp2eXeU-rKE-qIXpKMvt6kBgY-',

    -- Screenshot quality.
    -- Recommended: 0.80 - 0.92
    quality = 0.88,

    -- 'jpg' is lighter.
    -- You can also use 'png'.
    encoding = 'jpg',

    -- Cooldown between screenshots per client.
    cooldown = 8000
}

```

{% endtab %}
{% endtabs %}