UltraWelcome | 1.8 - 1.16 | Fully customizable

# +-------------------------------------------------------------------------+ #
# |                                                                         | #
# |                              UltraWelcome                               | #
# |                                                                         | #
# |                     Developed by Sharkz, Quantum                        | #
# |                                                                         | #
# +-------------------------------------------------------------------------+ #

# Version ${project.version}

# +-------------------------------------------------------------------------+ #
# |                                                                         | #
# | All messages support PlaceholderAPI and we also added a very useful     | #
# | feature. You can apply placeholders for multiple players in a single    | #
# | message. An example:                                                    | #
# | “%ph_player%%lp_prefix%User killed %ph_new_player%%lp_prefix%User2“     | #
# |                                                                         | #
# | If a message as placeholders for player names, like %player%, it means  | #
# | that there’s a placeholder for this feature named %ph_player%           | #
# |                                                                         | #
# | uw.roch-blondiaux.com/docs/configuration/Important#placeholderapi       | #
# | uw.roch-blondiaux.com/docs/extra/MultiPlaceholders                      | #
# |                                                                         | #
# +-------------------------------------------------------------------------+ #

# +-------------------------------------------------------------------------+ #
# |                                                                         | #
# | All messages and commands, except the welcome command and the top       | #
# | welcomers messages, can be single or random like this:                  | #
# | single: "single message/command"                                        | #
# | random:                                                                 | #
# |   - "a random message/command"                                          | #
# |   - "another random message/command"                                    | #
# |                                                                         | #
# | If you want multi line messages just put a \n or checkout:              | #
# | uw.roch-blondiaux.com/docs/extra/YamlFormatting                         | #
# |                                                                         | #
# +-------------------------------------------------------------------------+ #

# +-------------------------------------------------------------------------+ #
# |                                                                         | #
# | "%prefix%" is the plugin prefix set in the language file                | #
# |                                                                         | #
# +-------------------------------------------------------------------------+ #

# +-------------------------------------------------------------------------+ #
# |                                                                         | #
# |                            LANGUAGE SETTINGS                            | #
# |                                                                         | #
# |             Controls which language UltraWelcome will use.              | #
# |                                                                         | #
# +-------------------------------------------------------------------------+ #

# Define the current language used by the plugin
# You can use pre-installed translations like en_US
#
# You can also try to reach out your language on the following page:
# https://uw.roch-blondiaux.com/docs/configuration/languages
#
# If you want to create your own translations, go to the lang folder
# copy en_US.lang, rename it to "language_COUNTRY.lang" & translate it!
lang : en_US

# +-------------------------------------------------------------------------+ #
# |                                                                         | #
# |                             WELCOME COMMAND                             | #
# |                                                                         | #
# |         Allows players to welcome new ones and receive a point          | #
# |                                                                         | #
# +-------------------------------------------------------------------------+ #

# Time-limit is how much time you have to welcome a new player
#
# Leave the command blank to disable this feature
# Leave the permission blank to disable it
#
# A restart is needed if you change this options
welcomeCommand:
  command : "welcome"
  permission : ""
  aliases :
   - "w"
  time-limit : 12

# +-------------------------------------------------------------------------+ #
# |                                                                         | #
# |                             WELCOME ACTIONS                             | #
# |                                                                         | #
# |              Execute actions whenever a player is welcomed              | #
# |                                                                         | #
# +-------------------------------------------------------------------------+ #

# It's recommended to visit uw.roch-blondiaux.com/docs/configuration/actions
#
# Placeholders: %player% & %new_player%
onWelcome:
  broadcast:
    enabled : true
    type : global
    sender : broadcast
    broadcast : "Broadcast"
  firework:
    enabled : true
    type : global
    firework:
      power : 3
      flicker : true
      trail : true
      type : STAR
      colors:
        base :
         - WHITE
          - LIME
        fade :
         - RED
          - BLACK
  command:
    enabled : true
    type : global
    command : "/say Hello %player% and %new_player%"
  title:
    enabled : true
    type : global
    title:
      title : "Hello"
      subtitle : "there!"
      fade-in : 10
      stay : 20
      fade-out : 10
  reward:
    enabled : true
    reward:
      money : 0
      message : "&a&lGood Job ! &7You earned $0 for welcoming &a&l%new_player%"

# +-------------------------------------------------------------------------+ #
# |                                                                         | #
# |                           FIRST JOIN ACTIONS                            | #
# |                                                                         | #
# |               Execute actions whenever a new player joins               | #
# |                                                                         | #
# +-------------------------------------------------------------------------+ #

