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

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

CloverPit:
  ################
  # 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:
    # Goals:
    # Key goal: Go out the door with specific key
    # 
    # Deadline: Beat deadline x, y amount of times
    # 
    # Memory Packs: Beat x amount of unique memory packs
    key: 50
    deadline: 0
    memory_packs: 0

  ending_type:
    # For key ending:
    # Bad ending: Go out the door with skeleton key
    # Good ending: Go out the door with sacred key (999 + skeleton key)
    skeleton_key_bad_ending: 50
    sacred_key_good_ending: 0

  deadline_goal:
    # Determines what deadline should be reached to beat deadline goal
    # (Goal: Beat deadline x, y amount of times)
    # This is x
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 8
    # Maximum value is 25
    12: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-8-25: 0 # random value between 8 and 25

  deadline_amount:
    # Determines how many of the deadlines should be beat to goal
    # (Goal: Beat deadline x, y amount of times)
    # This is y
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 25
    5: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-25: 0 # random value between 1 and 25

  memory_goal:
    # Determines how many memory cards should be beat to goal
    # (Goal: Beat x amount of unique memory packs)
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 19
    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-19: 0 # random value between 1 and 19

  extra_checks:
    # [Sacred]
    # Adds all sacred/holy charms and calls as locations
    # (14 locations) - (Only recommended for ASync)
    # 
    # [Memory]
    # Adds all memory cards as locations
    # (19 locations) - (Only recommended for ASync)
    'off': 50
    sacred: 0
    memory: 0
    both: 0

  clover_trap_percent:
    # How many of your clover tickets are lost when reciving a clover trap
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 25
    # Maximum value is 100
    50: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-25-100: 0 # random value between 25 and 100

  coin_trap_percent:
    # How many of your coins are lost when reciving a clover trap
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 25
    # Maximum value is 100
    50: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-25-100: 0 # random value between 25 and 100

  trap_amount:
    # How many clover and coin traps there will be of each
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 25
    7: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-25: 0 # random value between 0 and 25

  deathlink:
    # Deathlink settings: (Ankh still saves you but not others)
    # 
    # Normal: Sends deathlink upon any death recieved besides restart
    # 
    # Include restart: Sends deathlinks upon any death recieved
    'off': 50
    normal: 0
    include_restart: 0

  hardmode:
    # Makes the game be in hard mode
    '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.
    []
