misticos
Send reports from players to a Discord channel (Including F7 reports for Rust)

Supported Games
GameServerKingsGameServerKings
works with

This plugin is just a command for reporting and a webhook interaction. Simple: Use a command to report a player, profit!

In Rust you can simply use F7, select a player and fill the form - report will be sent to your Discord as well. Please, ensure that players do not send this way server-specific reports like group limits.

WARNING

  • Make sure to grant use permission before using and suffering.

Placeholder API

  • discordreport.total - Total amount of reports received from unique users.

Configuration

Default Configuration

{
  "Webhook URL": "YOUR WEBHOOK LINK HERE",
  "Message Content": "",
  "Embed Title": "My Server Report",
  "Embed Description": "Report sent by a player from your server",
  "Embed Color": 1484265,
  "Set Author Icon From Player Profile": true,
  "Use Reporter (True) Or Suspect (False) As Author": true,
  "Allow Reporting Admins": false,
  "Report Commands": [
    "report"
  ],
  "Allow Only Online Suspects Reports": true,
  "Threshold Before Sending Reports": 0,
  "Show Recent Suspect Combatlog": false,
  "Show In-Game Subject": true,
  "Minimum In-Game Report Subject Length": 0,
  "Minimum In-Game Report Message Length": 0,
  "Allowed In-Game Report Types": [
    "cheat",
    "abusive",
    "name",
    "spam"
  ],
  "Recent Combatlog Entries": 2,
  "Cooldown In Seconds": 300,
  "User Cache Validity In Seconds": 86400,
  "Minimum Message Length": 0
}

How-To

Webhook URL - Webhook URL. Google for more.

Message Content - Content of the Webhook message, could ping roles here with <@&RoleID> or users with <@UserID>.

Embed Title - Embed title in Discord.

Embed Description - Embed description in Discord.

Embed Color - HEX as a usual number, look for "hex to decimal".

Set Author Icon From Player Profile - Use Steam icon of author in embed or not.

Use Reporter (True) Or Suspect (False) As Author - Whether we should use reporter or suspect as author.

Allow Reporting Admins - Allow reporting admins or not to avoid IP revealing and etc to usual mods/.., detects admins with permission discordreport.admin

Report Commands - Commands for reporting.

Allow Only Online Suspects Reports - Whether players can report ONLY other players who are online or offline too.

Threshold Before Sending Reports - Amount of reports that has to be reached to send the report (Nth report will be sent).

Cooldown In Seconds - Cooldown between command reports in seconds.

User Cache Validity In Seconds - How long Steam Avatar URL is cached for.

Localization

English

{
  "Webhook: Reporter Data Title": "Reporter",
  "Webhook: Suspect Data Title": "Suspect",
  "Webhook: Combatlog Title": "Suspect's Combatlog #{n}",
  "Webhook: Combatlog Attacker Title": "Attacker",
  "Webhook: Combatlog Target Title": "Target",
  "Webhook: Combatlog Time Title": "Time",
  "Webhook: Combatlog Weapon Title": "Weapon",
  "Webhook: Combatlog Ammo Title": "Ammo",
  "Webhook: Combatlog Distance Title": "Distance",
  "Webhook: Combatlog Old HP Title": "Old HP",
  "Webhook: Combatlog New HP Title": "New HP",
  "Webhook: Combatlog Info Title": "Info",
  "Webhook: Reporter Data": "#{discordreport.total} {name} ({id}). IP: {ip}.\nPing: {ping}ms. Connected: {connected}",
  "Webhook: Suspect Data": "#{discordreport.total} {name} ({id}). IP: {ip}.\nPing: {ping}ms. Connected: {connected}",
  "Webhook: Report Subject": "Report Subject",
  "Webhook: Report Message": "Report Message",
  "Command: Syntax": "Syntax:\nreport (ID / \"Name\") (Message)\nWARNING! Use quotes for names.",
  "Command: User Not Found": "We were unable to find this user or multiple were found.",
  "Command: Report Sent": "Thank you for your report, it was sent to our administration.",
  "Command: Exceeded Cooldown": "You have exceeded your cooldown on reports.",
  "Command: Cannot Report Admins": "You cannot report admins.",
  "Command: Cannot Use": "You cannot use this command since you do not have enough permissions.",
  "Command: Message Length": "Please add more information to the message."
}

Commands

  • report - Report a player. Syntax: report (ID / Name) (Message). WARNING! Make sure to use quotes for names if they contain spaces.

Permissions

  • discordreport.admin - Admin permission, also used for preventing admins reports.
  • discordreport.ignorecooldown - Permission for ignoring report cooldown.
  • discordreport.use - Use the plugin functionality.

MIT License


Copyright (c) 2019-2021 misticos


Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:


The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.


THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.