Web Analytics

PunishmentGUI - LiteBansGUI & AdvancedBanGUI

PunishmentGUI Wiki

PunishmentGUI Overview

Thank you for checking out the PunishmentGUI wiki page! 


PunishmentGUI is the combination of both LiteBansGUI & AdvancedBanGUI, but it also supports any punishment plugins which uses commands.

 

FAQ

https://wiki.bghddevelopment.com/books/punishmentgui---litebansgui-advancedbangui/page/faq

Default Config Files

In case you have made a mistake when editing your config files, we have provided the default files here. 

config.yml

#Created by BGHDDevelopment(Noodles)
#Discord/Support: https://bghddevelopment.com/discord
#Plugin Link: https://www.spigotmc.org/resources/52072/
#Website: https://bghddevelopment.com
#Wiki: https://wiki.bghddevelopment.com/books/punishmentgui---litebansgui-advancedbangui
#Ideas/Feedback: https://feedback.bghddevelopment.com/
#=======================================================
#Permssion: punishmentgui.update
Update:
  Enabled: true
#Enables if there is a message on-join when the plugin is outdated.
#=======================================================
CheckForUpdates:
  Enabled: true
#Enables a message in console if the plugin is outdated.
#=======================================================
SilentStart:
  Enabled: false
#Removes startup messages.
#=======================================================
#Commands & Permissions:
#/punish (playername) - punish.use
#=======================================================
#Main Command Messages:
Prefix: "&8Punish &7>> "
NoMessage: "&cInvalid! Use like /punish (player)!"
NoPermission: "&c(!) You don't have permission to use this command!"
NoPlayer: "Only players can use this command!"
NameLength: "&cThis name is too long! You can only enter 16 characters!"
#=======================================================
InventoryName: "&c&lPunishments"

guicommands.yml

#Welcome to the commands.yml file, feel free to change the commands around for each item. Reasons can be changed in the banreason.yml file.
#For support please contact us on discord: https://bghddevelopment.com/discord
#=======================================================
#Placeholders:
#%target% - Player you are punishing
#%t% - Time
#%reason% - Punish reason
#=======================================================

#Default config is for LiteBans, feel free to change it to your punishment plugin!
#AdvancedBanGUI template: https://wiki.bghddevelopment.com/books/punishmentgui---litebansgui-advancedbangui/page/advancedbangui-template

#Perm Mute
PermMuteCommand: "/mute %target% %reason% -s"

#IPMute
IPMuteCommand: "/ipmute %target% %reason% -s"

#Perm Ban
PermBanCommand: "/ban %target% %reason% -s"

#IPBan
IPBanCommand: "/ipban %target% %reason% -s"

#Serv 1 Mute
Severity1MuteCommand: "/mute %target% %t% %reason% -s"

#Serv 2 Mute
Severity2MuteCommand: "/mute %target% %t% %reason% -s"

#Serv 3 Mute
Severity3MuteCommand: "/mute %target% %t% %reason% -s"

#Serv 1 General Ban
Severity1GeneralBanCommand: "/ban %target% %t% %reason% -s"

#Serv 1 Client Ban
Severity1ClientBanCommand: "/ban %target% %t% %reason% -s"

#Serv 2 Client Ban
Severity2ClientBanCommand: "/ban %target% %t% %reason% -s"

#Serv 3 Client Ban
Severity3ClientBanCommand: "/ban %target% %t% %reason% -s"

#Warm
WarnCommand: "/warn %target% %reason% -s"

guiitems.yml

#In this file you can change all lore, names and items for the GUI.
#Please use this list for the item names: https://www.digminecraft.com/lists/item_id_list_pc_1_8.php
#=======================================================


#Sections:

#ClientModOffenses:
ClientModOffensesItem: "IRON_SWORD"
ClientModOffensesLocation: 14
ClientModOffensesName: "&a&lClient Mod Offenses"
ClientModOffensesLore: 
  - '&7X-ray, Forcefield, Speed, Fly, Inventory Hacks, etc'

#GeneralOffenses:
GeneralOffensesItem: "HOPPER"
GeneralOffensesLocation: 12
GeneralOffensesName: "&a&lGeneral Offenses"
GeneralOffensesLore:
  - '&7Command/Map/Class/Skill exploits, etc'

