KAREBLOK.TC - ReportSystem

⚡ Quick Start

Install ReportSystem in 5 minutes and start using it!

Download PacketEvents

Download PacketEvents 2.0+ and put it in the plugins folder

$ wget https://github.com/retrooper/packetevents/releases/latest

Install ReportSystem

Copy ReportSystem JAR file to plugins folder

$ cp ReportSystem-1.0.0.jar ./plugins/

Start the Server

Configuration files will be auto-generated on first start

$ java -Xmx2G -jar server.jar

Edit Configuration

Edit config.yml to configure database settings

$ nano plugins/ReportSystem/config.yml

Restart

Fully restart the server to activate changes (do not use reload!)

$ stop
$ java -Xmx2G -jar server.jar

📋 Requirements

🎮

Minecraft Version

1.18 - 1.21+

☕

Java Version

Java 17 or higher

📦

Server Software

Paper/Spigot

🔧

Dependencies

PacketEvents 2.0+

💾

RAM

Minimum 2GB

🗄️

Database

MySQL/SQLite

⚠️

Important: The plugin will not work without PacketEvents! Make sure PacketEvents is installed before installation.

Optional Dependencies

🏷️

PlaceholderAPI

Placeholder support

💰

Vault

Economy integration

🔨

LiteBans

Punishment integration

⛔

AdvancedBan

Punishment integration

⚙️ Configuration

General

Database

Replay System

Overwatch

# General Settings

language: "tr" # tr or en
bungeecord: false # Set to true if using BungeeCord/Velocity
debug: false

# Report Settings
reports:
  cooldown-seconds: 60
  auto-close-days: 30
  notify-staff: true

# Database Settings
database:
  type: "mysql" # mysql or sqlite
  host: "localhost"
  port: 3306
  database: "reportsystem"
  username: "root"
  password: "password"
  pool-size: 10
  use-ssl: false

# Replay Recording Settings

replay:
  enabled: true
  duration-seconds: 45 # Recording duration (seconds)
  auto-delete-days: 7 # Auto delete (days)
  save-blocks: true
  save-entities: true
  max-tracked-players: 50

# Overwatch System

overwatch:
  enabled: true
  min-reports: 3
  auto-assign: true
  xp-rewards:
    correct: 10
    incorrect: -5
  ranks:
    bronze: 0
    silver: 100
    gold: 500

🌐 BungeeCord/Velocity Setup

💡

Info: For BungeeCord/Velocity setup, you need to install the plugin on both proxy and backend servers.

Install on Proxy

Place ReportSystem-Bungee.jar in BungeeCord/Velocity plugins folder

Install on Backend Servers

Install ReportSystem-Spigot.jar on all Spigot/Paper servers

MySQL Configuration

All servers must use the same MySQL database

Update Config

Set bungeecord: true in config.yml on all Spigot servers

Test

Create reports with /report from different servers and check with /reports

🚀

Velocity: The same steps apply for Velocity proxy. Use ReportSystem-Velocity.jar file.

🔧 Troubleshooting

Plugin won't start, what should I do? +

1. Make sure PacketEvents is installed
2. Check that your Java version is 17 or higher
3. Check console logs
4. Make sure there are no syntax errors in config.yml

I'm getting database connection error +

1. Make sure MySQL server is running
2. Check your username and password
3. Make sure database is created
4. Check firewall settings

Replay recordings take up too much space +

1. Enable auto-clean feature
2. Lower clean-after-days value
3. Make sure compression is enabled
4. You can shorten duration (e.g., 30 seconds)

BungeeCord synchronization not working +

1. Make sure all servers use the same MySQL database
2. Check that bungeecord: true is set in config.yml
3. Check that proxy and backend versions are compatible
4. Create reports from different servers and test with /reports