QuickReport

A quick and efficient reporting system for Minecraft servers

📋 Description

QuickReport is a powerful and user-friendly reporting system designed for Minecraft servers. It allows players to report cheaters, rule-breakers, or any misconduct with ease, while providing administrators with comprehensive tools to manage and process reports efficiently.

✨ Key Features

Easy Report Submission - Players can report others with a simple command
Admin Review System - Accept or reject reports with customizable rewards
Report History - Players can view their submitted reports
Advanced Query System - Detailed report information for staff members
Cooldown Protection - Prevents spam with configurable cooldown timers
Clickable Messages - Interactive admin notifications with click-to-view functionality
SQLite Database - Lightweight and efficient data storage
Reward System - Automatically reward players for accepted reports
Multi-Language Support - Built-in English and Turkish language support
PlaceholderAPI Integration - Statistics and leaderboard placeholders

🔧 Requirements

Minecraft Server: Paper/Spigot 1.20+
Java: 17 or higher
Dependencies (Optional):
- PlaceholderAPI - For placeholder support

📥 Installation

Download the latest QuickReport-1.0.0.jar from the releases page
Place the JAR file in your server's plugins folder
Restart your server or use a plugin manager to load it
Configure the plugin by editing config.yml and messages.yml in the plugins/QuickReport/ folder
Reload the plugin with /reload confirm or restart the server

🎮 Commands

Player Commands

Command	Description	Permission	Usage
`/report`	Submit a report against a player	`quickreport.report`	`/report <player> <reason> [details]`
`/myreports`	View your submitted reports	`quickreport.report`	`/myreports [page]`
`/queryreport`	Query a specific report by ID	`quickreport.report`	`/queryreport <id>`

Admin Commands

Command	Description	Permission	Usage
`/reports`	View all pending reports	`quickreport.admin`	`/reports [page]`
`/reportaction`	Accept or reject a report	`quickreport.admin`	`/reportaction <accept\|reject> <id> [reward-code\|reason]`

🔐 Permissions

Permission	Description	Default
`quickreport.report`	Allows players to submit and view reports	`true` (all players)
`quickreport.admin`	Allows staff to manage and process reports	`op` (operators only)

⚙️ Configuration

config.yml

# QuickReport Configuration File

# General Settings
report-cooldown-seconds: 60 # Cooldown for submitting new reports
max-reports-per-cooldown: 1 # Maximum reports within cooldown period

# Report Reasons (Tab-completion support)
report-reasons:
  - "Fly"
  - "KillAura"
  - "Speed"
  - "Xray"
  - "Griefing"
  - "Swearing"

# Admin Notification Settings
admin-permission: "quickreport.admin"
notification-sound: "ENTITY_EXPERIENCE_ORB_PICKUP"
notification-volume: 1.0
notification-pitch: 1.0

# Reward System Configuration
rewards:
  diamond-reward:
    name: "&bDiamond Reward"
    command: "give %player% diamond 5"
  money-reward:
    name: "&eMoney Reward"
    command: "eco give %player% 1000"
  key-reward:
    name: "&6Crate Key Reward"
    command: "crate give %player% common 1"

Customizing Report Reasons

Edit the report-reasons list in config.yml to add or remove valid reasons:

report-reasons:
  - "Hacking"
  - "Exploiting"
  - "Toxicity"
  - "Scamming"

Admin Notification Sound

Change the sound played to admins when a new report is submitted. See Spigot Sound List for available sounds.

🎁 Reward System

The reward system allows you to automatically reward players when their reports are accepted.

Adding a New Reward

Open config.yml
Add a new reward under the rewards section:

rewards:
  custom-reward:
    name: "&aCustom Reward"
    command: "give %player% diamond_block 1"

Use the reward code when accepting a report:

/reportaction accept 123 custom-reward

The %player% placeholder will be replaced with the reporter's username.

📊 PlaceholderAPI Support

QuickReport integrates with PlaceholderAPI to provide statistics and leaderboard placeholders.

Available Placeholders

Placeholder	Description	Example Output
`%quickreport_kabul_edilen%`	Number of accepted reports for a player	`5`
`%quickreport_reddedilen%`	Number of rejected reports for a player	`2`
`%quickreport_top_kabul_isim_<rank>%`	Top reporter name (accepted)	`Player1`
`%quickreport_top_kabul_sayi_<rank>%`	Top reporter count (accepted)	`10`
`%quickreport_top_red_isim_<rank>%`	Top reporter name (rejected)	`Player2`
`%quickreport_top_red_sayi_<rank>%`	Top reporter count (rejected)	`3`

Usage Example

# In a scoreboard or hologram
&6Top Reporter: &e%quickreport_top_kabul_isim_1%
&7Reports: &a%quickreport_top_kabul_sayi_1%

🌐 Multi-Language Support

QuickReport supports multiple languages out of the box. The primary language is English (en), with Turkish (tr) as a secondary language.

Customizing Messages

Edit messages.yml to customize messages:

messages:
  report-success:
    en: "&aYour report has been submitted successfully!"
    tr: "&aRaporunuz başarıyla gönderildi!"

Adding a New Language

Open messages.yml
Add your language code to any message:

messages:
  report-success:
    en: "&aYour report has been submitted!"
    tr: "&aRaporunuz gönderildi!"
    de: "&aDein Bericht wurde eingereicht!"

📖 Usage Examples

Player Workflow

Submit a report:

/report Cheater123 Fly He was flying in spawn

Check your reports:
```
/myreports
```
Query a specific report:
```
/queryreport 5
```

Admin Workflow

