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

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

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

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

  goal:
    # The goal required to complete the game for Archipelago.
    # 
    # 10 Hyperstones: Collect 10 Hyperstones.
    # 
    # 50 Hyperstones: Collect 50 Hyperstones.
    # 
    # Orb of Yendor: Successfully collect an Orb of Yendor.
    10_hyperstones: 0
    50_hyperstones: 0
    orb_of_yendor: 50

  treasure_requirements:
    # The treasure numbers per land included in the randomization.
    '10': 0
    '25': 50
    '50': 0

  starting_land:
    # The land each run starts in. It is recommended to choose the starting to land to be unlocked from the beginning.
    crossroads_1: 50
    crossroads_2: 0
    crossroads_3: 0
    crossroads_4: 0
    random_unlocked_land: 0
    icy_land: 0
    living_cave: 0
    desert: 0
    jungle: 0
    alchemist_lab: 0
    hall_of_mirrors: 0
    graveyard: 0
    hell: 0
    land_of_eternal_motion: 0
    cocytus: 0
    dry_forest: 0
    vineyard: 0
    dead_cave: 0
    hive: 0
    emerald_mine: 0
    land_of_power: 0
    red_rock_valley: 0
    minefield: 0
    ocean: 0
    palace: 0
    living_fjord: 0
    zebra: 0
    elemental_planes: 0
    land_of_storms: 0
    overgrown_woods: 0
    windy_plains: 0
    rose_garden: 0
    warped_coast: 0
    dragon_chasms: 0
    burial_grounds: 0
    trollheim: 0
    reptiles: 0
    prairie: 0
    bull_dash: 0
    volcanic_wasteland: 0
    hunting_ground: 0
    blizzard: 0
    terracotta_army: 0
    ruined_city: 0
    jelly_kingdom: 0
    irradiated_field: 0
    wetland: 0
    frog_park: 0
    eclectic_city: 0
    cursed_canyon: 0
    dice_reserve: 0

  logic_difficulty:
    # Whether logic assures you have helpful orbs before attempting to reach 25 or 50 in a given land.
    normal: 50
    hard: 0

  hint_orb:
    # When this setting is activated, once you have at least 10 treasures in any land, Orbs of Foresight can spawn in that land. When an Orb of Foresight is collected, the next available location in that land is hinted.
    'false': 50
    'true': 0

  extra_location_10:
    # Adds an extra location for 10 Treasures in each land
    'false': 50
    'true': 0

  extra_location_25:
    # Adds an extra location for 10 Treasures in each land
    'false': 50
    'true': 0

  extra_location_50:
    # Adds an extra location for 10 Treasures in each land
    'false': 50
    'true': 0

  start_orb_fill_percentage:
    # The percentage of filler items replaced by Starting Orbs - Orbs which are placed in your inventory at the start of each run.
    #
    # 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

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