# 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 Zoominoes Template

game: Zoominoes
requires:
  version: 0.6.7 # Version of Archipelago required for this yaml to work as expected.

Zoominoes:
  ################
  # 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 value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-99: 0 # random value between 0 and 99
    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

  goal:
    # What finishes your game.
    # 
    # - **Tier Clear:** beat a full 28-day run on Goal Tier.
    # - **Zookeeper Clears:** beat Goal Tier with Goal Zookeepers different keepers.
    # - **McGuffin Hunt:** collect Required Zoo Tickets out of the Total shuffled into
    #   the multiworld. No run has to be finished at all.
    tier_clear: 50
    zookeeper_clears: 0
    mcguffin_hunt: 0

  goal_tier:
    # Difficulty tier you must clear a full 28-day run on to finish.
    # 
    # Defaults to 7 rather than 8 on purpose. Tier 8 (Director) is the hardest content
    # in the game, and a vanilla player reaches it having unlocked everything, whereas
    # here your pool is only what the multiworld has handed you. 8 is a real challenge
    # run; 7 is a solid finish.
    # 
    # Ignored by the McGuffin Hunt goal, which finishes on Zoo Tickets rather than on a
    # run — McGuffin Max Tier says how deep that world goes.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 8
    7: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-8: 0 # random value between 1 and 8

  goal_zookeepers:
    # How many different zookeepers must clear Goal Tier, for the Zookeeper Clears
    # goal. Marina counts and is available from the start.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 20
    3: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-20: 0 # random value between 1 and 20

  mcguffin_total:
    # Zoo Tickets shuffled into the multiworld, for the McGuffin Hunt goal.
    # 
    # A McGuffin Hunt runs to McGuffin Max Tier, so it is a 372-location world by
    # default and the tickets have to be thick enough to turn up in it.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 100
    75: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-100: 0 # random value between 1 and 100

  mcguffin_required:
    # Zoo Tickets you need to finish. Clamped to the total if it exceeds it.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 100
    40: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-100: 0 # random value between 1 and 100

  mcguffin_max_tier:
    # How deep a McGuffin Hunt goes — tiers 1 to this carry shop and discover checks.
    # 
    # Only the McGuffin Hunt needs telling. The other goals name a tier to clear, and
    # that is as deep as their world goes; anything above would be checks you could
    # finish the seed without ever visiting.
    # 
    # This is what sizes a hunt: tier 1 alone is 51 locations, all 8 is 372.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 8
    8: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-8: 0 # random value between 1 and 8

  ap_slots_per_shop:
    # How many of a Gift Shop's 7 slots hold Archipelago items.
    # 
    # The rest sell normal unlocked stock, so at the default of 3 the shop still works
    # as a shop. Raising this is the main way to grow the location count.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 7
    3: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-7: 0 # random value between 1 and 7

  discover_checks:
    # Add a check to every playable day's reward pick — 19 per tier.
    # 
    # Turning this off removes 19 locations per tier, which at a deep goal will not
    # leave room for the full item pool unless you also raise Archipelago Slots Per
    # Shop.
    'false': 0
    'true': 50

  unlock_unplaced_content:
    # Start with any animal, snack or souvenir the seed had no room for.
    # 
    # A small world can only hold a fraction of the game's content, and the remainder
    # would otherwise stay locked for the whole seed. Turning this off leaves it
    # locked, which makes a short goal a genuinely sparse run.
    'false': 0
    'true': 50

  randomize_starter_zookeeper:
    # Begin the seed on a random zookeeper instead of Marina.
    # 
    # Whoever is drawn is free from the start and Marina becomes an ordinary item, so
    # the opening run plays to a different deck every seed.
    'false': 0
    'true': 50

  randomize_starter_unlocks:
    # Draw the starting animals, snacks and souvenirs at random.
    # 
    # Unrandomised you always open with Starfish, Fennec, Red Ladybug and the rest. The
    # set keeps its size — 6 animals, 4 snacks, 4 souvenirs — and whatever isn't drawn
    # joins the item pool.
    'false': 50
    'true': 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 the specified amount of these items. Example: "Bomb: 1"
    {}

  start_inventory_from_pool:
    # Start with the specified amount of these items and don't place them in the world. Example: "Bomb: 1"
    # 
    # 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.
    []

  plando_items:
    # Generic items plando.
    []
