BetterBanSystem Plugin

Welcome to the BetterBanSystem plugin! It was never easier to ban, mute or warn a user

Installation

1. Download the Plug-In latest version from SpigotMC or of the release tab from Github.
2. After downloading, move the Plug-In into your plugins folder of your Minecraft Server.
3. If you already downloaded a version, make sure to delete the old release file.
4. Restart your server.
5. After restarting the server, you can edit the config.yml file inside the generated Directory: plugins/BetterBanSystem/

Report Issues ⚠️

Have you found a bug, a vulnerability, or have some other issues? Join our discord MCDevStudios and create a ticket.

How to use

After the installation the Plug-In will create the basic config.yml File and the default language file inside plugins/BetterBanSystem/languages/ The default config will look like this:

Config Explanation

Chat settings

You can set your own Prefix for every Message. Simply edit the line chat.prefix to what you want. If you don't want to print the prefix, simply edit the chat.prefix line to "none" or just leave it blank like ""

How to use the database tag?

If you want to use a Database for the bans,mutes and warns you can simply change the database.type to MYSQL, SQLITE or MONGODB If you want to see some examples for the specific database configuration, open the summarys

AutoMod

Here you can find some AutoMod "modules" which you can enable or disable like you want. Even if you don't want to use the AutoMod system at all, simply change automod.use from true to false. Inside the modules path you can find all modules this plug-in provides. (Currently for version 1.0 only the Chat module). You can enable or disable the modules on its own. Just change the true value to false.

The "action" Tag

The action tag defines what action the AutoMod should take for the specific module.


Every action is seperated with an ; so it's quite simple to add more actions. You can add an !(number) to every action like DELETE!4. This tells the AutoMod system that the Player has to execute the specific module four times before the execution. The WARN, INSTANTBAN, MUTE and TIMEBAN actions having some more parameters they need. So the MUTE action needs the reason and the duration parameters. For example: "MUTE:reason=Stop spamming:duration=5min" So the Plug-In will execute the MUTE action which simply mutes the user for "5 minutes" and for the reason "Stop Spamming"

The Chat Modules

!NOTE! For the Chat Modules the standard action is DELETE. So the message will not be printed inside the chat if no action Tags are defined.

Examples

Chat modules

This module checks if the player sends a big amount of messages in a certain time (4 seconds). With the maxMessages value you set the amount of messages the player needs to send in 4 seconds, then he gets firstly warned before the given actions will be taken.

This module checks if the player sends 2 messages with the exact same content

This module checks if the sended player message is written in only CapsLock or the complete content of the message contains more than 70% uppercase letters.

This module checks if the sended player message contains a link.

This module checks if the sended player message contains bad words from the badWordList.

If replaceWords is set to true the message will not be blocked, its just refactoring the given words into *. If it's set to false, the message will be blocked by default. (if no action tag is set.)

Warn Settings


Here you can set if player warns should be deleted after a certain time. (Like now after 60 Minutes 1 warn gets removed after the creation) The "actions" are quite simple. After 3 warns the "mute" commands is getting executed or which command you like. Note that "%p" stands for the player name. Currently for 3 warns an action is executing and for 5 warns. You can add more actions by simply adding more lines with the same schema.

Permissions

Permission Handling

The Plug-In itself checks the player permissions over the given PermissionManager. By default its "SPIGOT" for the default Spigot Permissions Handling. If you have a PermissionSystem on your server, you can change the config.yml tag permissions.system to the following:

• SPIGOT
  • for the default permission handling given from the Spigot API.
    • !NOTE! From the Spigot API its only available to check the player permissions if the player is online!
• LUCKPERMS
  • or the LuckPerms permission handling.
    • !NOTE! You have to run LuckPerms on your server!
• VAULT
  • for the Vault permission handling
    • !NOTE! You have to run Vault on your server!
• BUNGEECORD
  • for the default permission handling given from the BungeeCord API.
    • !NOTE! From the BungeeCord API its only available to check the player permissions if the player is online!
• CLOUDNET
  • for the CloudNet permissions handling
    • !NOTE! You have to run CloudNet with the CloudNet-Permissions Module!

If the Plug-In cannot find one of the given permission systems its using the default permission system given from the runtime of the server (spigot or bungeecord) Should the problem appear that the Plug-In cannot find ANY System not even the default from Spigot / BungeeCord it's returning for all players that he has no permissions for safety reasons.

Plug-In Permissions

Here is a list of all Permissions this Plug-In provides. Every permission starts with betterbansystem.

How to exempt a Player from Bans, Warns or Mutes

Add a Player or IP-Address to the config

To exempt a player from bans, warns or mutes is quite simple. You can simply add the players name inside the config.yml to the exempted-players list to exempt the Player from bans or you add the players name to the exempted-mute-players or exempted-warns-players list to exempt the player from mutes / warns. You can also add an IP-Address to the exempted-ips list to exempt a specific IP-Address from bans.
NOTE! You can ban, warn, mute and ban an IP address over the console, even if the name or the ip address is inside one of the lists.

Add the Permission to a Player or an IP-Address.

You can also use one of the Exempt Permissions to exempt a Player from warns, bans mutes.
NOTE! If a player has the betterbansystem.exempt.ban permission he can get IP-Banned. To add an IP-Address to the exempted list exempted-ips.