Word of the Day Tutorial

# The word dictionary allows to prevent players to write non-existent
# words on the minigame.
use_dictionary:
  # Set to true of you want to enable the dictionary functionality.
  enabled: false
  
  # You must set a .txt file that contains all the words. This file must be
  # located inside the word_of_the_day directory.
  # Below you can find links to some dictionaries I recommend.
  # English: https://github.com/dwyl/english-words/blob/master/words.txt
  # Spanish: https://github.com/JorgeDuenasLerin/diccionario-espanol-txt/blob/master/0_palabras_todas.txt
  file_name: "words_english.txt"
  
  # If you make changes to the dictionary file, set this option to true. When
  # the plugin reloads, the dictionary will be sorted for future access.
  # If you are not making changes to the dictionary this option should be
  # set to false.
  requires_sort: true

# Configurations about the main minigame inventory
inventory:
  # Title of the inventory
  title: "&f&lWord of the Day"
  
  # You can have words of multiple lengths. This option defines the shape of the
  # inventory associated with the length of the word. 
  # The "*" represents a letter item.
  # The "-" represents an empty/fill item.
  # The format of this option is:
  # <word_length>: "<distribution>"
  # The number of "*" must be the same as the word length.
  word_distribution:
    5: "--*****--"
    6: "--******-"
    7: "-*******-"
    
  # This item will be placed on the "-" positions of the word_distribution option.
  fill_item:
    enabled: true
    item:
      id: BLACK_STAINED_GLASS_PANE
      name: " "
  
  # Item to be placed when using type: word_of_the_day on the inventory.yml file.
  # Appears when the player has not played today.
  play_item:
    item:
      id: COAL_BLOCK
      name: "&f&lWord of the Day"
      lore:
        - "&7Try to discover the hidden word"
        - "&7by guessing the position of the"
        - "&7letters!"
        - ""
        - "&7Wins: &a%minewords_word_of_the_day_wins% &8| &7Loses: &c%minewords_word_of_the_day_loses%"
        - ""
        - "&6&lCLICK TO PLAY"
  
  # Item to be placed when using type: word_of_the_day on the inventory.yml file.
  # Appears when the player has already played today.
  already_played_item:
    item:
      id: COAL_BLOCK
      name: "&f&lWord of the Day"
      lore:
        - "&7Try to discover the hidden word"
        - "&7by guessing the position of the"
        - "&7letters!"
        - ""
        - "&7Wins: &a%minewords_word_of_the_day_wins% &8| &7Loses: &c%minewords_word_of_the_day_loses%"
        - ""
        - "&cYou've already played today. Come"
        - "&cback tomorrow!"
        - ""
        - "&7Next word on &e%time%"
  
  # Item to use when wanting to insert/check a word.
  enter:
    item:
      id: EMERALD_BLOCK
      name: "&a&lEnter"
    inventory_slot: 4

# Actions to be executed on certain cases.
actions:
  # When the player wins the minigame.
  # You can use the %word% and %player% variables.
  on_win:
    - "message: &aWord of the day found! The word was &e%word%&a."
    - "playsound: BLOCK_NOTE_BLOCK_PLING;1;2"
    - "console_command: eco give %player% 250"
  
  # When the players loses the minigame.
  # You can use the %word% and %player% variables.
  on_lose:
    - "message: &cWord of the day not found! The word was &e%word%&c."
    - "playsound: BLOCK_NOTE_BLOCK_PLING;1;0.1"

# Configuration for words.
# You can use words with a maximum length of 9.
words:
  # Here you can specify a word to be used on a certain day of the year.
  # Use the following format:
  # <month>-<day>: "<word>"
  days:
    10-17: "MELON"
    10-18: "BACON"
    10-19: "HUNGER"
  
  # If there is a day with no word, then a random word from this
  # list will be selected.
  random_words:
    - "TRAIN"
    - "DOCTOR"
    - "JEWEL"
    - "GLASS"
    - "CRATE"