![Warrant banner](https://logo-generator.bradenk04.workers.dev/banner.png?src=github&id=lotusplugins%2Fwarrant&c=eyJpY29uIjoiZ2F2ZWwiLCJpY29uU2V0IjoicGhvc3Bob3IiLCJpY29uVmFyaWFudCI6ImZpbGwiLCJpY29uU2l6ZSI6NTYsInNoYXBlIjoic3F1aXJjbGUiLCJwYXR0ZXJuIjoibWVzaCIsInN0b3BzIjpbeyJjb2xvciI6IiM3ZjFkMWQiLCJwb3MiOjB9LHsiY29sb3IiOiIjZGMyNjI2IiwicG9zIjo1MH0seyJjb2xvciI6IiNmYjkyM2MiLCJwb3MiOjEwMH1dLCJiZyI6WyIjMWYyOTM3IiwiIzBiMGYxNyJdLCJyaW5nIjpmYWxzZX0&stats=stars%2Cforks%2Cversion%2Clicense&title=Warrant&desc=Lightweight+Spigot+plugin+for+server+punishments%3A+bans%2C+mutes%2C+and+kicks.) **Simple and effective punishment plugin for Spigot / Paper servers.** Warn, kick, mute and ban players, permanently or for a set time, with a full history stored locally in H2. [![Discord](https://img.shields.io/badge/Discord-Join%20us-5865F2?logo=discord&logoColor=white)](https://discord.gg/qkr2jrX9jF)

--- ## Features - **Warnings, kicks, mutes and bans.** Mutes and bans can be permanent or temporary (`/tempmute`, `/tempban`). - **Punishment history.** Every punishment is recorded, including revoked and expired ones. - **Silent mode.** Add `-s` / `--silent` to any command so only staff with `warrant.notify` see the announcement. - **Offline targets.** Ban, mute or warn players who aren't online. Warnings are delivered the next time they join. - **Mute command blocking.** Muted players can't use private-message commands like `/msg`, `/tell` or `/r`. - **MiniMessage formatting.** Every message lives in a language file and can be restyled. - **Developer API.** Cancellable events fire whenever a punishment is issued or revoked. ![Ban screen preview](https://github.com/lotusplugins/warrant/blob/main/.github/assets/ban_screen_img.png?raw=true) ## Requirements | Component | Version | |-----------|---------------------| | Server | Spigot / Paper 26.2 | | Java | 25 or newer | ## Installation 1. Download the latest jar from the [releases page](https://github.com/lotusplugins/warrant/releases), or [build it yourself](#building-from-source). 2. Drop it into your server's `plugins/` folder. 3. Start the server. `config.yml`, `lang/en_US.yml` and the H2 database (`warrant.mv.db`) are created in `plugins/Warrant/`. ## Commands `` accepts online and offline players (except `/kick`, which needs an online player). `[reason]` is optional unless noted. Every command accepts `-s` / `--silent`. | Command | Description | Permission | |------------------------------------------|------------------------------------------------|---------------------------| | `/warn ` | Warn a player (reason required) | `warrant.warn` | | `/unwarn [id] [reason]` | Remove a warning (latest one if no ID is given) | `warrant.unwarn` | | `/kick [reason]` | Kick an online player | `warrant.kick` | | `/mute [reason]` | Permanently mute a player | `warrant.mute` | | `/tempmute [reason]` | Mute a player for a set time | `warrant.tempmute` | | `/unmute [reason]` | Lift an active mute | `warrant.unmute` | | `/ban [reason]` | Permanently ban a player | `warrant.ban` | | `/tempban [reason]` | Ban a player for a set time | `warrant.tempban` | | `/unban [reason]` | Lift an active ban | `warrant.unban` | | `/punish history ` | View a player's punishment history | `warrant.history` | ### Durations Durations combine a number with a unit: `s` (seconds), `m` (minutes), `h` (hours), `d` (days) and `w` (weeks). Units can be chained. ``` /tempban Steve 7d Griefing spawn /tempmute Alex 1h30m Spamming chat /ban Herobrine -s Ban evasion ``` ![Punishment history preview](https://github.com/lotusplugins/warrant/blob/main/.github/assets/punish_history_img.png?raw=true) ### Other permissions | Permission | Description | |----------------------|----------------------------------------------------------------| | `warrant.notify` | See announcements for silent punishments | | `warrant.exempt` | Can't be punished (server operators are always exempt) | ## Configuration ### `config.yml` ```yaml # Language file to load from plugins/Warrant/lang/ language: en_US mute: # Commands muted players are not allowed to use blocked-commands: - msg - tell - w - whisper - r - reply - me - teammsg ``` ### Messages All messages live in `lang/.yml` and use [MiniMessage](https://docs.advntr.dev/minimessage/format.html) formatting. Keys missing from a custom language file fall back to the bundled `en_US.yml`. ```yaml ban: announce: " was banned by for : " screen: "You are banned for " ``` | Placeholder | Meaning | |---------------|-------------------------------------------------| | `` | The punished player | | `` | The staff member (or console) issuing the action | | `` | The reason, or the `no-reason` message | | `` | The full punishment length | | `` | Time left on an active mute or ban | | `` | The punishment's unique ID | ![Chat announcement preview](https://github.com/lotusplugins/warrant/blob/main/.github/assets/chat_announcement_img.png?raw=true) ## Developer API Listen for `PlayerPunishedEvent` and `PlayerPunishmentRevokedEvent` to react to punishments, or cancel them before they're saved. ```java import com.lotusplugins.warrant.api.events.PlayerPunishedEvent; import com.lotusplugins.warrant.api.model.PunishmentType; import org.bukkit.event.EventHandler; import org.bukkit.event.Listener; public final class PunishmentLogger implements Listener { @EventHandler public void onPunish(PlayerPunishedEvent event) { var punishment = event.getPunishment(); if (punishment.type() == PunishmentType.BAN && punishment.reason() == null) { event.setCancelled(true); // require a reason for bans } } } ``` > [!NOTE] > Commands run asynchronously, so these events usually fire off the main thread. Don't touch the Bukkit world directly from your listener. ## Community Questions, feedback or just want to chat? Join our [Discord server](https://discord.gg/qkr2jrX9jF).

Warrant

1.0.0

0.0.1-rc.1