VoidBan

Feb 17, 2020
VoidBan
  • Welcome to the VoidBan help page.

    Creating the Config

    Code (YAML):
    #Ban Reasons example config.
    Ban_Reasons
    :
      Hacking
    : #This is the name of the ban, they must all be different.
        Data
    :
         #More types may be added in the future, leave this as BAN.
          Type
    : BAN
          #How long the ban lasts for in seconds (-1 for permanent ban)
          Duration
    : 300
         
        #The message that appears when the gets banned.
        BanMessage
    :
       - '&cYou have been banned by %banhammer% for %duration%'
        - '&7Reason
    : Hacking.'
        - '&cYour ban expires on &e%expiredate%'
        - '&dAppeal at www.ourserverwebsite.com'
        #Set a different message if the user attempts to rejoin when banned.
        #Leave blank to make it the same as the ban message.
        RejoinMessage
    :
       - ''
        GUI
    :
         #The item that will appear in the GUI
          Item
    : BARRIER
          Slot
    : 0
          Lore
    :
          - '&cRule 1
    : &7Do not use hacks.'
          - '&eDuration
    : &75 minutes'
         
      Advertising
    :
        Data
    :
          Type
    : BAN
          #Set to -1 to ban forever. Sets %duration% to 'permamently'
          Duration
    : -1
         
        #These messages are all different, so change them to suit the ban reason if you like!
        BanMessage
    :
       - '&cYou have been banned by %banhammer% %duration%'
        - '&7Reason
    : Advertising.'
        - '&cYour ban expires &e%expiredate%'
        - '&dAppeal at www.ourserverwebsite.com'
        RejoinMessage
    :
       - '&cYou are not authorised to play on this server, as you have been banned.'
        GUI
    :
          Item
    : PAPER
          Slot
    : 1
          Lore
    :
          - '&cRule 2
    : &7Do not use advertise.'
          - '&eDuration
    : &7Forever'
     
     
    Format
    : #Customise the appearance of the plugin.
      GUI
    :
        Title
    : '&dVoidBan'
        #The format of the icon names in the GUI. Set to '' to show item name.
        Item_Name
    : '&cBan %player% for %reason%'
        #The number of rows in the GUI.
        Rows
    : 1
      #Appears before messages, set to '' to disable.
      Plugin_Prefix
    : '&8[&dVoidBan&8]&7'

     

    In the config, you can create your own ban reasons, which have their own properties.
    • Duration: This is the amount of time the ban lasts in seconds. If it is a permanent ban, set this to -1.
    • BanMessage: This is the message that displays when the player is initially banned.
    • RejoinMessage: This is the message that display when the player attempts to rejoin the server whilst banned - set this to '' to make the rejoin message the same as the ban message.
    • GUI.Item: This is the item that will appear in the GUI, just type the name of the item/block that you want.
    • GUI.Slot: This is the slot that the reason will appear in. MAKE SURE TO ORDER YOUR REASONS IN THE ORDER OF THE SLOTS, AS OTHERWISE IT WILL CAUSE ERRORS!
    • GUI.Lore: This is the text that appears below the name when hovering over the item in the GUI, set this to anything you like; I use it to add a description of the reason.
    Variables/Placeholders:
    Variables/placeholders) appear surrounded in '%' signs. These are things that we can't put into a simple format, such as the name of the player, as it depends who is being banned.
    In the BanMessage & RejoinMessage:
    • %banhammer%: The person who banned the player.
    • %duration%: The duration that the ban lasts for. (E.G 2 Days)
    • %expiredate%: The date and time that the player will be unbanned.
    In the GUI Item Names:
    • %player%: The player that is going to be banned.
    • %reason%: The reason of the icon.

    Permissions:
    • voidban.ban - /ban <player> and /ban <player> <reason>
    • voidban.unban - /unban <player>
    • voidban.help - /voidban (Shows the help page)
    Don't hesitate to message me if you are experiencing any issues, or need any help at all - feature requests are also appreciated :).
  • Loading...
  • Loading...