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

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

IAmYourBeast:
  ################
  # 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

  required_levels:
    # How many levels must be completed to finish the game.
    # Levels are chosen randomly from the included collections.
    # If more levels are chosen that the maximumem available the levels get capped at the maximum available.
    # The required number of levels can be tracked on the level select screen. These are shown as hints on the bottom of the screen. 
    # Max: 55 (with all collections included)
    # Default: All levels in chosen collections.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 55
    55: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-55: 0 # random value between 1 and 55

  required_s_ranks:
    # How many S Ranks must be achieved on any level to finish the game.
    # If more levels are chosen that the maximumem available the levels get capped at the maximum available.
    # The required number of S ranks can be tracked on the level select screen. These are shown as hints on the bottom of the screen. 
    # Max: 52 (with all collections included)
    # Default: 0
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 52
    0: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-52: 0 # random value between 0 and 52

  required_bonus_objectives:
    # How many Bonus Objectives must be completed on any level to finish the game.
    # If more Bonus Objectives are chosen that the maximumem available the objectives get capped at the maximum available.
    # The required number of Bonus Objectives can be tracked on the level select screen. These are shown as hints on the bottom of the screen.
    # Max: 104 (with all collections included)
    # Default: 0
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 104
    0: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-104: 0 # random value between 0 and 104

  include_story:
    # Include all Story levels.
    # In total this adds 27 levels.
    # If no collections are chosen, Story levels are included by default.
    'false': 0
    'true': 50

  include_non_gameplay_levels:
    # Include non-gameplay levels, such as the tutorial and Story levels that are mostly cutscenes.
    # Only applies if the Story collection is included.
    # In total this includes 3 levels: Story Level 1, 25 & 27.
    # These levels add one check and pose no challenge.
    'false': 50
    'true': 0

  include_horde_levels:
    # Remove all Horde Levels from the active level pool.
    # In total this includes 5 levels accros 3 collections: Story Level 8, 15 & 26, Challenge Level 8, Support Group Level 9.
    'false': 0
    'true': 50

  include_story_s_rank:
    # Include S Rank locations for Story levels.
    # Each Story level will have an additional check for achieving an S Rank.
    'false': 50
    'true': 0

  include_story_bonus_objectives:
    # Include two Bonus Objectives for Story levels. 
    # Adds 2 extra location for each level.
    'false': 50
    'true': 0

  include_challenge:
    # Include all Challenge levels.
    # In total this adds 12 levels.
    # If no collections are chosen, Story levels are included by default.
    'false': 50
    'true': 0

  include_challenge_s_rank:
    # Include S Rank locations for Challenge levels.
    # Each Challenge level will have an additional check for achieving an S Rank.
    'false': 50
    'true': 0

  include_challenge_bonus_objectives:
    # Include two Bonus Objectives for Challenge levels. 
    # Adds 2 extra location for each level.
    'false': 50
    'true': 0

  include_support_group:
    # Include all Support Group levels.
    # In total this adds 9 levels.
    # If no collections are chosen, Story levels are included by default.
    'false': 50
    'true': 0

  include_support_group_s_rank:
    # Include S Rank locations for Support Group levels.
    # Each Support Group level will have an additional check for achieving an S Rank.
    'false': 50
    'true': 0

  include_support_group_bonus_objectives:
    # Include two Bonus Objectives for Support Group levels. 
    # Adds 2 extra location for each level.
    'false': 50
    'true': 0

  include_cold_sweat:
    # Include all Cold Sweat levels.
    # In total this adds 7 levels.
    # Cold Sweat is intended to be the most challenging collection in I Am Your Beast.
    # It is possible you will not be able to finish one or more levels.
    # If no collections are chosen, Story levels are included by default.
    # If Weapons unlocks are enabled, you are not able to choose ONLY Cold Sweat levels.
    'false': 50
    'true': 0

  include_cold_sweat_s_rank:
    # Include S Rank locations for Cold Sweat levels.
    # Each Cold Sweat level will have an additional check for achieving an S Rank.
    # Cold Sweat levels are already very challenging, so S Ranks may be extremely difficult.
    'false': 50
    'true': 0

  include_cold_sweat_bonus_objectives:
    # Include two Bonus Objectives for Cold Sweat levels. 
    # Adds 2 extra location for each level.
    'false': 50
    'true': 0

  include_snowmen:
    # Include Destroying the secret Snowman on each of the included levels as a location.
    # In total this can add 51 checks to the game.
    'false': 50
    'true': 0

  pickup_locations:
    # This option makes all heal and armor items location in each of the levels. The items still give their normal effects.
    # Yellow highlighted pickups have not yet been collected.
    # None - Option is turned off.
    # Individual - Every pickup is its own location. Each one sends a check on first use.
    # Grouped - Pickups are grouped by levels. A check is sent when you pick up all of them in a level. Has to be done in one try.
    none: 50
    individual: 0
    grouped: 0

  minimap_type:
    # This option changes the minimap to also show armor type pickups on the minimal.
    # Default - Game default minimap, only shows health pickups.
    # Armor (No Color) - Armor pickups are shown on the minimap with the health pickup icon, but they are the same color.
    # Armor (Color) - Armor pickups are shown on the minimap with the health pickup icon, but they are green or blue.
    default: 50
    armor_no_color: 0
    armor_color: 0

  kick_unlock:
    # Makes the Kick an unlockable item and shuffles it into the item pool.
    'false': 50
    'true': 0

  weapon_unlock:
    # Makes weapons and equipment unlockable items and shuffles them into the item pool. You will only have the Tree Bark unlocked at the start of the game.
    'false': 50
    'true': 0

  minimal_conditions:
    # NOT YET AVAILABLE — this option is always disabled.
    # Only parts of it are done, will be added in a future update.
    # 
    # Hard mode option for the levels. Each levels S rank and on harder levels completion logic will assume you only need the minimal required weapons to complete the checks.
    # Standard logic is base game logic, meaning you need most of the weapons on a level to be able to achieve an S rank. Only matters if weapons are randomized.
    'false': 50
    'true': 0

  glitched_logic:
    # NOT YET AVAILABLE — this option is always disabled.
    # Only parts of it are done, will be added in a future update.
    # 
    # Includes out of bounds skips and item duplications in the logic. Only matters if weapons are randomized.
    'false': 50
    'true': 0

  include_traps:
    # Include trap items in the filler item pool.
    # Traps are negative effects sent to other players, such as bleeding, being disarmed, or being immobilized.
    'false': 50
    'true': 0

  death_link:
    # When you die, everyone who enabled death link dies. Of course, the reverse is true too.
    'false': 50
    'true': 0

  deathlink_amnesty:
    # The number of deaths needed to send out a deathlink event
    # Deathlink can be disabled entirely.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 100
    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-100: 0 # random value between 1 and 100

  trap_chance:
    # The percentage chance that a filler item rolled for the item pool becomes a trap instead of a regular filler item.
    # Only applies if Include Traps is enabled.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 100
    25: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-100: 0 # random value between 0 and 100

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