ChickReport

ChickReport is the advanced solution for Minecraft server report plugins, supporting all versions from 1.8 to 1.21 and Folia, with fully configurable GUIs, admin handling tools, and PlaceholderAPI integration. It allows players to report others through an intuitive GUI or direct command, while giving server staff powerful tools to manage and resolve reports efficiently.

---

Features

• Multi‑version compatibility – Runs on Spigot, Paper, Purpur, Folia (1.8 – 1.21) using automatic version detection. No external dependencies required.
• Fully configurable GUIs – Every menu (main, reasons, admin, admin-handle) is defined in YAML files under menu/. Icons, names, lore, and slots can be customised freely. Supports both 1.13+ material names and legacy data values (e.g. WOOL:3).
• Preset & custom report reasons – Preset reasons come with individual icons, display names and lore. Each reason can optionally have a report-reason text that gets stored separately from the display name. Players can also submit a custom reason via chat (the chat event is automatically cancelled and the message captured for the report).
• Admin report management – Staff with chickreport.admin permission can open the admin GUI (/chickreport reports) to see all pending reports with timestamp, world, reason and source server (cross‑server mode). Three actions are available:
  • Ban Permanently – Executes the /ban command with a configurable reason (ban-reason in config.yml) and marks the report as handled.
  • Ignore & Delete – Permanently deletes the report from storage, freeing the reporter’s slot.
  • Teleport to Player – Instantly teleports the admin to the reported player for investigation.
• World‑aware reporting – Each report records the world of the reported player. The %world% placeholder is available in admin notifications and GUI lore. The player‑selection GUI can be configured to show only players in the current world or all online players (player-list-scope in config.yml).
• Smart cooldown system – Players can have a limited number of active (pending) reports simultaneously (max-active-reports in config.yml). Reporting yourself or the same target twice before the previous report is handled is blocked.
• Fully customisable messages – All plugin messages are stored in messages.yml and support & colour codes. Internal placeholders (%reporter%, %reported%, %reason%, %world%, %server%) are replaced automatically. The help command displays a multi‑line message from the configuration.
• PlaceholderAPI expansion – Provides the following placeholders:
  • %chickreport_active_count% – pending reports submitted by the player
  • %chickreport_total_reports% – total reports ever submitted by the player
  • %chickreport_reported_count% – total times the player has been reported
  • %chickreport_reported% – name of the last player this player reported
  • %chickreport_reporter% – name of the player who last reported this player
  • %chickreport_server% – current server name (cross‑server enabled) or “local”
• Cross‑server support – When enabled in config.yml, report data is forwarded through BungeeCord / Velocity plugin messaging. Staff can see reports from all connected servers and the source server is shown in the admin GUI.
• bStats metrics – Anonymous usage statistics are collected using the official bStats integration (plugin ID 32236). Server owners can opt out via the bStats global configuration.
• Debug mode – Optional debug: true in config.yml provides detailed console logs for report submissions, admin actions, and data operations.
• Update checker placeholder – /chickreport update command (permission chickreport.update, default OP) currently shows a placeholder message; a full update checker will be introduced in a future version.
• Clean YAML storage – Report data is stored in reports.yml with a human‑readable format. Data is automatically saved and loaded on reload.

---

Commands

Command	Aliases	Permission	Description
/chickreport	/report, /crp	chickreport.report	Opens the player selection GUI for reporting.
/chickreport report <player>	/report <player>, /crp report <player>	chickreport.report	Directly opens the reason selection GUI for the specified player.
/chickreport reports	/crp reports	chickreport.admin	Opens the admin GUI listing all pending reports.
/chickreport reload	/crp reload	chickreport.reload	Reloads configuration, messages and menu files.
/chickreport update	/crp update	chickreport.update	Checks for plugin updates (currently placeholder).
/chickreport help	/crp help	chickreport.help	Shows the help message from messages.yml.

---

Permissions

Permission	Default	Description
chickreport.report	true	Allows a player to open the report GUI and submit reports.
chickreport.help	true	Allows viewing the help command.
chickreport.admin	op	Allows opening the admin reports GUI and handling reports.
chickreport.reload	op	Allows reloading the plugin configuration.
chickreport.update	op	Allows using the update check command.

---

Configuration

The main configuration file is config.yml. Key options:

• prefix – Plugin prefix shown before most messages (supports & colour codes). Default: "&8[&eChickReport&8] "
• max-active-reports – Maximum pending reports per player. Default: 3
• ban-reason – Reason used when banning via the admin GUI. Default: "By admin report"
• player-list-scope – Whether the report GUI shows players from the current world (world) or the entire server (server). Default: world
• debug – Enables detailed console logging when set to true. Default: false
• check-update – Enables update checking (currently placeholder). Default: true
• cross-server.enabled – Enable cross‑server messaging (BungeeCord / Velocity). Default: false
• cross-server.broadcast-to-all – If enabled, report notifications are sent to all servers, otherwise only to the reporter’s current server. Default: false

Messages are customised in messages.yml. All messages support & colour codes and can contain internal placeholders.

GUI menus are configured in the menu/ folder:

• main.yml – Player selection GUI
• reasons.yml – Reason selection GUI (preset reasons + custom)
• admin.yml – Admin pending reports GUI
• admin-handle.yml – Admin handling GUI (ban / ignore & delete / teleport)

---

Cross‑Server Setup

1. Set cross-server.enabled: true in each server’s config.yml.
2. Ensure the same version of ChickReport is installed on all servers and the proxy.
3. No additional proxy configuration is needed—the plugin uses the “BungeeCord” plugin channel to forward reports.
4. Placeholders like %chickreport_server% will reflect the source server name.

---

PlaceholderAPI

After installing ChickReport and PlaceholderAPI, the expansion registers automatically. All placeholders are prefixed with %chickreport_ and can be used in chat, scoreboards, holograms, etc.

---

Support & Compatibility

• Supported server software: Spigot, Paper, Purpur, Folia (1.8 – 1.21)
• Proxy support: BungeeCord, Velocity
• Dependencies: PlaceholderAPI (optional, for placeholders)
• bStats: Plugin ID 32236

Stats:

ChickReport is the advanced solution for Minecraft server report plugins.