EasyReport

A Modern, GUI-Based Reporting Plugin

EasyReport is the simple, modern solution to player reporting. Forget clunky commands and confusing formats. This plugin provides an intuitive GUI for players and sends clean, detailed reports directly to your Discord, making moderation efficient and professional.

Manage your server with clarity. EasyReport bridges the gap between in-game events and your staff's workflow.

Features

• Intuitive GUI Reporting: Players use /report <player> to open a clean interface with your pre-defined reasons.
• Private Chat Prompts: Guides users to provide custom reasons or proof through a private chat conversation. No more public report spam!
• Powerful Discord Integration: Sends beautifully formatted and detailed reports directly to a Discord channel of your choice.
• Fully Customizable:
  • Edit report reasons in the config.
  • Change the Discord webhook's name, avatar, and embed color.
  • Customize the in-game staff alert message with full color code support.
• Instant Staff Alerts: Online staff with the quickreport.staff permission get an immediate in-game notification when a report is filed.
• In-Game Report Viewer: Staff can use /reports to view a history of the most recent reports in a GUI.
• Live Reload: Use /easyreport reload to apply configuration changes without a server restart. No downtime needed!

Installation & Setup

1. Download the EasyReport.jar and place it in your server's /plugins folder.
2. Start the server once to generate the default configuration files.
3. Open config.yml and paste your Discord webhook URL, and make sure you add a name and avatar for your webhook in the config.yml or else it wont work. This is the most important step!
4. Customize the rest of the config.yml to your liking.
5. Run the command /easyreport reload or restart the server. You're ready to go!

# ----------------------------------------------------
# EasyReport Configuration
# ----------------------------------------------------

# Paste your Discord Webhook URL here.
discord-webhook-url: "WEBHOOK_URL_HERE"

# List of reasons players can select in the GUI.
report-reasons:
  - "Hacking"
  - "Death Threats"
  - "Griefing"
  - "Spamming"
  - "Inappropriate Language"
  - "Teaming"
  - "Other"

# ----------------------------------------------------
# Customization
# ----------------------------------------------------

staff-alerts:
  enabled: true
  # The message to send. Color codes with '&' are supported.
  # Placeholders: %reporter%, %reported%, %reason%
  message: "&c[Alert] &f%reporter% &7reported &f%reported% &7for: &e%reason%"

webhook-settings:
  username: ""
  avatar-url: ""

embed-settings:
  color: 5763719
  reporter-field-name: "REPORTER:"
  reported-player-field-name: "REPORTED PLAYER:"
  reason-field-name: "REASON:"
  proof-field-name: "PROOF:"
  date-field-name: ":DATE:"

  footer-text: "Report from the %server% server"

Commands & Permissions

Player Commands

• /report <player>
  • Description: Opens the GUI to report a player.
  • Permission: quickreport.report (Default: true)

Staff Commands

• /reports
  • Description: Views the most recent reports in a GUI.
  • Permission: quickreport.staff (Default: op)
• /easyreport reload
  • Description: Reloads the config.yml file.
  • Permission: quickreport.reload (Default: op)