RX Reports V1 Configuration

RX Reports V1 keeps its behaviour in config.lua and its admin access rules in permission.lua. The defaults are tuned for a normal production server; change only the sections that need to match yours.

Restart ripex-reportsystem after changing the configuration so the server and every connected client receive the same values.

Framework and locale

These settings decide which framework integration is loaded and which language the interface uses.

Config.Framework = 'qb' -- 'qb' or 'esx'
Config.Locale = 'en'

The selected framework must already be started before RX Reports. Do not use a framework value outside of qb or esx. The resource ships with English as the supported runtime locale.

Report form

Categories and priorities control the choices a player sees while filling in a report.

Config.Categories = {
    { label = 'Cheating/Hacking', value = 'cheating' },
    { label = 'Harassment', value = 'harassment' },
    { label = 'Bug Abuse', value = 'bug' },
    { label = 'Other', value = 'other' }
}

Config.Priorities = {
    { label = 'Low', value = 'low' },
    { label = 'Medium', value = 'medium' },
    { label = 'High', value = 'high' }
}

The value keys are stored and used internally, so change the labels freely but keep the values stable once the system is live. For example, you can rename Cheating/Hacking to Rule breach while preserving the cheating value. This prevents old reports and UI filters from becoming inconsistent.

Commands

Two commands are configurable. The remaining player commands are provided by the resource and cannot be renamed.

Config.Commands = {
    OpenReport = 'report',
    OpenAdmin = 'reports'
}

Pick command names that do not already exist on your server. A duplicate command silently overrides the other resource and makes the conflict hard to trace.

Staff notifications

Each notification can be switched off independently without disabling the rest of the workflow.

Config.Notifications = {
    newReport = true,
    reportClaimed = true,
    reportClosed = true
}

Turn off a notification only if your staff already receives the same status from another reliable channel; otherwise report ownership can become unclear during busy periods.

Admin permission model

Admin access is resolved differently for each framework, so configure the list that matches yours.

Config.AdminGroups = {
    'god',
    'admin',
    'mod',
    'administrator',
    'superadmin'
}

Config.AdminLicenses = {
    'license:replace-with-your-admin-license'
}

Config.PreventAdminBlock = true prevents staff from blocking themselves or other staff. Keep this enabled on normal production servers.

Config.Permissions.Admin and Config.Permissions.Mod are labels used by the resource’s permission layer. Keep them aligned with your staff naming, but do not treat them as a replacement for the framework-specific checks above.

Screenshot evidence

Screenshots are captured on the player’s side and uploaded before the report is stored.

Config.Screenshots = {
    MaxPerReport = 3,
    MaxFileSize = 2,
    Quality = 0.8,
    Format = 'jpg'
}

The resource uploads captures through screenshot-basic to the screenshot_webhook convar from server.cfg. JPG at 0.7 to 0.8 is the practical default; PNG files are larger and should only be used when image clarity matters more than upload size.

Notification integration

type selects which notification resource receives the messages RX Reports sends.

Config.NotificationSystem = {
    type = 'default', -- default, custom, okok, mythic, codem, qs
    customEvent = 'custom:notification',
    format = {
        title = 'title',
        message = 'message',
        type = 'type'
    }
}

Choose custom only when the named event already exists on your server. For every other non-default option, make sure that notification resource starts before RX Reports.

Report limits and feedback

These sections protect staff from spam and collect a rating once a report is resolved.

Report limits

Config.ReportLimits = {
    Enabled = true,
    MaxReportsPerDay = 5,
    MaxReportsPerHour = 2,
    ExemptAdmins = true
}

Use a daily limit that fits your player count. Low hourly limits can block legitimate players during a large incident, so 2 per hour and 5 per day are sensible starting values.

Feedback

Config.Feedback = {
    enabled = true,
    timeout = 300,
    minRating = 1,
    maxRating = 5
}

Feedback becomes available only after a report is closed. Keep the timeout long enough that a player who was mid-roleplay can still reach /feedback before it expires.

Data retention and admin notes

Cleanup and note retention decide how long report data stays in the database.

Database cleanup

Config.DatabaseCleanup = {
    AutomaticCleanup = true,
    CleanupInterval = 24,
    DefaultDays = 30,
    Commands = {
        Reports = 'cleanreports',
        History = 'cleanhistory'
    }
}

Cleanup commands permanently remove data, so test them on a development database first.

Admin notes

Config.AdminNotes = {
    Enabled = true,
    MaxLength = 500,
    DeleteAfterDays = 30
}

Start with 30 days and adjust only after considering your moderation, privacy, and storage policy.

Debug mode

Debug output is disabled by default and is only useful while diagnosing a specific problem.

Config.Debug = false

Enable it temporarily while diagnosing a missing permission, webhook, notification, or framework event, then turn it off again to keep console output useful.