Official Documentation

Overview

AevorinReports is a modern, robust reporting system designed for Minecraft servers that require structured moderation workflows. It enables players to submit reports easily while providing staff with powerful tools to review, manage, and resolve reports efficiently. The plugin is optimized for performance, supports multiple GUI styles, integrates with Discord, and scales seamlessly across single servers and networks.

---

Region Restriction

AevorinReports is designed to be used globally; however, please note that the plugin is restricted and will not function on servers located within Israel. This is enforced via automated IP/timezone verification.

#FreePalestine

---

1. Core Features

• Interactive Admin GUI – Review, manage, and update reports using a clean, click-based interface
• Player Report History – Players can view their submitted reports and statuses using /reports
• Multiple GUI Types – Supports both Book GUI and Container (Chest) GUI styles
• Real-Time Staff Alerts – Instantly notify staff members when a report is submitted
• Clear Status Workflow – Reports transition through Pending → Resolved / Rejected
• Custom Report Reasons – Allows players to provide custom reasons via chat input
• MiniMessage Support – Fully customizable messages with gradients, hover events, and formatting
• Discord Integration – Dedicated Discord bot with embeds and real-time notifications
• Database Support – SQLite (local) and MySQL (network-wide synchronization)
• Optimized Performance – Asynchronous processing and intelligent caching
• bStats Integration – Anonymous usage statistics for development insights

---

2. Commands

2.1 Player Commands

Command	Description	Permission
/report <player> [reason]	Submit a report against a player	aevorinreports.report
/reports	View your submitted reports and their status	aevorinreports.report

Notes:

• If no reason is provided with /report, a GUI will open
• Custom reasons can be entered via chat

2.2 Staff Commands

Command	Description	Permission
/reports	Open the Admin Report Management GUI	aevorinreports.manage
/viewreport <id>	View detailed report information	aevorinreports.manage
/setreportstatus <id> to <status>	Update report status	aevorinreports.manage
/ar reload	Reload the plugin configuration	aevorinreports.reload

2.3 Discord Bot Commands

Command	Description
/reports	List all active pending reports
/lookup <id>	View full details of a specific report
/resolve <id>	Mark a report as Resolved
/reject <id>	Mark a report as Rejected
/pending <id>	Mark a report as Pending
/help	View the bot help menu

---

3. Permissions

3.1 Basic Permissions

Permission	Description	Default
aevorinreports.report	Allows players to submit reports	true
aevorinreports.manage	Allows staff to manage reports and access Admin GUI	op
aevorinreports.notify	Receive notifications when a report is submitted	op
aevorinreports.reload	Reload the configuration	op

3.2 Wildcard Permissions

Permission	Description
aevorinreports.*	Grants all AevorinReports permissions

---

4. Report Workflow

1. A player submits a report using /report
2. Staff members receive instant notifications
3. Report is marked as Pending
4. Staff review the report via the Admin GUI
5. Report is marked as Resolved or Rejected

All actions are logged and synchronized across servers when using MySQL.

---

5. Configuration (config.yml)

This section documents every available option in config.yml, explaining its purpose and recommended usage.

---

5.1 Server Configuration

server-name: "survival"

• server-name: Identifies the server in multi-server setups.

  • Must be unique when multiple servers share the same database.
  • Displayed in Discord embeds and network-wide logs.

---

5.2 Database Configuration

database:
  type: "file" # mysql or file

Database Types

• file: Uses local SQLite storage (recommended for single servers).
• mysql: Enables cross-server synchronization for networks.

MySQL Settings

mysql:
  host: "localhost"
  port: 3306
  database: "aevorin_reports"
  username: "root"
  password: "password"

• Used only when type is set to mysql.
• All servers must share the same credentials for synchronization.

File Storage

file:
  path: "database/reports.db"

• Location of the SQLite database file.

Connection Pool (Advanced)

pool:
  minimum-idle: 5
  maximum-pool-size: 10
  connection-timeout: 30000

