Untitled

# !-------------------------------------------------------------------------------------------------!
#                       Welcome to the main configuration of PunishControl
#    For support and documentation, please visit:
#    - https://github.com/Simplix-Softworks/PunishControl/wiki
#    1) COLOR CODES are supported with the & character. See
#       - http://minecraftwiki.net/wiki/Formatting_codes
#       [!] When you use them, omit the message with " " or  .
#    2) For UNICODE CHARACTERS (smileys, symbols, ..), save the file in UTF-8 encoding. See
#       - https://github.com/Simplix-Softworks/ChatControl/wiki/Use-Right-Encoding
#    PS: The information above applies for all files within the PunishControl folder.
#    !! Messages (e.g. Please wait 2 seconds [...]) are stored in localization, see:
#       - https://github.com/Simplix-Softworks/PunishControl/wiki/Localization
# !-------------------------------------------------------------------------------------------------!

# -------------------------------------------------------------------------------------------
# The default locale PunishControl is using
# -------------------------------------------------------------------------------------------
locale = en

# -------------------------------------------------------------------------------------------
# Defines the command aliases of the main PunishControl command
# * THE FIRST ALIAS IS THE MAIN LABEL, PLEASE DO NOT REMOVE IT.
# -------------------------------------------------------------------------------------------
command-aliases = [
  punishcontrol,
  phc,
  pun,
  pc
]

# -------------------------------------------------------------------------------------------
# Defines the storage type and the MySQL connection if used
# Available storage types: H2/MYSQL
# -------------------------------------------------------------------------------------------
storage {
  type = H2
  mysql-connection {
    database = CHANGE-ME
    host = CHANGE-ME
    password = CHANGE-ME
    port = 3306
    user = CHANGE-ME
  }
}

# -------------------------------------------------------------------------------------------
# Groups are used to determine the limits a player can create.
# Specific groups can also be exempted from punishments or kicks.
#
# Example use case:
# > Your server has got a helper group
# > that should only be able to warn people.
#
# Priorities: Highest: 0, second: 1, third: 2, and so on
#
# Note:
# > If 2 groups are matching for a player,
# > the group which the the highest priority will
# > be applied
#
# Important:
# > If a user does not have any specific (but only the default) group, it will not be able
# > to create punishments
#
# -------------------------------------------------------------------------------------------
groups {
  #
  # Default group.
  # Used for every player on the server.
  # Lowest priority of all groups
  #
  default {
    # Display name of the group. For example used in menus
    name = default
    # Display item of the group. For example used in menus
    # List of valid items:
    # https://docs.google.com/document/d/1pWfAc_wY8_CFnWGlUH_OgPZQAs59b1Q2pWIm1kjQEmU/edit
    item = stone
  }

  groups = [
    {
      name = admin
      item = STONE
      # Permission a player needs to have to be considered as a part of this group
      permission = "punishcontrol.group.admin"
      # Limits define how long a member of a group will be able to punish a user
      ban-limit = permanent
      mute-limit = permanent
      warn-limit = permanent
      exempt-kicks = true
      exempt-punishments = true
      priority = 0
    },
    {
      name = moderator
      permission = "punishcontrol.group.moderator"
      ban-limit = "365 days"
      mute-limit = "365 days"
      warn-limit = "365 days"
      exempt-kicks = false
      exempt-punishments = false
      item = STONE
      override-punishments = true
      priority = 1

    }
  ]
}