#ChatOffenses:
ChatOffensesItem: "BOOK_AND_QUILL"
ChatOffensesLocation: 10
ChatOffensesName: "&a&lChat Offenses"
ChatOffensesLore: 
  - '&7Verbal Abuse, Spam, Harassment, Trolling, etc'



#Other Punishments:

#Warning:
WarningItem: "ANVIL"
WarningLocation: 43
WarningName: "&a&lWarning"
WarningLore:
  - ' '
  - '&7Example Warning Input:'
  - '&fSpam - Repeatedly writing MEOW'
  - '&fHack Accusation - Accused Tomp13 of hacking'
  - '&fTrolling - was trying to make bob angry in chat '
  - ' '

#ChatPunishments:

#PermMute:
PermanentMuteItem: "PAPER"
PermanentMuteLocation: 25
PermanentMuteName: "&a&lPermanent Mute"
PermanentMuteLore:
  - '&fMute Duration: &ePermanent'
  - ' '
  - '&7Severe Advertising'
  - '&fJOIN MINECADE! THIS SERVER IS TRASH'
  - ' '
  - '&7Other Severe Offense'
  - '&fDDOS Threats/Death Threats ETC'
  - ' '

#Severity1Mute:
Severity1MuteItem: "INK_SACK"
Severity1MuteLocation: 19
Severity1MuteName: "&a&lSeverity 1"
Severity1MuteLore:
  - '&fMute Duration: &e1 Hour'
  - ' '
  - '&7Light Spam'
  - '&fSending the same message 2-5 times'
  - ' '
  - '&7Light Advertising'
  - '&fanyone want to play on minecade?'
  - ' ' 
  - '&7Light Abuse/Harassment'
  - '&fyou are so bad at this game'
  - ' '
  - '&7Hackusations'
  - '&fyoure such a hacker!'
  - ' '

#Severity2Mute:
Severity2MuteItem: "INK_SACK"
Severity2MuteLocation: 28
Severity2MuteName: "&a&lSeverity 2"
Severity2MuteLore: 
  - '&fMute Duration: &e1 Week'
  - ' '
  - '&7Medium Spam'
  - '&fSending the same message 6-20 times'
  - ' '
  - '&7Medium Advertising'
  - '&fjoin trash.server.net'
  - ' ' 
  - '&7Medium Abuse/Harassment'
  - '&fyoure terrible, learn to play'
  - '&ftrash off you stupid newb'
  - ' '
  - '&7Avoiding Chat Filter'
  - '&f|_|<S YOU'
  - ' '

#Severity3Mute:
Severity3MuteItem: "INK_SACK"
Severity3MuteLocation: 37
Severity3MuteName: "&a&lSeverity 3"
Severity3MuteLore: 
  - '&fMute Duration: &e1 Month'
  - ' '
  - '&7Severe Spam'
  - '&fSending the same message 20+ times'
  - '&fSpam Bot'
  - ' '
  - '&7Severe Abuse/Harassment'
  - '&fGO DIE'
  - ' '

#ClientPunishments:

#PermBan:
PermanentBanItem: "REDSTONE_BLOCK"
PermanentBanLocation: 34
PermanentBanName: "&a&lPermanent Ban"
PermanentBanLore:
  - '&fBan Duration: &ePermanent'
  - ' '
  - '&7Severe Threats'
  - '&fKILL THEM ALL WERE GOING TO HACK THE SERVER'
  - ' '
  
#Severity1GeneralBan:
Severity1GeneralBanItem: "INK_SACK"
Severity1GeneralBanLocation: 21
Severity1GeneralBanName: "&a&lSeverity 1"
Severity1GeneralBanLore:
  - '&fBan Duration: &e1 Hour'
  - ' '
  - '&7Team Killing'
  - '&fIntentionally killing your team'
  - ' '
  - '&7Trolling (Gameplay)'
  - '&fUsing abilities to trap players in spawn'
  - ' ' 
  - '&7Map/Bug Exploiting'
  - '&fAbusing an exploit to gain an advantage'
  - ' '