• Optimizes database performance.
• Recommended to leave defaults unless tuning is required.

---

5.3 Report Settings

reports:
  allow-self-reporting: false

• Prevents players from reporting themselves when disabled.

GUI Configuration

gui:
  type: "book" # book or container

• book: Classic book-style interface.
• container: Modern chest-style GUI.

Limits & Cooldowns

cooldown: 300
max-active-reports: 3

• cooldown: Time (seconds) between report submissions.
• max-active-reports: Maximum unresolved reports per player.

Custom Reasons

allow-custom-reasons: true
custom-reason-min-length: 10
custom-reason-max-length: 100

• Allows players to submit custom reasons via chat.
• Length limits prevent spam and abuse.

Report Categories

categories:
  - "Hacking/Cheating"
  - "Harassment/Bullying"
  - "Spam/Advertisement"

• Displayed in the report GUI.
• Categories are fully customizable.

---

5.4 Notification Settings

notifications:
  new-report: true
  status-change: true
  sound: "BLOCK_NOTE_BLOCK_PLING"
  prefix: "&8[&bAevorinReports&8]&r "

• new-report: Notify staff when a report is created.
• status-change: Notify staff when report status changes.
• sound: Sound played for staff alerts (empty string disables).
• prefix: Prefix used for all plugin messages.

---

5.5 Update Checker

update-checker:
  check-interval: 60
  notify-on-join: true

• Automatically checks for new plugin versions.
• Notifies authorized players on join.

---

5.6 Debug Settings

debug:
  enabled: false
  log-queries: false

• enabled: Enables detailed debug logging.
• log-queries: Logs database queries (not recommended for production).

---

5.7 Message Customization

messages:
  report-created: "&aYour report has been submitted successfully!"

• Fully customizable messages.
• Supports color codes (&) and placeholders.
• MiniMessage is supported where applicable.

---

5.8 Discord Integration

discord:
  enabled: false

Network Mode (Multi-Server)

network-mode:
  enabled: false # set to true on ONE server only in a network
  poll-interval: 10 # how often to sync reports from the database (seconds)

• enabled: If true, this server will poll the database for reports from all servers.
• poll-interval: The frequency of database checks. Recommended: 5-10.

Core Settings

bot-token: "YOUR_BOT_TOKEN_HERE"
channel-id: "YOUR_CHANNEL_ID_HERE"
log-channel-id: "YOUR_LOG_CHANNEL_ID_HERE"

• Sends reports and status updates directly to Discord.

Staff Permissions

staff-role-id: ""

• Optional role restriction for Discord moderation commands.

Bot Appearance

bot-settings:
  status: "ONLINE"
  activity:
    type: "WATCHING"
    message: "Reports | %online_players% players online"

Discord Notifications

notifications:
  title: "New Report (#%id%)"
  color: "#ff5555"
  footer: "AevorinReports • %date%"

• Fully customizable embed formatting.

---

6. Discord Features

• Report submission notifications
• Status update alerts
• Embedded messages with player avatars
• Server and report metadata displayed

---

7. GUI Preview

---

8. Technical Features

• Async database operations
• Thread-safe report handling
• Efficient caching system
• Modular and extendable architecture
• Safe reload handling

---

9. Dependencies

Optional

• MySQL – Network-wide report synchronization
• Discord API (JDA) – Discord bot integration

Notes:

• These optional dependencies are built in the plugin itself and can be enabled from config.yml

---

10. Installation Guide

1. Download AevorinReports from the Modrinth page
2. Place the .jar file into the /plugins/ directory
3. Restart the server to generate configuration files
4. Configure config.yml and database settings
5. (Optional) Configure Discord integration
6. Reload or restart the server

---

11. bStats

---

12. License

AevorinReports is licensed under the MIT License.

You are free to use, modify, distribute, and sublicense this software, provided that the original copyright and license notice are included in all copies.

---

Credits

Developed by Aevorin Studios