# Developer Platform

<h2 align="center">The ultimate Reports plugin</h2>

<p align="center">with cross-server and Discord support.</p>

<p align="center"></p>

<p align="center"><a href="https://ultimatereports.gitbook.io/ultimatereports-docs/documentation" class="button primary">Setup the plugin</a></p>

<p align="center"></p>

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td><h4>⚡</h4></td><td><h4>Reports GUI</h4></td><td>This is the paginated GUI with all the reports</td><td><a href="https://modrinth.com/plugin/ultimate-reports">https://modrinth.com/plugin/ultimate-reports</a></td><td><a href="https://955299177-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAyMUVWE8xmqerAuo5vXi%2Fuploads%2FiloYNizbKuccdDcSQxQC%2Fimage_2025-11-27_185729832.png?alt=media&#x26;token=6dbdf475-ba93-4f6c-a206-f9fb3a3057c9">image_2025-11-27_185729832.png</a></td></tr><tr><td><h4><i class="fa-server">:server:</i></h4></td><td><strong>Logging</strong></td><td>Staffers and the reporter gets notified when a report is submitted/modified</td><td><a href="https://modrinth.com/plugin/ultimate-reports">https://modrinth.com/plugin/ultimate-reports</a></td><td><a href="https://955299177-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAyMUVWE8xmqerAuo5vXi%2Fuploads%2FDTkuV1Ffu3xfHt8RZ0vr%2Fimage_2025-11-27_190305076.png?alt=media&#x26;token=4c504bb2-acef-4cb2-b01c-2925b0c23759">image_2025-11-27_190305076.png</a></td></tr><tr><td><h4>>_ </h4></td><td><strong>Discord</strong></td><td>Reports can be fully managed from Discord</td><td><a href="https://modrinth.com/plugin/ultimate-reports">https://modrinth.com/plugin/ultimate-reports</a></td><td><a href="https://955299177-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAyMUVWE8xmqerAuo5vXi%2Fuploads%2FyxkzvcgAdvEBKMNtwhsZ%2Fimage_2025-11-27_185830436.png?alt=media&#x26;token=d4e9a5e2-fb80-4282-acaa-e3e95c00e162">image_2025-11-27_185830436.png</a></td></tr></tbody></table>

[Check the Images Gallery for more previews!](https://modrinth.com/plugin/ultimate-reports/gallery)

### Download

Ultimate Reports can be downloaded from Modrinth:\
[https://modrinth.com/plugin/ultimate-reports](https://modrinth.com/plugin/ultimate-reports/)

### 🚀 Key Features

#### 🌐 Cross-Server Synchronization (Bungee/Velocity)

The plugin synchronizes data in real-time between proxied servers. Using **MySQL/MariaDB** and a message broker, your moderation team can handle reports from any server in the network.

<br>

#### 💬 Advanced Discord Integration

Bring your moderation to Discord. You can configure UltimateReports to:

* Send simple **Webhooks** for new reports.
* Run a full **Discord Bot** to manage, claim, and update reports directly from your Discord server.

<br>

#### ⚡ Optimized Performance

Written from scratch to be lightweight. We support extensive database options with async connections:

* **H2** (Default, preferred over SQLite)
* **MariaDB** (Recommended for performance)
* MySQL, PostgreSQL, and SQLite.

<br>

### 🛠️ Moderation Tools

* **Interactive GUIs:** View, manage, and resolve reports entirely in-game via a clean inventory interface.
* **Minecraft Dialogs:** Utilizes the new chat signing/dialog features for supported versions.
* **Reward System:** Encourage community reporting by configuring rewards for players who submit valid reports.
* **Punishment System:** Prevent spam by putting players on cooldown if they abuse the report command.
* **PlaceholderAPI Support:** Integrated placeholders available out of the box.
* **Full Customization:** Every message and setting is configurable in the `config.yml`.

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h4>⚡</h4></td><td><h4>Setup</h4></td><td>How to setup the plugin</td><td><a href="https://ultimatereports.gitbook.io/ultimatereports-docs/documentation">https://ultimatereports.gitbook.io/ultimatereports-docs/documentation</a></td></tr><tr><td><h4><i class="fa-server">:server:</i></h4></td><td><strong>Source code</strong></td><td>Learn how the plugin works.</td><td><a href="https://github.com/xF3d33/UltimateReports">https://github.com/xF3d33/UltimateReports</a></td></tr><tr><td><h4><i class="fa-terminal">:terminal:</i></h4></td><td><strong>API</strong></td><td>Create an addon for this plugin</td><td><a href="https://app.gitbook.com/o/Ad6dKKwYw76kQmDn1uRJ/s/blVaQehXvarICvVuGPJy/">API Reference</a></td></tr></tbody></table>

<h2 align="center">For any issue or feature request</h2>

<p align="center">Open a new issue on GitHub</p>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://ultimatereports.gitbook.io/ultimatereports-docs/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.