# -------------------------------------------------------------------------------------------
# Default settings for punishments
# -------------------------------------------------------------------------------------------
punishments {
  #
  # Things that should happen once a punishment is initialized
  #
  actions {
    #
    # Available variables: {is_permanent}, {reason},
    # {creation}, {creator_name}, {target_name}, {duration}, {end_date}
    #
    commands = []
  }

  #
  # Default settings for punishment (
  # These can be customized for each punishment ingame or using commands.
  #
  default {
    #
    # Defines whether the punishment should apply on the ip of the punished player
    # > Note: This can be overridden by the punishment type specific "can-apply-on-ip" setting
    #
    apply-on-ip = true
    #
    # Defines the servers the punishment should apply on
    # Example use case:
    # >  You have got a player that was duping on the survival server
    # >  and the player should only be banned from this server.
    #
    # Available types:
    # All - The punishment should apply on all servers
    # Included - The punishment should only apply on some included servers
    # Excluded - The punishment should apply on all servers except some specially excluded ones
    #
    # > Note: Only applies on your proxy server! -> You will need to use PunishControl on
    # > BungeeCord to use this
    #
    server-scope {
      servers = []
      type = All
    }

    #
    # Defines which staff members will see the
    # notification broadcasted once a punishment is initialized (See "Notifications.punishment.creation")
    # Available:
    #   - Broadcast: No permission required -> Even normal player will see the notification
    #   - Default: Default visibility -> Will be send to staff members with the required permission
    #   - Silent: Uses a different permission -> Use when only special staff should be notified
    #   - SuperSilent: No notification will be send out
    visibility = Default
  }

  bans {
    #
    # Defines whether a mute can apply on the ip of a banned player (2nd accounts with
    # the same ip will be banned, too)
    # Overrides the default "apply_on_ip" setting
    #
    can-apply-on-ip = true
  }

  mutes {
    #
    # Commands that a player is not allowed to use while being muted
    # > Note: This feature can be disabled in "advanced.listen-for-commands"
    #
    blocked-commands = [
      "/msg",
      "/r",
      "/tell",
      "/reply",
      "/me",
      "/r"
    ]
    #
    # Defines whether a mute can apply on the ip of a muted player (2nd accounts with
    # the same ip will be muted, too)
    # Overrides the default "apply_on_ip" setting
    #
    can-apply-on-ip = false
  }
  warns {
    #
    # Defines whether a warn can apply on the ip of a banned player (2nd accounts with
    # the same ip will be warned, too)
    # Overrides the default "apply_on_ip" setting
    #
    can-apply-on-ip = false
  }
}

# -------------------------------------------------------------------------------------------
# Default settings for kicks
# -------------------------------------------------------------------------------------------
kicks {
  #
  # Things that should happen once a kick is initialized
  #
  actions {
    #
    # Available variables: {creator_name}, {reason}, {creation}
    #
    commands = []
  }
}

# -------------------------------------------------------------------------------------------
# Settings for automatic staffactions.
# -------------------------------------------------------------------------------------------
auto-staff-actions {
  time-off-set = permanent
}

# -------------------------------------------------------------------------------------------
# Defines how punishment & kick reasons should be defined
# -------------------------------------------------------------------------------------------
formats {
  #
  # Available placeholders: (For ban, mute & warn)
  # {is_permanent}, {reason}, {creation}, {creator_name}, {target_name}, {duration}, {end_date}
  #
  ban {
    permanent = [
      "&4You have been banned",
      "&8Reason: &7{reason}",
      "&8Banned by: &7{creator_name}"
    ]
    temporary = [
      "&4You have been banned",
      "&8Reason: &7{reason}",
      "&8Try again: &7{end_date}",
      "&8Banned by: &7{creator_name}"
    ]
  }
  mute {
    permanent = [
      "&4You have been muted",
      "&8Reason: &7{reason}",
      "&8Muted by: &7{creator_name}"
    ]
    temporary = [
      "&4You have been muted",
      "&8Reason: &7{reason}",
      "&8Try again: &7{end_date}",
      "&8Muted by: &7{creator_name}"
    ]
  }

  warn {
    permanent = [
      "&4You have been warned",
      "&8Reason: &7{reason}",
      "&8Warned by: &7{creator_name}"
    ]
    temporary = [
      "&4You have been warned",
      "&8Reason: &7{reason}",
      "&8Until: &7{end_date}",
      "&8Warned by: &7{creator_name}"
    ]
  }
  #
  # Available placeholders:
  # {creator_name}, {reason}, {creation}
  #
  kick {
    message = [
      "&4You have been kicked!",
      "&8Reason: &7{reason}"
    ]
  }
}