# It's equal to the Welcome Actions.
# There isn't the "sender" option for the broadcast.
# Placeholders: %new_player% (also %player% if you use command in global mode)
first-join:
  broadcast:
    enabled : true
    type : global
    broadcast : "Broadcast"
  firework:
    enabled : true
    type : global
    firework:
      power : 3
      flicker : true
      trail : true
      type : STAR
      colors:
        base :
         - WHITE
          - LIME
        fade :
         - RED
          - BLACK
  command:
    enabled : true
    type : global
    command : "/say Hello %player% and %new_player%"
  title:
    enabled : true
    type : global
    title:
      title : "Hello"
      subtitle : "there!"
      fade-in : 10
      stay : 20
      fade-out : 10

# +-------------------------------------------------------------------------+ #
# |                                                                         | #
# |                              JOIN ACTIONS                               | #
# |                                                                         | #
# |                 Execute actions whenever a player joins                 | #
# |                                                                         | #
# +-------------------------------------------------------------------------+ #

# It's equal to the First Join Actions
#
# Placeholders: %joined_player% (also %player% if you use command in global mode)
join:
  broadcast:
    enabled : true
    type : global
    broadcast : "Broadcast"
  firework:
    enabled : true
    type : global
    firework:
      power : 3
      flicker : true
      trail : true
      type : STAR
      colors:
        base :
         - WHITE
          - LIME
        fade :
         - RED
          - BLACK
  command:
    enabled : true
    type : global
    command : "/say Hello %player% and %joined_player%"
  title:
    enabled : true
    type : global
    title:
      title : "Hello"
      subtitle : "there!"
      fade-in : 10
      stay : 20
      fade-out : 10

# +-------------------------------------------------------------------------+ #
# |                                                                         | #
# |                              TOP WELCOMERS                              | #
# |                                                                         | #
# |                     Display the leaderboard in chat                     | #
# |                                                                         | #
# +-------------------------------------------------------------------------+ #

# Header support multiple lines
# Format support %rank%, %rankedPlayer%, %points%
# Length define the length of the welcomers displayed in the message
top:
  header : "%prefix% &7Top welcomers : "
  format : "&7N°&a%rank% - &a%rankedPlayer%&7 &b%points%&7 points"
  length : 10

# +-------------------------------------------------------------------------+ #
# |                                                                         | #
# |                               MILESTONES                                | #
# |                                                                         | #
# |             Give players rewards through points milestones              | #
# |                                                                         | #
# +-------------------------------------------------------------------------+ #

# "points" is required
# "command" or "money" or "items" is required
# Support %player%
# Require vault if you use "money"
rewards:
  1:
    money : 50
    message : "%prefix% &a&lOhhhhh ! Good job you earn $50 by welcoming 5 players"
    points : 5
  2:
    command : "/give %player% diamond 1"
    message : "%prefix% &a&lNice job ! You earn a diamond by welcoming 10 players"
    points : 10
  3:
    points : 15
    items:
      sword:
        name : "&aMagic Sword"
        material : STONE_SWORD
        amount : 3
        lore :
         - "&aHey !"
          - "&bI'm a magic"
          - "&cSword"
        enchants:
          sharpness : 1

# +-------------------------------------------------------------------------+ #
# |                                                                         | #
# |                           FIRST JOIN REWARDS                            | #
# |                                                                         | #
# |                        Give new players a reward                        | #
# |                                                                         | #
# +-------------------------------------------------------------------------+ #

# Options are equal to the Milestones
#
# There are three modes:
# single - Only the first reward will be given
# random - A random one will be given
# all - All rewards will be given
#
# Require vault if you use "money"
first-join-rewards:
  enabled : false
  type : single
  1:
    money : 35
    command :
     - "/say hello %player%"
      - "/say hi %player%"
    message : "First join yea!"
    items:
      sword:
        name : "&aMagic Sword"
        material : STONE_SWORD
        amount : 3
        lore :
         - "&aHey !"
          - "&bI'm a magic"
          - "&cSword"
        enchants:
          sharpness : 1

# +-------------------------------------------------------------------------+ #
# |                                                                         | #
# |                             OTHER SETTINGS                              | #
# |                                                                         | #
# |                        A bunch of other settings                        | #
# |                                                                         | #
# +-------------------------------------------------------------------------+ #

# Enables bungeecord support
bungeecord : false
# Types supported: uuid or name
player-storage-type : uuid
# Should the plugin send you a message if there is a new version available?
# The message will be sent to you only if you have ultrawelcome.reload permission
notify-update-on-join : true
# Select between SPIGOT & YML (with yml you can reset joined players in a click)
data-storage-type : spigot

# +-------------------------------------------------------------------------+ #
# |                                                                         | #
# |                         PLEASE DON'T EDIT THIS                          | #
# |                                                                         | #
# |                        Seriously don't edit this                        | #
# |                                                                         | #
# +-------------------------------------------------------------------------+ #

config_version : 8