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

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

Riven:
  ################
  # 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 Options #
  ################
  goal:
    # Determines the victory condition.
    # 
    # Good Ending: Trap Gehn, Free Catherine, and open the Star Fissure. The full Riven experience.
    # Star Fissure: Open the Star Fissure. A more streamlined experience with no need to visit Tay or 233.
    good_ending: 50
    star_fissure: 0

  extra_progressive_star_fissure_telescope_solutions:
    # Determines how many extra Progressive Puzzle Solution: Star Fissure Telescope items are added to the pool.
    # No matter your goal, you will always need 10 to logically be able to reach it.
    # 
    # 0 means you need 10 / 10
    # 5 means you need 10 / 15
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 5
    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-5: 0 # random value between 0 and 5

  ####################
  # Gameplay Options #
  ####################
  starting_movement_speed:
    # Determines the starting walk / run speed.
    # 
    # Slower: Slower walk / run speed than vanilla (400 -> 300 units)
    # Vanilla: Vanilla walk / run speed (400 units)
    # Faster: Faster walk / run speed than vanilla (400 -> 500 units)
    # 
    # You can optionally add Progressive Movement Speed items to the pool to speed you up.
    slower: 0
    vanilla: 50
    faster: 0

  progressive_movement_speed_item_count:
    # Determines how many extra Progressive Movement Speed items are added to the pool.
    # Each Progressive Movement Speed adds 100 units (Vanilla walk / run speed is 400 units)
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 5
    3: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-5: 0 # random value between 0 and 5

  ################
  # Trap Options #
  ################
  trap_percentage:
    # Determines what percentage of filler items will get converted to trap items.
    # 
    # Trap Items are made up of the following types:
    # - Post-Processing Effects (Black and White, Bloom, Chromatic, Color Inversion, Mobile Game, Tunnel Vision)
    # - Movement Speed Effects (Slow)
    #
    # 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 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

  trap_weights:
    # Determines the relative weights of each Trap Type if Trap Percentage is greater than 0.
    # 
    # Each weight is required to be zero or more.
    Black and White Trap: 1
    Bloom Trap: 1
    Chromatic Trap: 1
    Color Inversion Trap: 1
    Mobile Game Trap: 1
    Slow Trap: 1
    Tunnel Vision Trap: 1

  trap_duration:
    # Determines how long each trap will last (in seconds).
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 20
    # Maximum value is 300
    30: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-20-300: 0 # random value between 20 and 300

  ###########################
  # 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_inventory_from_pool:
    # Start with the specified amount of these items and don't place them in the world. Example: "Bomb: 1"
    # 
    # The game decides what the replacement items will be.
    {}

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