# Q. What is this file?
# A. This file contains options which allow you to configure your multiworld experience while allowing
#    others to play how they want as well.
#
# Q. How do I use it?
# A. The options in this file are weighted. This means the higher number you assign to a value, the
#    more chances you have for that option to be chosen. For example, an option like this:
#
#    map_shuffle:
#      on: 5
#      off: 15
#
#    Means you have 5 chances for map shuffle to occur, and 15 chances for map shuffle to be turned
#    off.
#
# Q. I've never seen a file like this before. What characters am I allowed to use?
# A. This is a .yaml file. You are allowed to use most characters.
#    To test if your yaml is valid or not, you can use this website:
#        http://www.yamllint.com/
#    You can also verify that your MultiworldGG options are valid at this site:
#        https://multiworld.gg/check

# Your name in-game, limited to 16 characters.
#     {player} will be replaced with the player's slot number.
#     {PLAYER} will be replaced with the player's slot number, if that slot number is greater than 1.
#     {number} will be replaced with the counter value of the name.
#     {NUMBER} will be replaced with the counter value of the name, if the counter value is greater than 1.
name: Player{number}

# Used to describe your yaml. Useful if you have multiple files.
description: Default Wordipelago Template

game: Wordipelago
requires:
  version: 0.7.55 # Version of MultiworldGG required for this yaml to work as expected.

Wordipelago:
  # Game Options
  progression_balancing:
    # A system that can move progression earlier, to try and prevent the player from getting stuck and bored early.
    # 
    # A lower setting means more getting stuck. A higher setting means less getting stuck.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 99
    random: 0
    random-low: 0
    random-high: 0
    disabled: 0 # equivalent to 0
    normal: 50 # equivalent to 50
    extreme: 0 # equivalent to 99

  accessibility:
    # Set rules for reachability of your items/locations.
    # 
    # **Full:** ensure everything can be reached and acquired.
    # 
    # **Minimal:** ensure what is needed to reach your goal can be acquired.
    full: 50
    minimal: 0

  words_to_win:
    # How many words you have to get right to hit you goal
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 50
    10: 50
    random: 0
    random-low: 0
    random-high: 0

  green_checks:
    # How checks work for green letters in words
    # none: No checks for getting green letters
    # best: Checks for 1-5 correct letters in a word
    # composition: checks for every configuration of green letters
    # complete: Best and composition combined
    none: 0
    best: 50
    composition: 0
    complete: 0

  yellow_checks:
    # How checks work for yellow letters in words
    # none: No checks for getting yellow letters
    # composition: checks for every configuration of yellow letters
    none: 50
    composition: 0

  letter_checks:
    # Which letters do you want to unlock items for sucessfully using in a word
    # none: No checks for using letters
    # vowels: Checks for using vowels
    # common: Checks for using vowels and common consonants
    # all: Checks for using all letters
    none: 0
    vowels: 0
    common: 50
    all: 0

  starting_letters:
    # How many letters you start with
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 26
    1: 50
    random: 0
    random-low: 0
    random-high: 0

  starting_guesses:
    # How many guesses you start with
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 6
    1: 50
    random: 0
    random-low: 0
    random-high: 0

  starting_cooldown:
    # How long the new round cooldown is at the start of the game
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 600
    120: 50
    random: 0
    random-low: 0
    random-high: 0

  time_reward_count:
    # The number of new round cooldown reduction rewards in the pool
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 30
    10: 50
    random: 0
    random-low: 0
    random-high: 0

  time_reward_seconds:
    # How many seconds each time reward decreases the new round cooldown by
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 30
    10: 50
    random: 0
    random-low: 0
    random-high: 0

  yellow_unlocked:
    # Whether you start with yellow tiles shown or not
    'false': 50
    'true': 0

  unused_letters_unlocked:
    # Whether you start with keyboard letters fading out when discovered not to be in the current word
    'false': 50
    'true': 0

  shuffle_typing:
    # ==Not Yet Implimented==
    # Whether typing on your physical keyboard mimics the layout of the game keyboard
    # none: Typing is not shuffled
    # querty: Typing is shuffled as if using a querty keyboard
    # azerty: Typing is shuffled as if using a azerty keyboard
    # dvorak: Typing is shuffled as if using a dvorak keyboard
    none: 50
    querty: 0
    azerty: 0
    dvorak: 0

  extra_time_reward_percent:
    # What percentage of filler items will be replaced with an extra cooldown reduction
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 100
    0: 50
    random: 0
    random-low: 0
    random-high: 0

  clue_item_reward_percent:
    # ==Not Yet Implimented==
    # What percentage of filler items will be replaced with Clue Points
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 100
    0: 50
    random: 0
    random-low: 0
    random-high: 0

  clue_item_point_size:
    # ==Not Yet Implimented==
    # How many Clue Points are awarded with Clue Point filler items
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 1000
    100: 50
    random: 0
    random-low: 0
    random-high: 0

  bad_guess_trap_percent:
    # ==Not Yet Implimented==
    # What percentage of filler items will be replaced with Bad Guess traps
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 100
    0: 50
    random: 0
    random-low: 0
    random-high: 0

  extra_cooldown_trap_percent:
    # ==Not Yet Implimented==
    # What percentage of filler items will be replaced with Extra Cooldown traps
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 100
    0: 50
    random: 0
    random-low: 0
    random-high: 0

  extra_cooldown_trap_size:
    # ==Not Yet Implimented==
    # How many second are added with the extra cooldown traps
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 300
    60: 50
    random: 0
    random-low: 0
    random-high: 0

  # Item & Location Options
  local_items:
    # Forces these items to be in their native world.
    []

  non_local_items:
    # Forces these items to be outside their native world.
    []

  start_inventory:
    # Start with these items.
    {}

  start_inventory_from_pool:
    # Start with these items and don't place them in the world.
    # 
    # The game decides what the replacement items will be.
    {}

  start_hints:
    # Start with these item's locations prefilled into the ``!hint`` command.
    []

  start_location_hints:
    # Start with these locations and their item prefilled into the ``!hint`` command.
    []

  exclude_locations:
    # Prevent these locations from having an important item.
    []

  priority_locations:
    # Prevent these locations from having an unimportant item.
    []

  item_links:
    # Share part of your item pool with other players.
    []