#Severity1ClientBan:
Severity1ClientBanItem: "INK_SACK"
Severity1ClientBanLocation: 23
Severity1ClientBanName: "&a&lSeverity 1"
Severity1ClientBanLore:
  - '&fBan Duration: &e1 Day'
  - ' '
  - '&7Examples'
  - '&fDamage Indicators'
  - '&fPlayer Radar'
  - ' '

#Severity2ClientBan:
Severity2ClientBanItem: "INK_SACK"
Severity2ClientBanLocation: 32
Severity2ClientBanName: "&a&lSeverity 2"
Severity2ClientBanLore:
  - '&fBan Duration: &e1 Week'
  - ' '
  - '&7Examples'
  - '&fForcefield'
  - '&fSpeed Hack'
  - '&fReach Hack'
  - '&fOther Hack'
  - '&cFirst Offense Only!'
  - ' '

#Severity3ClientBan:
Severity3ClientBanItem: "INK_SACK"
Severity3ClientBanLocation: 41
Severity3ClientBanName: "&a&lSeverity 3"
Severity3ClientBanLore:
  - '&fBan Duration: &e1 Month'
  - ' '
  - '&7Examples'
  - '&fForcefield'
  - '&fSpeed Hack'
  - '&fReach Hack'
  - '&fFly Hack'
  - '&fOther Hack'
  - '&cAlso for second offenders!'
  - ' '

#IPMute:
IPMuteItem: "TNT"
IPMuteLocation: 7
IPMuteName: "&a&lIP Mute"
IPMuteLore:
- '&fMute Duration: &eIP MUTE'
- ' '
- ' '
#IPBan:
IPBanItem: "TNT"
IPBanLocation: 8
IPBanName: "&a&lIP BAN"
IPBanLore:
- '&fBan Duration: &eIP BAN'
- ' '
- ' '
  

banreason.yml

#Reasons and times for all bans in the GUI
#All times should be in your punishment plugins format!
#LiteBans & Advanced Ban Example: 1w (1 week), 5y (5 years), 1h (1 hour), etc.
#=======================================================  


#Warning:
WarnMessage: "&7Warned %player% Spam/Swearing/Hack Accusation/Trolling"
WarnReason: "Spam/Swearing/Hack Accusation/Trolling"

#PermMute:
PermMuteMessage: "&7Muted %player% forever for Severe Advertising!"
PermMuteReason: "Severe Advertising"

#Severity1Mute:
Severity1MuteMessage: "&7Muted %player% for 1h for Hackusations/Light Abuse/Harassment/Light Advertising/Light Spam!"
Severity1MuteReason: "Hackusations/Light Abuse/Harassment/Light Advertising/Light Spam"
Severity1MuteTime: "1h"

#Severity2Mute:
Severity2MuteMessage: "&7Muted %player% for 1w for Medium Spam/Medium Advertising/Medium Abuse/Harassment/Avoiding Chat Filter!"
Severity2MuteReason: "Medium Spam/Medium Advertising/Medium Abuse/Harassment/Avoiding Chat Filter"
Severity2MuteTime: "1w"

#Severity3Mute:
Severity3MuteMessage: "&7Muted %player% for 1m for Severe Spam/Severe Abuse/Harassment!"
Severity3MuteReason: "Severe Spam/Severe Abuse/Harassment"
Severity3MuteTime: "1m"

#PermBan:
PermBanMessage: "&7Banned %player% forever for Permanent Ban!"
PermBanReason: "Permanent Ban"

#Severity1GeneralBan:
Severity1GeneralBanMessage: "&7Banned %player% for 1h for Team Killing/Trolling (Gameplay)/Map/Bug Exploiting!"
Severity1GeneralBanReason: "Team Killing/Trolling (Gameplay)/Map/Bug Exploiting"
Severity1GeneralBanTime: "1h"

#Severity1ClientBan:
Severity1ClientBanMessage: "&7Banned %player% for 1d for Player Radar/Damage Indicators!"
Severity1ClientBanReason: "Player Radar/Damage Indicators"
Severity1ClientBanTime: "1d"

