SpicyAzisaBan

# 🚫SpicyAzisaBan (https://img.shields.io/maven-metadata/v?metadataUrl=https%3A%2F%2Frepo.azisaba.net%2Frepository%2Fmaven-public%2Fnet%2Fazisaba%2Fspicyazisaban%2Fcommon%2Fmaven-metadata.xml)](https://repo.azisaba.net/#browse/browse:maven-public:net%2Fazisaba%2Fspicyazisaban%2Fcommon) ## 📖Description SpicyAzisaBan is an all-in-one punishment system for Velocity. (Heavily inspired by AdvancedBan) It supports various types of punishments, following are the types of punishments supported by SpicyAzisaBan: - Ban - Temp ban - IP ban - Temp IP ban - Mute - Temp mute - IP mute - Temp IP mute - Warning - Caution - Kick - Note SpicyAzisaBan also supports multiple servers (such as multiple instances of Velocity), so you can use it in a network environment. ## ✨Features - Ban, Mute, Warn, Caution, Kick, Note players - Discord webhook support - Support multiple instances of Velocity - Pre-defined reasons for each server/type of punishment - Customizable messages - Ban all alt accounts at once - Lockdown mode (prevent new players from joining the server) - Punishment automation via external API (see below for more information) ## ❗️Requirements - Java 17 or later - Internet connection (for fetching dependencies) - MySQL or MySQL-compatible (e.g. MariaDB) database - We recommend using supported versions of MariaDB ## 💻Installation 1. Download the plugin from (https://modrinth.com/plugin/spicyazisaban/versions) and place it in your server's `plugins` folder. 2. Start the server once to generate the configuration file. (Or you can just create the file manually) 3. Configure the plugin in `plugins/SpicyAzisaBan/config.yml`. 4. Restart the server. 5. Do `/sab info` to see if the plugin is working correctly. ## 📝Configuration ```yml # SpicyAzisaBan config # # Important: If you are running from CLI, you only need to configure database settings, and you can just ignore # anything else. # Command prefix # ---------- # You will be able to run command with: /${prefix}command # So if you set this to "/", you can run command with //command prefix: "" # Database settings # ---------- # MySQL or MySQL-compatible (e.g. MariaDB) database is required to run SpicyAzisaBan. database: host: localhost name: spicyazisaban user: spicyazisaban password: p@55w0rd verifyServerCertificate: false useSSL: true # If true, the plugin will prevent players from joining the server if database is inaccessible. failsafe: true warning: # Don't set to 1s, it's too terrible because we fetch the punishments from database every time we check for warnings sendTitleEvery: 10s titleStayTime: 5s # These settings below are reloadable by doing /sab reload serverNames: # "server" (key) must not contain UPPERCASE character. server: FriendlyServerName defaultReasons: # valid types: ban, temp_ban, ip_ban, temp_ip_ban, mute, temp_mute, ip_mute, temp_ip_mute, warning, caution, kick, note # invalid types are ignored ban: # <server/group/global>: reasons list global: - "ban reason (global) 1" - "ban reason (global) 2" lobby: - "ban reason (lobby) 1" - "ban reason (lobby) 2" # a player wouldn't be able to bypass with eg /minecraft:tell blockedCommandsWhenMuted: # server: Array<String> # "global" would affect all servers global: - tell - r - me life: - rpc - me banOnWarning: # if warning count hits 3, 4, 5..., the player would be banned with specified reason # this feature will be disabled if you set this value to <= 0 threshold: 3 time: "1mo" # Available variables: %PREFIX%, %COUNT& (current warnings count), %TIME% (above), %ORIGINAL_REASON% (reason used for /warn) reason: "You've got %COUNT% warnings and you've been banned for %TIME%. (Original reason: %ORIGINAL_REASON%)" customBannedMessage: # usually configured via messages.yml, but you can set the message per server here # key = server # value = message rpg: - "&cA player has been deleted from the server." # Discord webhook URLs # If you don't need this feature, simply uncomment the line below. #webhookURLs: { __fallback__: {} } # and comment out the lines below. webhookURLs: __fallback__: default: "https://discord.com/api/webhooks/123456/secret" server1: default: "https://discord.com/api/webhooks/123456/secret" global: default: "https://discord.com/api/webhooks/123456/secret" ban: "https://discord.com/api/webhooks/789012/secret" ``` ## Non-exhaustive list of permissions We recommend using (https://luckperms.net) for permission management. - `sab.command.spicyazisaban` - `sab.command.spicyazisaban.creategroup` - `sab.command.spicyazisaban.deletegroup` - `sab.command.spicyazisaban.group` - `sab.command.spicyazisaban.info` - `sab.command.spicyazisaban.debug` - `sab.command.spicyazisaban.reload` - `sab.command.spicyazisaban.deletepunishmenthistory` - `sab.command.spicyazisaban.deletepunishment` - `sab.command.spicya