MINECRAFTBIBLE
Loading...
An all-in-one punishment system
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:
SpicyAzisaBan also supports multiple servers (such as multiple instances of Velocity), so you can use it in a network environment.
plugins folder.plugins/SpicyAzisaBan/config.yml./sab info to see if the plugin is working correctly.# 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"
We recommend using LuckPerms for permission management.
sab.command.spicyazisabansab.command.spicyazisaban.creategroupsab.command.spicyazisaban.deletegroupsab.command.spicyazisaban.groupsab.command.spicyazisaban.infosab.command.spicyazisaban.debugsab.command.spicyazisaban.reloadsab.command.spicyazisaban.deletepunishmenthistorysab.command.spicyazisaban.deletepunishmentsab.command.spicyazisaban.linksab.command.spicyazisaban.unlinksab.checksab.historysab.seensab.banlistsab.proofssab.delproofsab.addproofsab.changereasonsab.unbansab.unmutesab.unpunishsab.punish.globalsab.punish.group.<groupName>sab.punish.server.<serverName>sab.ban.permsab.ban.tempsab.ipban.permsab.ipban.tempsab.mute.permsab.mute.tempsab.ipmute.permsab.ipmute.tempsab.warningsab.cautionsab.kicksab.notesab.notify.bansab.notify.tempbansab.notify.ipbansab.notify.tempipbansab.notify.mutesab.notify.tempmutesab.notify.ipmutesab.notify.tempipmutesab.notify.warnsab.notify.cautionsab.notify.kicksab.notify.notesab.exempt.mutesab.exempt.temp_mutesab.exempt.ip_mutesab.exempt.temp_ip_muteUnfortunately, SpicyAzisaBan itself does not provide helpful APIs for developers to use. (There are a lot of internal APIs that are not intended to be used by other plugins.)
If you do rely on internal API, you should be aware that it may change without notice.
If you need to automate the punishment system (but not unpunish) from backend Spigot/Paper server, you can use the API provided by AziPluginMessaging.
This is one of our internal plugins, but we provide the API for developers who want to use it.
You need to install the plugin on both the backend (Spigot/Paper) server and the proxy (Velocity) server.
You can see the example of using the API in PunishCommand.java.
Support is provided via our Discord server.
This project is licensed under the GNU General Public License v3.0.