GiftEvents

# The 'events:' section has a sub-section for each configured event.
#
# The 'birthday:' and 'anniversary:' events are special in that they are based on
# dates stored in the server. They can be disabled by removing or commenting them
# out in the configuration.
#
# Events with dates apply to all players with the proper permissions.
#
# Each event has these options:
# date - Date of the event, ignored for 'birthday:' and 'anniversary:' events
# belated - Should the gift be given after the event has passed, default is false
# annoucement - An optional message will be made server wide whenever a player
# joins matching the event date and if they have not already exhausted their
# allotment of messages.


# Explanation of advanced events:
# Advanced events can be used to give players a gift for every day they join.
# The numbers of days are not limited and can be over 365(a year) too.
# Advanced events do not support announcements, specific dates or the belated option!
# An Example can be found at the end of the file.


# For each type of event gifts can be configured through the 'gift:' section
# with the following properties:
# items - Items to be put in player's inventory
# name - Name to give to items if not specified for item seperately
# message - Message to give to player when they recieve the gift


# Explanation of items:
# items: is a list of associative arrays with each associative array having:
# id - Indicates which item to use. This can be the numerial id of the object
#    or a string from the Bukkit Material enum
# enchantments - Optional associative array with id as the key and
#    level as the value. The id can either be an integer enchantment id or
#    a string with a name from the Bukkit Enchantment enum
# amount - Optional number of the item to give
# name - Optional name to give to item instead of one specified in gift section
# damage - Optional damage/durability to assign to the given item

# Announcement and gift messages are formatted with the Java String Formatter
# and passed player_name, and a Calendar date

# All enchantments provided by CraftBukkit/Spigot can be found here: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/enchantments/Enchantment.html
# All materials can be found here: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html
# Entity Ids can be found here: http://minecraft.gamepedia.com/Spawn_Egg#Ability_to_spawn

events:
  birthday:
    belated: True
    announcement: "Today is %1$s's birthday!"
    gift:
      items:
        - { id: CAKE, enchantments: {LOOT_BONUS_BLOCKS: 1} } # Cake w/ Fortune I
      name: "Happy Birthday!"
      message: "Happy Birthday %1$s, check your inventory for a gift"

  anniversary:
    belated: True
    announcement: "Today is %1$s's first play anniversary. Player since %2$tb %2$te, %2$tY"
    gift:
      items:
        - { id: DIAMOND, enchantments: {ARROW_DAMAGE: 1}, amount: 5 } #  Diamond w/ Power I
      name: "Happy Anniversary!"
      message: "Happy First Play Anniversary %1$s, check your inventory for a gift"

  christmas:
    date: 12-25
    belated: False
    gift:
      items:
        - { id: COAL, enchantments: {THORNS: 1} } # Coal w/ Thorns I
      name: "You've been naughty"
      message: "Merry Christmas %1$s, check your inventory for a gift"

  new_years:
    date: 01-01
    belated: False
    gift:
      items:
        - { id: FIREWORK, name: "Blast off!" } # Firework Rocket
      name: "Happy New Year!"
      message: "Happy New Year %1$s, check your inventory for a gift"

  Survival-Anniversary:
    date: 08-03
    belated: False
    gift:
      items:
        - { id: DIAMOND, amount: 5 } #Survival Anniversary
      name: "1 Year of Survival!"
      message: "1 Year of Survival! Check your Inventory!"

  valentines:
    date: 02-14
    belated: False
    gift:
      items:
        - { id: RED_ROSE, enchantments: {ARROW_INFINITE: 1} } # A red rose
      name: "I love you!"
      message: "Happy Valentines Day %1$s, check your inventory for a gift!"

advanced-events:
  Example:
    1:
      gift:
        items:
          - { id: STONE, enchantments: {ARROW_INFINITE: 1} } # stone on the first day
        name: "Day one!"
        message: "Happy STONE Day %1$s!"
    2:
      gift:
        items:
          - { id: DIRT, enchantments: {ARROW_INFINITE: 1} } # dirt on the second day
        name: "Day two!"
        message: "Happy DIRT Day %1$s!"
    4:
      gift:
        items:
          - { id: GRASS, enchantments: {ARROW_INFINITE: 1} } # grass on the fourth day
        name: "Day four!"
        message: "Happy GRASS Day %1$s!"
    6:
      gift:
        items:
          - { id: GLASS, enchantments: {ARROW_INFINITE: 1} } # glass on the sixth day
        name: "Day six!"
        message: "Happy GLASS Day %1$s!"
    879:
      gift:
        items:
          - { id: GOLD_BLOCK, enchantments: {DURABILITY: 1} } # gold block on the 879th day
        name: "Day 879!"
        message: "You sure are a great user, %1$s!"