View pending reports:
```
/reports
```
Click on a report or use:
```
/queryreport 5
```
Accept a report with reward:
```
/reportaction accept 5 diamond-reward
```

Reject a report with reason:

/reportaction reject 5 Insufficient evidence

🗄️ Database

QuickReport uses SQLite for data storage. The database file is located at:

plugins/QuickReport/reports.db

Database Schema

CREATE TABLE reports (
    id INTEGER PRIMARY KEY AUTOINCREMENT,
    reporter_uuid TEXT NOT NULL,
    reporter_name TEXT NOT NULL,
    reported_uuid TEXT NOT NULL,
    reported_name TEXT NOT NULL,
    reason TEXT NOT NULL,
    details TEXT,
    timestamp INTEGER NOT NULL,
    status TEXT NOT NULL DEFAULT 'PENDING',
    admin_uuid TEXT,
    admin_name TEXT,
    rejection_reason TEXT
);

🔄 Report Status

Reports can have three statuses:

PENDING - Awaiting admin review
ACCEPTED - Approved by staff (reporter gets rewarded)
REJECTED - Denied by staff

🚀 Building from Source

If you want to compile the plugin yourself:

Clone the repository:

git clone https://github.com/yourusername/QuickReport.git
cd QuickReport

Build with Maven:
```
mvn clean package
```
Find the JAR file:
```
target/QuickReport-1.0.0.jar
```

🐛 Troubleshooting

Reports not saving

Check console for database connection errors
Ensure the plugin has write permissions to the plugins/QuickReport/ folder

Admin notifications not working

Verify the admin-permission in config.yml matches your permissions plugin
Check that the notification sound name is valid

PlaceholderAPI placeholders not working

Make sure PlaceholderAPI is installed and running
Use /papi parse me %quickreport_kabul_edilen% to test placeholders

📞 Support

For issues, suggestions, or contributions:

Issues: Open an issue on the GitHub repository
Wiki: Check the documentation for detailed guides
Discord: Join our community server (if available)

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.

🙏 Credits

Developer: Melut
Contributors: Community contributions welcome!

🇹🇷 Türkçe Açıklama

📋 Açıklama

QuickReport, Minecraft sunucuları için tasarlanmış güçlü ve kullanıcı dostu bir raporlama sistemidir. Oyuncuların hile yapanları, kural ihlallerini veya herhangi bir yanlış davranışı kolayca raporlamasını sağlarken, yöneticilere raporları verimli bir şekilde yönetme ve işleme araçları sunar.

🎮 Komutlar

Oyuncu Komutları

/report <oyuncu> <sebep> [detaylar] - Bir oyuncuyu raporla
/myreports [sayfa] - Gönderdiğiniz raporları görüntüle
/queryreport <id> - Belirli bir raporu sorgula

Admin Komutları

/reports [sayfa] - Bekleyen tüm raporları görüntüle
/reportaction <accept|reject> <id> [ödül-kodu|sebep] - Raporu kabul et veya reddet

⚙️ Yapılandırma

Rapor Sebeplerini Özelleştirme

config.yml dosyasındaki report-reasons listesini düzenleyerek geçerli sebepleri ekleyin veya kaldırın:

report-reasons:
  - "Hile"
  - "Exploit"
  - "Küfür"
  - "Dolandırıcılık"

🎁 Ödül Sistemi

Oyuncuların raporları kabul edildiğinde otomatik olarak ödüllendirin.

Yeni Ödül Ekleme

config.yml dosyasını açın
rewards bölümüne yeni ödül ekleyin:

rewards:
  ozel-odul:
    name: "&aÖzel Ödül"
    command: "give %player% diamond_block 1"

Raporu kabul ederken ödül kodunu kullanın:

/reportaction accept 123 ozel-odul

📊 PlaceholderAPI Desteği

Kullanılabilir Placeholderlar

%quickreport_kabul_edilen% - Oyuncunun kabul edilen rapor sayısı
%quickreport_reddedilen% - Oyuncunun reddedilen rapor sayısı
%quickreport_top_kabul_isim_<sıra>% - En çok kabul edilen rapor gönderen oyuncu
%quickreport_top_kabul_sayi_<sıra>% - En çok kabul edilen rapor sayısı
%quickreport_top_red_isim_<sıra>% - En çok reddedilen rapor gönderen oyuncu
%quickreport_top_red_sayi_<sıra>% - En çok reddedilen rapor sayısı

🌐 Çoklu Dil Desteği

QuickReport, kutusundan çıktığı gibi İngilizce ve Türkçe dil desteği sunar. messages.yml dosyasını düzenleyerek mesajları özelleştirebilirsiniz.

📖 Kullanım Örnekleri

Oyuncu İş Akışı

Rapor gönder:

/report Cheater123 Fly Spawn bölgesinde uçuyordu

Raporlarını kontrol et:
```
/myreports
```
Belirli bir raporu sorgula:
```
/queryreport 5
```

Admin İş Akışı

Bekleyen raporları görüntüle:
```
/reports
```
Bir rapora tıklayın veya şunu kullanın:
```
/queryreport 5
```
Raporu ödülle birlikte kabul et:
```
/reportaction accept 5 diamond-reward
```
Raporu sebep belirterek reddet:
```
/reportaction reject 5 Yetersiz kanıt
```

Made with ❤️ for the Minecraft community

Name		Name	Last commit message	Last commit date
Latest commit History 2 Commits
src/main		src/main
LICENSE		LICENSE
README.md		README.md
pom.xml		pom.xml

License

Lora-Technologies/QuickReport

Folders and files

Latest commit

History

Repository files navigation