#Severity2ClientBan:
Severity2ClientBanMessage: "&7Banned %player% for 1w for Forcefield/Speed Hack/Reach Hack/Other Hack - First Offense!"
Severity2ClientBanReason: "Forcefield/Speed Hack/Reach Hack/Other Hack - First Offense"
Severity2ClientBanTime: "1w"

#Severity3ClientBan:
Severity3ClientBanMessage: "&7Banned %player% for 1 month for Fly Hack/Forcefield/Speed Hack/Reach Hack/Other Hack - Also for second offenders!"
Severity3ClientBanReason: "Fly Hack/Forcefield/Speed Hack/Reach Hack/Other Hack"
Severity3ClientBanTime: "30d"

#IPBAN:
IPBanMessage: "&7Banned %player% for 1 month for Fly Hack/Forcefield/Speed Hack/Reach Hack/Other Hack - Also for second offenders!"
IPBanReason: "IPBAN - Network Ban"

#IPMUTE:
IPMuteMessage: "&7Muted %player% for 1 month for repeated chat offences - Also for second offenders!"
IPMuteReason: "IPMUTE - Network Mute"

LiteBansGUI Template

Here is a premade guicommands.yml for LiteBans!

#Welcome to the commands.yml file, feel free to change the commands around for each item. Reasons can be changed in the banreason.yml file.
#For support please contact us on discord: https://bghddevelopment.com/discord
#=======================================================
#Placeholders:
#%target% - Player you are punishing
#%t% - Time
#%reason% - Punish reason
#=======================================================

#Default config is for LiteBans, feel free to change it to your punishment plugin!
#AdvancedBanGUI template: https://wiki.bghddevelopment.com/books/punishmentgui---litebansgui-advancedbangui/page/advancedbangui-template

#Perm Mute
PermMuteCommand: "/mute %target% %reason% -s"

#IPMute
IPMuteCommand: "/ipmute %target% %reason% -s"

#Perm Ban
PermBanCommand: "/ban %target% %reason% -s"

#IPBan
IPBanCommand: "/ipban %target% %reason% -s"

#Serv 1 Mute
Severity1MuteCommand: "/mute %target% %t% %reason% -s"

#Serv 2 Mute
Severity2MuteCommand: "/mute %target% %t% %reason% -s"

#Serv 3 Mute
Severity3MuteCommand: "/mute %target% %t% %reason% -s"

#Serv 1 General Ban
Severity1GeneralBanCommand: "/ban %target% %t% %reason% -s"

#Serv 1 Client Ban
Severity1ClientBanCommand: "/ban %target% %t% %reason% -s"

#Serv 2 Client Ban
Severity2ClientBanCommand: "/ban %target% %t% %reason% -s"

#Serv 3 Client Ban
Severity3ClientBanCommand: "/ban %target% %t% %reason% -s"

#Warm
WarnCommand: "/warn %target% %reason% -s"

 

If you want to create a default config for another punishment plugin, message us on discord!

AdvancedBanGUI Template

Here is a premade guicommands.yml for AdvancedBan!

#Welcome to the commands.yml file, feel free to change the commands around for each item. Reasons can be changed in the banreason.yml file.
#For support please contact us on discord: https://bghddevelopment.com/discord
#=======================================================
#Placeholders:
#%target% - Player you are punishing
#%t% - Time
#%reason% - Punish reason
#=======================================================

#This default config is for AdvancedBan, feel free to change it to your punishment plugin!

#Perm Mute
PermMuteCommand: "/mute %target% -s %reason%"

#Perm Ban
PermBanCommand: "/ban %target% -s %reason%"

#Serv 1 Mute
Severity1MuteCommand: "/tempmute %target% %t% -s %reason%"

#Serv 2 Mute
Severity2MuteCommand: "/tempmute %target% %t% -s %reason%"

#Serv 3 Mute
Severity3MuteCommand: "/tempmute %target% %t% -s %reason%"

#Serv 1 General Ban
Severity1GeneralBanCommand: "/tempban %target% %t% -s %reason%"

#Serv 1 Client Ban
Severity1ClientBanCommand: "/tempban %target% %t% -s %reason%"

#Serv 2 Client Ban
Severity2ClientBanCommand: "/tempban %target% %t% -s %reason%"

#Serv 3 Client Ban
Severity3ClientBanCommand: "/tempban %target% %t% -s %reason%"