# -------------------------------------------------------------------------------------------
# Manage notifications created by PunishControl
# -------------------------------------------------------------------------------------------
notifications {
  punishment {
    creation {
      default {
        #
        # Permission to see this notification
        #
        permission = "punishcontrol.notify.punishment.creation.default"
        #
        # Available placeholders:
        # {is_permanent}, {reason}, {creation}, {creator_name}, {target_name}, {duration}, {end_date}
        #
        message = "{ \"text\": \"―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――\",\"extra\": [\n{ \"text\": \"&7{target_name} &7has been {type} by {creator_name}\" },\n{ \"text\": \"&8Reason:&7 {reason}\" },\n{ \"text\": \"Duration: {duration}\" },\n{ \"text\": ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――\" } ] }"
      }
      silent {
        #
        # Permission to see this notification
        #
        permission = "punishcontrol.notify.punishment.creation.silent"
        #
        # Available placeholders:
        # {is_permanent}, {reason}, {creation}, {creator_name}, {target_name}, {duration}, {end_date}
        #
        message = "{ \"text\": \"―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――\",\"extra\": [\n{ \"text\": \"&7{target_name} &7has been {type} by {creator_name}\" },\n{ \"text\": \"&8Reason:&7 {reason}\" },\n{ \"text\": \"Duration: {duration}\" },\n{ \"text\": ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――\" } ] }"
      }
    }
    #
    # Will be triggered: When a banned player tries to join, a muted player tries to chat.
    #
    by-pass-try {
      #
      # Permission to see this notification
      #
      permission = "punishcontrol.notify.punishment.bypass.try"
      #
      # Available placeholders:
      # {is_permanent}, {reason}, {creation}, {creator_name}, {target_name}, {duration}, {end_date}
      # {translated_message} - Example: (Player xy tried to chat whilst muted)
      # is pulled from the localization files and can also be configured.
      #
      message = " {\"text\":\"\",\"extra\":[\n { \"text\":\"―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――\"},\n { \"text\":\" \"},\n { \"text\":\"{translated_message}\",\"hoverEvent\":{\"action\":\"show_text\", \n\"contents\":[\"&7Creator:&7{creator_name}\",\"&7Duration: &7{duration}\"]}},\n { \"text\":\" \"},\n{\"text\":\"―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――\", \n\"hoverEvent\":{\"action\":\"show_text\",\"contents\":[\"&7Creator:&7{creator_name}\",\"&7Duration: &7{duration}\"]}}]}"
    }
  }
}

# -------------------------------------------------------------------------------------------
# Advanced settings
# In most cases it is absolutely unnecessary to touch them.
#
# -> Dont change them unless you really know what you are doing.
# -------------------------------------------------------------------------------------------
advanced {
  cache {
    duration-ms = 1800000
    enabled = true
  }
  #
  # Change how the date should be formatted in our menus & commands
  # For valid formats, please see: https://www.w3.org/QA/Tips/iso-date
  #
  date-format = "hh:mm MM/dd/yyyy"
  #
  # Only applies on Spigot. If a notification will be display in the menu
  # if BungeeCord is detected and PunishControl is used on Spigot.
  #
  encourage-bungee-cord-usage = true
  #
  # Will special commands be blocked when players are muted?
  # These special commands can be configuered in "punishments.mutes.blocked-commands"
  #
  listen-for-commands = true
  #
  # (BungeeCord only) Defines the latest protocol-version that our items should be compatible with
  # For a list of Protocol-Versions, please see: https://wiki.vg/Protocol_version_numbers
  # This changes how many items will be available to select in the material browsers, which
  # for example shows up, when you want to customize ur items
  #
  min-protocol-version-supported = 47
  #
  # Define how PunishControl searches for values (e.g: Names)
  #
  searcher {
    # Defines required similarity for strings to be similar.
    # Maximum: 1.0 Minimum: 0.0 (All strings will be concidered similar)
    min-similarity-needed = 0.85
    # Defines whether strings that start with the same sequence will be similar
    # Example: If you have the string "Ex" will be considered similar to "Example"
    use-starts-with = true
  }

  #
  # Only applies on Spigot:
  # Defines whether the server is in online mode or not.
  # The UUID fetcher won't work in offline mode.
  # <Auto> - Automatically detect whether the server is in offline or online mode
  # <Offline> - Set the server to offline mode
  # <Online> - Set the server to online mode
  #
  # Important:
  # > If you set the server to online mode, whilst in offline mode you
  # > risk to invalidate the player database since the player-name -> player-uuid mapping
  # > will get invalidated.
  #
  server-mode = AUTO
}