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

game: Stray
requires:
  version: 0.6.7 # Version of Archipelago required for this yaml to work as expected.
  game:
    Stray: 0.0.4 # Version of the world required for this yaml to work as expected.

Stray:
  ################
  # 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 #
  ########
  GoalRequirement:
    # ONLY OPEN THE CITY IS IMPLIMENTED, THE OTHER OPTIONS WILL DO NOTHING!
    # What do you need to complete your goal?
    # Open the city: Complete the game's story by opening Walled City 99.
    # Recieve all badges: Get all six of the Badges from the multiworld.
    # Both: Open Walled City 99 after getting all six Badges.
    # Complete Chapter: Complete a specific chapter, specified by the next option.
    open_the_city: 50
    receive_all_badges: 0
    both: 0

  ChapterToGoal:
    # NOT CURRENTLY IMPLIMENTED! THIS OPTION DOES NOTHING!
    # What chapter needs to be beaten to goal?
    # Only has an effect if Goal Requirement is set to Complete Chapter.
    # To prevent instant Go Mode, the earliest goal chapter is The Slums Part 1.
    # 
    # 4: The Slums Part 1
    # 5: Rooftops
    # 6: The Slums Part 2
    # 7: Dead End
    # 8: Sewers
    # 9: Antvillage
    # 10: Midtown
    # 11: Jail
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 4
    # Maximum value is 11
    4: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-4-11: 0 # random value between 4 and 11

  #############
  # Locations #
  #############
  Scratchsanity:
    # When enabled, makes each spot where you can scratch an object a location.
    # It is highly recommended to turn either this and/or Camerasanity on when playing solo.
    # Adds 43 locations.
    'false': 0
    'true': 50

  Camerasanity:
    # NOT CURRENTLY IMPLIMENTED! THIS OPTION DOES NOTHING!
    # When enabled, makes meowing at each camera in Dead City and The Flat a location.
    # It is highly recommended to turn either this and/or Scratchsanity on when playing solo.
    # Adds 0 locations.
    'false': 50
    'true': 0

  #########
  # Logic #
  #########
  OutsiderLogic:
    # How should the Outsider Badge work logically?
    # This only affects Logic. Nothing in the game actually requires having the Outsider Badge.
    # 
    # False: The Outsider Badge is never logically required for anything.
    # True: The Outsider Badge is logically required to progress past the start of Dead End.
    'false': 50
    'true': 0

  CodeLogic:
    # How should code giving items work logically?
    # For example, the Sheet Music Safe inside the Slums is supposed to be opened with the Safe's Mysterious Password.
    # However, if you know the code ahead of time, this can be skipped.
    # If you would rather do it the intended way, this option makes the code giving items logically required.
    # 
    # This affects...
    # Unreadable Sheet Music (requires Safe Mysterious Password and Poncho)
    # Accessing the Nightclub (requries Mysterious Message)
    # 
    # False: Code giving items are never logically required for anything.
    # True: Code giving items are logically required for things that are behind those codes.
    'false': 50
    'true': 0

  ###########################
  # Cross-Game Interactions #
  ###########################
  DeathLink:
    # NOT CURRENTLY IMPLIMENTED! THIS OPTION DOES NOTHING!
    # If the Stray dies :(, everyone else with DeathLink dies.
    # If someone else with DeathLink dies, the Stray dies too :(
    '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_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.
    []
