# 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 Archipelago options are valid at this site:
#        https://archipelago.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 ANIMAL WELL Template

game: ANIMAL WELL
requires:
  version: 0.4.6 # Version of Archipelago required for this yaml to work as expected.

ANIMAL WELL:
  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.
    # Locations: ensure everything can be reached and acquired.
    # Items: ensure all logically relevant items can be acquired.
    # Minimal: ensure what is needed to reach your goal can be acquired.
    locations: 0
    items: 50
    minimal: 0

  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_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.
    []

  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.
    {}

  goal:
    # What you need to do to beat the game.
    # Fireworks requires you to get the 4 flames and defeat the Manticore. The House Key is placed in its vanilla location.
    # Bunny Land requires you to find the 65th Egg, bring it to the incubator, and leave the Well.
    # Egg Hunt requires you to collect the amount of eggs you need to open the 4th Egg Door, then open the chest inside.
    fireworks: 50
    egg_hunt: 0

  eggs_needed:
    # How many Eggs you need to open the 4th Egg Door.
    # The amount of Eggs you need for the other 3 doors will scale accordingly.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 64
    # Maximum value is 64
    64: 50
    random: 0
    random-low: 0
    random-high: 0

  key_ring:
    # Have one keyring which unlocks all normal key doors instead of individual key items.
    # Note: Due to how consumable key logic works, if this option is not enabled, you logically require all 6 keys to open any of the key doors.
    false: 0
    true: 50

  matchbox:
    # Have one matchbox which can light all candles instead of individual match items.
    # Note: Due to how consumable item logic works, if this option is not enabled, you logically require all 9 matches to light any of the candles.
    false: 0
    true: 50

  final_egg_location:
    # Choose whether the 65th Egg is shuffled into the multiworld item pool or placed in its vanilla location, requiring opening the 4th Egg Door to access it.
    # This option is forced on if you have the egg hunt goal selected.
    randomized: 0
    vanilla: 50

  bunnies_as_checks:
    # Include the secret bunnies as checks.
    off: 50
    exclude_tedious: 0
    all_bunnies: 0

  bunny_warps_in_logic:
    # Include the songs that warp you to Bunny spots in logic.
    # If you have Bunnies as Checks enabled, this option is automatically enabled.
    false: 50
    true: 0

  candle_checks:
    # Lighting each of the candles sends a check.
    off: 50
    on: 0

  bubble_jumping:
    # Include using the standard Bubble Wand and chaining bubble jumps together in logic.
    # Exclude Long Chains makes it so you may be required to chain a few bubble jumps before landing.
    off: 0
    exclude_long_chains: 50
    on: 0

  disc_hopping:
    # Include jumping onto the disc without letting it bounce off of a wall first in logic.
    # Single means doing it once from the ground.
    # Multiple means having to chain them in midair.
    # Exception: The bunny that requires you to use this tech.
    off: 50
    single: 0
    multiple: 0

  wheel_hopping:
    # Include toggling the wheel midair to get a double jump in logic.
    false: 50
    true: 0

  weird_tricks:
    # Include performing "weird" tricks in the logic.
    # Some of these tricks are difficult, tedious, or inconsistent.
    # Use at your own risk.
    false: 50
    true: 0