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

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

Deadlock:
  ################
  # 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_type:
    # How game completion is determined.
    # 
    # - **Unique Characters:** Win with N different characters.
    # - **Total Wins:** Win N matches total.
    # - **Spirits:** Collect N Spirits (MacGuffin) to win.
    # - **Win with Character:** Collect X Spirits to unlock your chosen final character, then win one match with that character.
    unique_characters: 50
    total_wins: 0
    spirits: 0
    win_with_character: 0

  unique_characters_to_win:
    # Number of unique characters you must win with to finish (1-38).
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 38
    10: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-38: 0 # random value between 1 and 38

  total_wins_to_win:
    # Number of total match wins you must achieve to finish.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # 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-1-100: 0 # random value between 1 and 100

  spirits_to_win:
    # Number of Spirits (MacGuffin) you must collect to finish. Max depends on game mode (Standard: 162, Street Brawl: 143).
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 162
    10: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-162: 0 # random value between 1 and 162

  spirits_to_unlock_final:
    # Number of Spirits (MacGuffin) you must collect to unlock your final character (Win with Character goal).
    # 
    # The world caps this below the usual Spirits max by three: the final hero's three win checks require
    # this many Spirits first and may themselves contain Spirits, so the threshold must be reachable using
    # other locations only.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 162
    10: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-162: 0 # random value between 1 and 162

  final_character:
    infernus: 50
    seven: 0
    vindicta: 0
    lady_geist: 0
    abrams: 0
    wraith: 0
    mcginnis: 0
    paradox: 0
    dynamo: 0
    kelvin: 0
    haze: 0
    holliday: 0
    bebop: 0
    calico: 0
    grey_talon: 0
    mo_and_krill: 0
    shiv: 0
    ivy: 0
    warden: 0
    yamato: 0
    lash: 0
    viscous: 0
    pocket: 0
    mirage: 0
    vyper: 0
    sinclair: 0
    mina: 0
    drifter: 0
    venator: 0
    victor: 0
    paige: 0
    doorman: 0
    billy: 0
    graves: 0
    apollo: 0
    rem: 0
    silver: 0
    celeste: 0

  game_mode:
    # Which game mode locations are included. Only checks for the selected mode exist in the seed.
    standard: 50
    street_brawl: 0

  exclude_hard_locations:
    # When enabled, locations marked as hard (MVP/Key Player, high kills, fast rounds, etc.) are removed from the seed.
    '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.
    []
