⚙️Script Configuration

Adjustments guide for mg-reports

Welcome to the configuration guide for MG Reports, a powerful and fully customizable reporting system for your FiveM server. Below is a detailed explanation of each configuration option to help you adjust the script to your specific needs.

---

Framework Configuration

Defines which framework the script will use.

---

Database Configuration

SQL system

---

Database Options

• cleanSQL: Defines how old reports should be cleaned. Options:

  • "onRestart": Deletes all reports/messages when the script starts.

  • "week": Deletes reports older than 7 days.

• deleteClosed: Deletes all closed reports on script start (true/false).

• deleteReportOnClose: Deletes a report from the database when it’s closed or canceled.

• deleteMessagesFromClosedReport: Deletes messages from closed or canceled reports.

• clearBlacklist: Removes expired blacklists on startup.

---

Permissions System

ESX / QBcore

Groups with access to the admin panel. Only used with ESX/QBCore.

Standalone

• Set UseAcePermission = true for standalone mode or if you want to use ACE permissions.

• Define the ACE permission name in AcePermission.

Example:

add_ace group.admin "mg-reports" allow

---

Command Configuration

Defines commands available for players and staff:

• OpenReportMenu: Open the player report interface.

• OpenAdminMenu: Open the admin panel.

• reportBlacklist: Blacklist a player from submitting reports.

• removeBlacklist: Remove a player's blacklist.

• StopSpectating: Stop spectating a player.

• reportNotify: Enable/disable report notifications.

---

Key Mapping Configuration

Keybinds for staff actions, you can check the official FiveM Docs Page to change the keys.

---

UI Configuration

• ServerLogo: Displayed in the top left of the UI.

• DefaultAvatar: Used if the player’s Steam avatar is unavailable.

• UseSteamName: If true, uses Steam name instead of RP name.

• darkMode: Switches the UI to dark theme.

---

Reports Configuration

Type Configuration

Defines the categories/types of reports players can submit.

Each type must have:

• id: Unique identifier (used internally).

• label: Displayed name.

• description: Shown in the UI.

• icon: Icon name (e.g., "bug", "question").

Maximum Reports

Sets how many active reports a player can have for each report type.

Make sure that each one here has the same name as each ID in Config.ReportTypes

Discord Logging System

This optional configuration lets you send logs to Discord for better staff monitoring and transparency.

• Each webhook must be a valid Discord webhook URL.

• Make sure SVConfig.logSystem = true to enable logs.

• In the openReport table, the report type must match the report type IDs in Config.ReportTypes.