AdvancedPunishGUI - Blockhead7360's Plugin Shop

# AdvancedPunishGUI by Blockhead7360 (http://blockhead7360.com)
# Configuration guide: http://bit.ly/AdvancedPunishGUI


# - Plugin information -:

# PERMISSION NODES:
# punishments.moderator >> gives you access to all commands. The only command that doesn't require a permission node is "/warns", which just shows you how many warnings you have received.

# COMMANDS:
# /punish <player> >> Opens the Punishment GUI.
# /ban >> Tells you to use "/punish" instead.
# /unban <player> >> Lets you unban a player (you could also do /unban <uuid> or /unban </ipaddress>, but that's not as easy, so just use player names ;))
# /kick <player> <reason...> >> Lets you kick a player for a specified reason.
# /warn <player> <reason...> >> Lets you warn a player for a specified reason.
# /banlist >> Shows an inventory full of banned players.

# /warns >> Shows how many warns you (the sender) has. This does not require "punishments.moderator" permission node.


# IF ANY PART OF THE PLUGIN IS NOT WORKING OR NEEDS AN UPDATE, CONTACT ME FOR HELP
# Email (recommended): plugins@blockhead7360.com
# Spigot Forums: Send a PM to ComputerDust
# Bukkit Forums: Send a PM to Blockhead7360
# Any of these allow me to easily respond.

# YouTube: http://j.mp/bh7360yt
# PayPal: http://pay.blockhead7360.com (redirects to PayPal.me link)

# If the plugin is not working, this plugin has full error coverage for 1 month. Once this time runs out, you will need to pay $20 USD to purchase another 2 weeks of error coverage (if you need it). However, this plugin has been tested and should be bug free.

# If the plugin needs an update, pricing depends on the size of the update. Small updates are FREE!
# For a ton of information on all of this, visit: http://ps.blockhead7360.com
# Alternative: https://www.spigotmc.org/threads/blockhead7360s-plugin-shop-high-quality-plugins-open.103453/
# Alternative: http://blockhead7360.com/plugin-dev
# On that page, all this information, plus a section for update pricing, is listed!

# THIS PLUGIN FALLS INTO THE "LARGE" SIZE CATEGORY (on the plugin shop page above).



# Hello! This is a guide for the configuration file (config.yml) of AdvancedPunishGUI by Blockhead7360 (made for Dragon_12dk)
# This plugin will not be sold to anyone other than Dragon_12dk (technically, except me, since I have the file, but I won't use it) unless Dragon_12dk provides permission to do so.

# For a Bukkit/Spigot color code guide: http://ccg.blockhead7360.com

# There are a lot of other sections of the configuration file that are generated upon specific tasks running in the plugin (ex. banning someone, kicking someone, etc). It is recommended NOT to edit those sections! Only edit the sections below!


ban-message:
  - "&cYou are banned from this server!"
  - " "
  - "&fBanned on: %BANNED-ON%"
  - "&fBanned by: %BANNED-BY%"
  - "&fReason: %REASON%"
  - " "
  - "%IF%PERMANENT: &fYou are permanently banned!"
  - "%IF%ELSE: &eYou are banned for %TIME-LEFT%"
  - "Appeal at: &b&nhttp://example.blockhead7360.com"
# In this section, you can define the message that is sent to the player when they are banned (or when they retry to join while banned). To add another line, simply indent (using spaces, NOT the tab key) and place a "-" in alignment with the other lines in the example above. Color codes are supported.

# Available variables (case sensitive):
# %BANNED-ON% >> provides the date (MM-dd-yyyy) that the player was banned on.
# %BANNED-BY% >> provides the username of who banned the player.
# %REASON% >> provides the reason for which they were banned.

# If the player is permanently banned, use this to signify the line: "%IF%PERMANENT: "
# Remember that that is case sensitive, and with that space between the colon (":") and the message. (also without the quotations. See example above if you are confused)
# The message on that line will only be sent if "%IF%PERMANENT: " is found at the beginning of the line.

# If the player is temporarily banned, use this to signify the line: "%IF%ELSE: "
# Same as above for the description for this.
# On the line that starts with "%IF%ELSE: ", you can have the variable %TIME-LEFT%, which provides the time left until the ban is complete.



punishments:
  '1':
    - "Swearing%%86400"
  '2':
    - "Hacking%%-1"
# This is the section where the punishments for the ban options are defined. Remember to keep indentation when adding more.
# Each number is a page number. Limit 45 lines per page, or errors may be thrown.
# The reason that the examples "Swearing" and "Hacking" are on different pages is to show how to setup multiple pages. You can delete the lines after '2' to get rid of the second page, and simply add more to the first page.

# How to format a punishment:
# REASON%%TIME-SECONDS
# The message is split at the %%, so that is very important to have.
# The time is in seconds, so if you want a day, simply look up "how many seconds in a day" on google (which is 86400).
# Put the reason first, then the %%, then the seconds.
# To make a permanent ban, use -1 in the seconds section.


unban-check-interval-ticks: 80
# This is the delay for the timer that is running in the background. The reason I have this is so that the History section of the punish GUI works better and is more accurate.
# This is what is happening:
# Every 80 ticks (4 seconds), the configuration file is read through to see who needs to be unbanned, and if any warns have expired. I honestly think that 4 seconds is a good amount to have this at. Too little can cause lag and glitches, and too high can cause extended ban times and extended warn times. I recommend leaving it as it is unless you know what you are doing.

warns-last-days: 7
# This is how long (in days) that warns will last before expiring. This is on a per-warn basis. So if you get 1 warn on Monday and 1 on Tuesday, the first warn will expire 1 day before the other. Get it :)?

kick-after-warns: 3
# After this many warns, the player will be kicked saying that they received too many warns, and their last warn message.

temp-ban-after-warns: 4
# After this many warns, the player will be temporarily banned for the time stated below. Also, all warns are deleted so after the temp ban is over, they will have no warnings.

temp-ban-warn-length-days: 1
# This is how long (in days) that the player will be banned for if receiving too many warns. -1 will NOT work here!

kick-prompt: "&eUsage: /kick %PLAYER% <reason>"
# When a moderator presses the "Kick" icon in the gui, what message should they see?
# Available variables:
# %PLAYER% >> shows the player they were trying to punish.

warn-prompt: "&eUsage: /warn %PLAYER% <reason>"
# When a moderator presses the "Warn" icon in the gui, what message should they see?
# Available variables:
# %PLAYER% >> shows the player they were trying to punish.

broadcast:
  ban: true
  kick: true
  warn-kick: true
# These are simple settings which ask if you would like a message broadcasted to the entire server. These are not customizable as the variable formatting would be much harder, but if you would like these messages to be customizable, it would cost another $8 USD.
# ban >> should a message be broadcasted when a player is banned?
# kick >> should a message be broadcasted when a player is kicked?
# warn-kick >> should a message be broadcasted when a player is kicked for getting too many warns?

# The warn temporary ban falls into the "ban" setting.

# That's all! SORRY FOR A TON OF TEXT, I just wanted to tell you how to operate the plugin with ease ;)