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

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

GLYPHS:
  ################
  # 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:
    # Determines what ending must be reached for Archipelago to consider your game as complete.
    # Note: This option does not affect location/item pools so you still may have to complete more of the game than you would think.
    false_ending: 0
    good_ending: 0
    true_ending: 50
    all_star_endings: 0
    epilogue: 0
    all_endings: 0

  StartingSword:
    # Start the game with the sword.
    'false': 50
    'true': 0

  StartingDash:
    # Start the game with dash unlocked.
    'false': 50
    'true': 0

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

  RandomShopPrices:
    # Randomizes the prices of shop items.
    # Never exceeds 10 total.
    'false': 0
    'true': 50

  RandomButtonColorPercent:
    # Percent of buttons to randomize the color of.
    # IMPORTANT:
    # This option is known to cause issues with the universal tracker.
    # By enabling it, you accept that it will not be fully reliable.
    #
    # 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

  ExcludeBlack:
    # Ensures no buttons are randomized to black.
    'false': 50
    'true': 0

  EnableTraps:
    # Adds traps to the itempool
    'false': 0
    'true': 50

  TrapTypes:
    # Determines what kinds of traps will be added to the item pool
    # Valid Keys:
    # Momentum Trap: Launches the player at a random angle
    # John Trap: Spawns John for 1 minute
    # Slow Trap: Slows the player down for a short period of time
    # Screen Flip Trap: Flips the player's screen for a short period of time
    # Dash Trap: Slows the player's dash for a short period of time
    ['Screen Flip Trap', 'Dash Trap', 'Momentum Trap', 'Slow Trap', 'John Trap']

  HatShuffle:
    # Include hats in the item pool
    # If enabled, hats will replace some junk items and traps
    # If disabled, all hats will be included in starting inventory
    'false': 0
    'true': 50

  SwordlessCombat:
    # Swordless combat is considered in logic.
    # Ex: Fighting with only dash attacks
    'false': 50
    'true': 0

  DashPuzzlesSolved:
    # Logic assumes you already have the answer to all the puzzles in the game written down somewhere.
    'false': 50
    'true': 0

  LogicalWallJumps:
    # Considers skips utilizing wall jumps in logic.
    'false': 50
    'true': 0

  FlowerPuzzleSkips:
    # Considers skips utilizing the flower puzzle in logic.
    'false': 50
    'true': 0

  WizardRequirements:
    # Determines the number of glyphstones required to trigger the wizard fight
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 3
    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-3: 0 # random value between 0 and 3

  WraithRequirements:
    # Determines requirements to enter the Wraith boss room.
    # None: Boss room can be entered without any additional items
    # Vanilla: Boss room requires 15 silver shards
    # Intended: Boss room requires 15 silver shards and 3 glyphstones
    # Silver Shards: Boss room requires a configurable number of silver shards
    # Gold Shards: Boss room requires a configurable number of gold shards
    # Smile Tokens: Boss room requires a configurable number of smile tokens
    # Rune Cubes: Boss room requires a configurable number of rune cubes
    # Glyphstones: Boss room requires a configurable number of glyphstones
    none: 50
    vanilla: 0
    intended: 0
    silver_shards: 0
    gold_shards: 0
    smile_tokens: 0
    rune_cubes: 0
    glyphstones: 0

  WraithSilverCount:
    # The number of silver shards required to enter the wraith boss room.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 15
    15: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-15: 0 # random value between 1 and 15

  WraithGoldCount:
    # The number of gold shards required to enter the wraith boss room.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 3
    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-3: 0 # random value between 1 and 3

  WraithSmileCount:
    # The number of smile tokens required to enter the wraith boss room.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 10
    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-10: 0 # random value between 1 and 10

  WraithRuneCount:
    # The number of rune cubes required to enter the wraith boss room.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 3
    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-3: 0 # random value between 1 and 3

  WraithGlyphstoneCount:
    # The number of glyphstones required to enter the wraith boss room.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 3
    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-3: 0 # random value between 1 and 3

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