# 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 Slay the Spire Template

game: Slay the Spire
requires:
  version: 0.5.1 # Version of Archipelago required for this yaml to work as expected.

Slay the Spire:
  # 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

  character:
    # Enter the internal ID of the character to use.
    # 
    #   if you don't know the exact ID to enter with the mod installed go to
    #  `Mods -> Archipelago Multi-world -> config` to view a list of installed modded character IDs.
    # 
    #  the downfall characters will only work if you have downfall installed.
    # 
    #  Spire Take the Wheel will have your client pick a random character from the list of all your installed characters
    #  including custom ones.
    # 
    #  if the chosen character mod is not installed it will default back to 'The Ironclad'
    the_ironclad: 50
    the_silent: 0
    the_defect: 0
    the_watcher: 0
    the_hermit: 0
    the_slime_boss: 0
    the_guardian: 0
    the_hexaghost: 0
    the_champ: 0
    the_gremlins: 0
    the_automaton: 0
    the_snecko: 0
    spire_take_the_wheel: 0

  ascension:
    # What Ascension do you wish to play with.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 20
    0: 50
    random: 0
    random-low: 0
    random-high: 0

  final_act:
    # Whether you will need to collect the 3 keys and beat the final act to complete the game.
    'false': 50
    'true': 0

  downfall:
    # When Downfall is Installed this will switch the played mode to Downfall
    'false': 50
    'true': 0

  death_link:
    # Percentage of health to lose when a death link is received.
    #
    # 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

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