Comprehensive Guide

ReportSystem Documentation

Professional report and moderation system for your Minecraft server

ReportSystem is a comprehensive player reporting and moderation plugin developed for Minecraft servers. Inspired by CS:GO's Overwatch system, it offers community-based review system, automatic replay recordings, and advanced punishment management features.

Features

All features offered by ReportSystem

Requirements

Version Compatibility

Quick Installation (Standalone)

license:
  license-key: "KB-XXXX-XXXX-XXXX"

BungeeCord/Velocity Setup

bungeecord:
  enabled: true
  display-name: "Survival"  # Server name
database:
  type: mysql
  mysql:
    host: "localhost"
    port: 3306
    database: "reportsystem"
    username: "root"
    password: "password"

Velocity Setup

If you use a modern proxy, you can use the Velocity module.

Database Settings

SQLite vs MySQL

database:
  type: mysql
  mysql:
    host: "localhost"
    port: 3306
    database: "reportsystem"
    username: "root"
    password: "strong_password"
    pool:
      maximum-pool-size: 10
      minimum-idle: 2
      connection-timeout: 30000
      idle-timeout: 600000
      max-lifetime: 1800000

General Settings

Report Settings

categories:
  - "Cheating"
  - "Harassment"
  - "Spam"
  - "Griefing"
  - "Bug Abuse"
  - "Other"

Replay Settings

Overwatch Settings

Reward Settings

XP Settings

Reward Commands

overwatch:
  rewards:
    enabled: true

    # Her inceleme sonrası
    on-review-complete:
      - "give %player% diamond 1"
      - "eco give %player% 100"

    # Sadece Suçlu/Masum oyları için
    on-guilty-innocent:
      - "give %player% emerald 1"

    # Seviye atlama ödülü
    on-level-up:
      - "broadcast &e%player% &7Overwatch seviye &e%level% &7oldu!"
      - "give %player% diamond 5"

    # Rütbe atlama ödülleri
    on-rank-up:
      bronze:
        - "broadcast &c%player% &lBRONZE &7rütbesine ulaştı!"
      silver:
        - "give %player% iron_ingot 32"
      gold:
        - "give %player% gold_ingot 32"
      diamond:
        - "give %player% diamond 64"

Player Commands

Aliases: /rapor, /raporla, /reportplayer

/reports aliases: /raporlar, /reportlist, /raporlistesi

Staff Commands

Staff actions (accept, reject, delete, punish) are done via GUI instead of commands:

Overwatch Commands

Aliases: /ow, /overwatchsystem

Admin Commands

Aliases: /rs, /rsystem, /raporsistem

Basic Permissions

Moderator Permissions

LuckPerms Example

/lp creategroup moderator
/lp group moderator permission set reportsystem.view.all true
/lp group moderator permission set reportsystem.notify true
/lp group moderator permission set reportsystem.manage true
/lp group moderator permission set reportsystem.overwatch true

Admin Permissions

Replay System

How It Works?

Recorded Data (53+ Action Types)

Player Actions:

• Position, direction and movement (every tick)
• Health, absorption (golden hearts) and damage
• Equipment and inventory changes
• Animations (arm swing, damage)
• Pose changes (sneaking, sprinting, swimming)
• Knockback/velocity, death and teleportation
• Chat messages and potion effects

World Actions:

• Block break/place, falling blocks
• Explosions, fire, redstone, note blocks
• Sign editing, decorations (painting, item frame)
• Weather changes and sound effects

Gameplay Actions:

• Item usage (bow, shield, food), fishing
• Crafting, brewing, enchanting
• Vehicle riding (horse, boat), portal usage
• Projectiles (arrow, snowball), animal breeding
• Nearby players (as NPCs)

Replay Controls

Overwatch System

What is it?

Overwatch is a community-based report review system inspired by CS:GO. Trusted players review reports and vote. When enough "Guilty" votes are received, consensus is reached and admins make the final decision.

Review Process

Rank System

NPC System

Creating NPC

/overwatch npc create Overwatch-1

Creates an Overwatch NPC where you are looking.

NPC Features

• Real player appearance NPC (PacketEvents based)
• Customizable skin (any player's skin)
• Shows hologram statistics
• Opens Overwatch menu when right-clicked
• Automatically restored on server restart
• Cannot be broken or interacted with

NPC Management

/overwatch npc list             # List all NPCs
/overwatch npc delete <id>      # Delete specified NPC
/overwatch npc skin <npc> <player>  # Change NPC skin
/overwatch npc look <npc>       # Make NPC look at you
/overwatch npc move <npc>       # Move NPC to your location
/overwatch npc name <npc> <name>  # Rename NPC
/overwatch npc select <npc>     # Select NPC for quick editing

Punishment System

You can apply punishments directly from the GUI during report review.

Punishment Types

Quick Duration Selection

punishments:
  durations:
    - "5m"        # 5 minutes
    - "30m"       # 30 minutes
    - "1h"        # 1 hour
    - "1d"        # 1 day
    - "7d"        # 7 days
    - "30d"       # 30 days
    - "permanent" # Permanent

Animated Ban ⚡

Ban cheating players with a visual spectacle. Other players can also witness this moment.

Notification System

When a new report is created, multiple notifications are sent to staff. All notification types can be toggled independently.

When a staff member joins the server, the pending report count is automatically shown.

Discord Webhook

Reports, punishments and report closures are automatically notified to your Discord channel.

Setup

discord-webhook:
  enabled: true
  url: "https://discord.com/api/webhooks/123456789/abcdefghijklmnop"
  avatar-url: "https://i.imgur.com/4M34hi2.png"
  add-buttons: true
  include-server-name: true

  events:
    new-report: true      # New report
    report-closed: true   # Report accepted/rejected
    punishment: true      # When punishment applied

Features

Anti-Cheat Integration

ReportSystem integrates with anti-cheat plugins to automatically create recordings + reports + Overwatch queue entries when cheating is detected. Cheaters are automatically recorded without the need for manual /report commands.

How Does It Work?

Configuration

Polar Anti-Cheat

polar:
  enabled: false
  suspicion-threshold: 1.0    # Suspicion threshold (0.5=sensitive, 1.0=balanced, 1.5=conservative)
  cooldown-seconds: 300       # Cooldown per player
  max-auto-recordings: 5      # Max concurrent recordings
  recording-duration: 30      # Recording duration (seconds)
  add-to-overwatch: true      # Add to Overwatch queue

Vulcan Anti-Cheat

vulcan:
  enabled: false
  suspicion-threshold: 1.0
  cooldown-seconds: 300
  max-auto-recordings: 5
  recording-duration: 30
  add-to-overwatch: true

Grim AntiCheat

grim:
  enabled: false
  suspicion-threshold: 1.0
  cooldown-seconds: 300
  max-auto-recordings: 5
  recording-duration: 30
  add-to-overwatch: true

Scoring Table

Punishment Plugins

ReportSystem works fully compatible with the following punishment plugins:

PlaceholderAPI

ReportSystem fully integrates with PlaceholderAPI. You can use the following placeholders in scoreboards, tab, holograms and other plugins.

Report Placeholders

Overwatch Placeholders

Usage Example

# Scoreboard example (TAB, Featherboard etc.)
Reports: %reportsystem_reports%
Trust Level: %reportsystem_trust_level%
OW Rank: %reportsystem_overwatch_rank%
OW Level: %reportsystem_overwatch_level%

Frequently Asked Questions

Troubleshooting

Performance Settings

Support