QuickReport

QuickReport

A quick and efficient reporting system for Minecraft servers

Minecraft Version

---

📋 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

- PlaceholderAPI Integration - Players can report others with a simple command - PlaceholderAPI Integration - Accept or reject reports with customizable rewards - PlaceholderAPI Integration - Players can view their submitted reports - PlaceholderAPI Integration - Detailed report information for staff members - PlaceholderAPI Integration - Prevents spam with configurable cooldown timers - PlaceholderAPI Integration - Interactive admin notifications with click-to-view functionality - PlaceholderAPI Integration - Lightweight and efficient data storage - PlaceholderAPI Integration - Automatically reward players for accepted reports - PlaceholderAPI Integration - Built-in English and Turkish language support - PlaceholderAPI Integration - Statistics and leaderboard placeholders

---

📥 Installation

1. Download the latest `QuickReport-1.0.0.jar` from the releases page 2. Place the JAR file in your server's `plugins` folder 3. Restart your server or use a plugin manager to load it 4. Configure the plugin by editing `config.yml` and `messages.yml` in the `plugins/QuickReport/` folder 5. 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

```yaml

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:

```yaml 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

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

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

3. 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

```yaml

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:

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

Adding a New Language

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

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

---

📖 Usage Examples

Player Workflow

1. Submit a report: ``` /report Cheater123 Fly He was flying in spawn ```

2. Check your reports: ``` /myreports ```

3. Query a specific report: ``` /queryreport 5 ```

Admin Workflow

1. View pending reports: ``` /reports ```

2. Click on a report or use: ``` /queryreport 5 ```

3. Accept a report with reward: ``` /reportaction accept 5 diamond-reward ```

4. Reject a report with reason: ``` /reportaction reject 5 Insufficient evidence ```

---

🔄 Report Status

Reports can have three statuses:

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

- Developer: Melut