#Warm
WarnCommand: "/warn %target% -s %reason%"

#Kick
KickCommand: "/kick %target% %reason%"

 

If you want to create a default config for another punishment plugin, message us on discord!

Metrics

PunishmentGUI includes metrics by BStats! This allows us to track how many people are using the plugin and what updates you are on. If you want to disable these metrics please go to the "bstats" folder in your server and disable the tracking.

 

# bStats collects some data for plugin authors like how many servers are using their plugins.
# To honor their work, you should not disable it.
# This has nearly no effect on the server performance!
# Check out https://bStats.org/ to learn more :)
enabled: true
serverUuid: N/A
logFailedRequests: false

Bungeecord/Network Wide Setup

I see you want to put PunishmentGUI on a Bungeecord/Network! This is great though please note it may require a little setup.

You must have a punishment plugin that supports external databases I recommend using LiteBans or AdvancedBans as these both have the options which are required.

You will also need a MySQL Database (If your punishment plugin supports another database you may use this). I will not go through how to make a MySQL Database in this wiki, please refer to YouTube or your Minecraft host.

 

Video Setup: Soon!

 

Text Setup:

Step 1: Backup any database or config files.

Step 2: Place both PunishmentGUI and your punishment plugin on each SPIGOT server not BUNGEECORD.

Step 3: Enter the MySQL details for your database into your punishment plugin's config file. 

The below example config.yml is from LiteBans, though most plugins will have a related section if it supports Databases.

Before:

sql:
  # H2, MySQL, MariaDB, and PostgreSQL are supported database drivers.
  driver: H2

  ## MySQL/PostgreSQL settings ##
  # If using H2, the database will be stored in the LiteBans plugin folder,
  # and most of these settings won't apply.

  # Database server address.
  address: localhost:3306

  # Database name, username and password.
  database: 'litebans'
  username: ''
  password: ''

  table_prefix: 'litebans_'

After:

sql:
  # H2, MySQL, MariaDB, and PostgreSQL are supported database drivers.
  driver: MySQL

  ## MySQL/PostgreSQL settings ##
  # If using H2, the database will be stored in the LiteBans plugin folder,
  # and most of these settings won't apply.

  # Database server address.
  address: yourmysqlport:3306

  # Database name, username and password.
  database: 'yourmysqldatabasename'
  username: 'yourmysqlusername'
  password: 'yourmysqlpassword'

  table_prefix: 'litebans_'

Step 4: Enable any settings which allow punishments to sync. (Make sure to set the server name if the plugin allows)

The below example config.yml is from LiteBans, though most plugins will have a related section if it supports sync.

# If this option is enabled and the server is connected to a remote database (e.g. MySQL),
# LiteBans will synchronize across all servers connected to that database with sync enabled.
sync: true

# If enabled, broadcasts will be synchronized.
sync_broadcasts: true

# If enabled, notifications will be synchronized.
sync_notifications: true

# If enabled, dupeip notifications will be synchronized.
# This will appear multiple times if a player joins multiple servers, so you might want to leave this disabled.
sync_dupeip_notifications: false

# The server name is an identifier used in cross-server synchronization.
# It represents a single plugin instance (or group of instances) and can be updated at any time.
# If you need per-server bans, you have to change server_name on all instances
# The "$serverScope" and "$serverOrigin" variables can be used in messages.
# Maximum length is 32 characters.
server_name: 'litebans'

Step 5: Repeat the process on every SPIGOT server, if you had your punishment plugin on bungeecord you must remove it. 

 

You can now use PunishmentGUI and your punishment plugin on your network!

Please note, this will only sync punishments, PunishmentGUI does not support sync of its configuration, so you must edit each server individually, or copy + paste your created PunishmentGUI config to each SPIGOT server.

 

If you need support or help please reach out to us on Discord: https://bghddevelopment.com/discord

FAQ

Check out our most common questions and answers!

 

Can I add more items?

Currently, we do not support adding items to the config, this is a planned feature but we currently don't have an ETA for this. 

You can add more items by modifying the source code found here: https://github.com/BGHDDevelopment/PunishmentGUI

 

Bungeecord Support?

