🚀 Sqrilizz-Reports

A professional, high-performance reports management system for Minecraft servers, now optimized for a smaller footprint and faster operation.

📋 What This Plugin Does

Sqrilizz-Reports provides server administrators with a complete player reporting system that includes:

Player Reporting System - Players can report rule violations with /report <player> <reason>
Admin Management Tools - Review, resolve, and manage reports through intuitive commands
Multi-Platform Notifications - Discord webhooks, Telegram integration, and generic webhook support
Anti-Abuse Protection - Rate limiting and false report detection to prevent system abuse
REST API - External integration capabilities for web panels and other tools
Lightweight & Optimized - Significantly reduced file size for better server performance.
Multi-Language Support - English, Russian, and Arabic translations

✨ Core Features

🎨 Beautiful Design System

Hex color support for Minecraft 1.16+ with legacy fallbacks
Modern emoji integration for enhanced UX
Customizable color palette with 7 predefined themes
Gradient text effects for premium feel

🛡️ Advanced Anti-Abuse Protection

Rate limiting: Per-player and hourly limits
False report detection with automatic credibility adjustment
Smart cooldowns based on player behavior
Automatic cleanup of old data

🙈 Privacy & Security

Anonymous reports option for sensitive situations
Data protection with configurable visibility
UUID-based tracking with legacy support
Secure API for external integrations

🌍 Multi-Language Support

3 Languages: English, Russian, Arabic
RTL support for Arabic text
Easy language switching with /report-language
Localized messages and error handling

🔧 Commands Overview

👥 Player Commands

/report <player> <reason>       — Report a player for violations
/report-language <en|ru|ar>     — Change server language (admin)

🛠️ Admin Commands

/reports                        — View all active reports
/reports check <player>         — Check reports for specific player
/reports clear <player>         — Clear reports for a player
/reports clearall               — Clear all reports
/reports false <player>         — Mark player's reports as false
/report-reload                  — Reload plugin configuration

📱 Telegram Integration

/report-telegram token <token>  — Set Telegram bot token
/report-telegram chat <id>      — Set Telegram chat ID

🔗 Webhook Support

/report-webhook set <url>       — Set Discord webhook URL
/report-webhook remove          — Remove webhook

🖥️ Compatibility

Minecraft Versions: 1.8.9 - 1.21.x (All versions supported) Server Software: Paper (recommended), Spigot, Folia Java: 21+ (with fallbacks for older versions)

Note: The plugin automatically detects your server version and adapts its features accordingly.

⚙️ Configuration

📄 Basic config.yml

# Language (en, ru, ar)
language: en

# Anonymous reports
anonymous-reports: false

# Cooldown between reports (seconds)
cooldown: 60

# Auto-ban threshold
auto-ban-threshold: 8

# Anti-abuse limits
report-limits:
  per-player: 3    # Max reports per player
  per-hour: 10     # Max reports per hour

# Design settings
design:
  use-hex-colors: true
  colors:
    primary: "#FF6B6B"
    secondary: "#4ECDC4"
    success: "#45B7D1"

🌐 REST API (config excerpt)

rest-api:
  enabled: true
  port: 8971
  token: "REPLACE_ME"
  ip-whitelist:
    enabled: false
    list: []
  webhook:
    secret: ""    # optional HMAC secret
  rate-limit:
    rps: 10

💾 Database (config excerpt)

database:
  type: sqlite   # Default, works out-of-the-box
  # To use MySQL, set type to 'mysql' and provide connection details.
  # MySQL is now optional. To enable it, download the MySQL JDBC driver and place it in the /plugins/Sqrilizz-Reports/lib/ folder.
  mysql:
    host: "localhost"
    port: 3306
    database: "sqrilizz_reports"
    user: "root"
    password: ""
    pool-size: 10
    params: "useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=utf8&serverTimezone=UTC"

🧪 Permissions

Permission	Description	Default
`reports.report`	Use `/report` command	✅ Everyone
`reports.admin`	Access admin commands	👑 OPs only
`reports.language`	Change server language	👑 OPs only
`reports.telegram`	Configure Telegram	👑 OPs only
`reports.reload`	Reload configuration	👑 OPs only
`reports.bypass`	Immunity from reports	👑 OPs only

🛠️ Developer API

📦 Maven Dependency

<dependency>
    <groupId>dev.sqrilizz</groupId>
    <artifactId>sqrilizz-reports</artifactId>
    <version>7.6</version>
    <scope>provided</scope>
</dependency>

🚀 Quick API Usage

// Create a report programmatically
ReportAPI.createReport(player, target, "Automated detection");

// Listen for report events
ReportAPI.onReportCreate(event -> {
    // Handle new report
});

// Get reports for a player
List<Report> reports = ReportAPI.getReports(player);

🔔 Integrations

📱 Telegram Bot

Instant report notifications
Moderation commands via Telegram
Admin-only access control
Rich message formatting

🔗 Webhooks

JSON webhook support for external systems
Custom integrations with other tools
Automated report processing
Third-party service integration

📚 Documentation

🌍 Multi-Language READMEs

🇺🇸 English: README.md
🇷🇺 Russian: README-RU.md
🇸🇦 Arabic: README-AR.md

📖 Specialized Guides

🤖 Discord Bot: Discord Integration Guide
📱 Telegram: Telegram Setup Guide
🛠️ API: Developer API Documentation
🌐 REST API: REST API Reference
💾 Database: Database & Swapping Guide
🔧 Installation: Complete Installation Guide
⚙️ Configuration: Configuration Reference
🛡️ Anti-Abuse: Anti-Abuse System Guide
🎨 Design: Design System Documentation

📞 Support & Community

🆘 Get Help

📱 Telegram: Follow for updates
📚 Documentation: GitHub Wiki
🐛 Bug Reports: GitHub Issues
💡 Feature Requests: GitHub Discussions

🤝 Contributing

🌍 Translations: Help translate to more languages
🐛 Bug Fixes: Submit pull requests
📝 Documentation: Improve guides and examples
💡 Features: Suggest and implement new features

🎯 Key Benefits

✅ Complete Solution: Everything you need for player reporting in one plugin
✅ Easy Setup: Works out of the box with sensible defaults
✅ Scalable: Handles small servers to large networks efficiently
✅ Reliable: Tested across multiple Minecraft versions and server types
✅ High Performance: Optimized for minimal server impact. ✅ Extensible: REST API and webhook support for custom integrations
✅ Well Maintained: Regular updates and active community support

A professional reporting system that grows with your server.

Sqrilizz | Report