Due to the way bungeecord works we can not directly put the plugin on bungeecord. Follow the tutorial on the wiki page!

https://wiki.bghddevelopment.com/books/punishmentgui---litebansgui-advancedbangui/page/bungeecordnetwork-wide-setup

 

Does this support any punishment plugins?

Yes! As long as you can add the command to the config it will support anything!

 

Where can I get support?

https://bghddevelopment.com/discord

 

 

 

 

Source Code

PunishmentGUI is open source! You can edit and view the source code here: https://github.com/BGHDDevelopment/PunishmentGUI

Update Changelogs

Update Changelogs

0.0.1 - Changelog

Version: 0.0.1

Released: 9/28/2019

 

Changes:

Completely redesigned the configs to support all punishment plugins.

Added a brand new wiki page to provide information and answer common questions.

Rebranded the plugin from LiteBansGUI to PunishmentGUI

Redirected AdvancedBanGUI to PunishmentGUI

New GitHub repo has been opened: https://github.com/BGHDDevelopment/PunishmentGUI

 

Commands Changed:

/litebansgui is now /punishmentgui

 

/litebansguireload is now /punishmentguireload [punish.reload]

 

Update join notification permission has been changed to [punishmentgui.update]

 

 

 

Update Changelogs

0.0.2 - Changelog

Version: 0.0.2

Released: 10/26/2019

 

Changes:

Remade a few messages

Fixed a few issues

Remade some of the update checker system

 

Ideas?

https://feedback.bghddevelopment.com

 

 

Update Changelogs

0.0.3 - Changelog

Version: 0.0.3

Released: 11/19/2019

Supported MC Versions: 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14+

This update has been tested on the versions above, and no issues were found. Please report them to us on discord if you have issues so we can release a fix ASAP. - Noodles

 

Changes:

Added Feedback Link to Config.yml

Removed some blank spaces and updated some configs. 

 

Ideas?

https://feedback.bghddevelopment.com

 

 

Update Changelogs

0.0.4 - Changelog

Version: 0.0.4

Released: 11/20/2019

Supported MC Versions: 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14+

This update has been tested on the versions above, and no issues were found. Please report them to us on discord if you have issues so we can release a fix ASAP. - Noodles

 

Changes:

Fixed update checker sending the update message when the plugin is not outdated.

Added Inventory Name to config

 

Please add the following to your config.yml

InventoryName: "&c&lPunishments"

 

Ideas?

https://feedback.bghddevelopment.com

 

 

Update Changelogs

0.0.6 - Changelog

Version: 0.0.6

Released: 2/5/2019

Supported MC Versions: 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15+

Please report any bugs you find on the DISCORD server!

 

Changes:

Thanks to ThinkVerse for the changes in this update. GitHub pull requests save me a lot of time. Thank you!

Added some more features of the plugin to reload command

Added GUIFiller item

Added support for item data values

Recoded part of config system

Recoded part of the item handler system

 

Please add the following to your guiitems.yml

#Filler:
FillerEnabled: true
GUIFillerItem: "STAINED_GLASS_PANE:7"

 

Ideas?

https://feedback.bghddevelopment.com

 

Upcoming Changes Planned

 

 

Update Changelogs

0.0.7 - Changelog

Version: 0.0.7

Released: 2/14/2019

Supported MC Versions: 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15+

Please report any bugs you find on the DISCORD server!

Thanks to Thinkverse for the changes in this update. GitHub pull requests save me a lot of time. Thank you!

Changes:

Fixed an issue with the ban item running the wrong command.

Fixed 2 messages for the IP Ban and IP Mute items.

The system for handling the punished player's username has been recoded to fix a possible issue when more than one person was using the GUI.

Added an option to have a silent start in the console. (SUGGESTION)

Added an option to toggle update checks in the console.

Major code cleanups including (config method changes, removing non-used functions, fixed a few checks.

 

Please add the following to your config.yml

#=======================================================
CheckForUpdates:
  Enabled: true
#Enables a message in console if the plugin is outdated.
#=======================================================
SilentStart:
  Enabled: false
#Removes startup messages.
#=======================================================

 

Ideas?

https://feedback.bghddevelopment.com

 

Upcoming Changes Planned