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

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

Muck:
  ################
  # Game Options #
  ################
  logicDifficulty:
    # Only used in logic to determine how many powerups/weapons/armors you need to defeat bosses
    # Will cause generation errors when using a low difficulty and a small item pool
    # 
    # Easy will wait until you have a LOT of powerups and weapons before saying you can fight bosses
    # None will assume you can beat everything with nothing but a rock
    # Normal and Hard are in-betweens
    # 
    # It is NOT recommended to play with None
    easy: 0
    normal: 50
    hard: 0
    none: 0

  #########################
  # Powerup Items Options #
  #########################
  whitePowerupItemWeight:
    # When you receive a powerup item, the weight of this powerup being white
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 50
    5: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-50: 0 # random value between 0 and 50

  bluePowerupItemWeight:
    # When you receive a powerup item, the weight of this powerup being blue
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 50
    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-50: 0 # random value between 0 and 50

  orangePowerupItemWeight:
    # When you receive a powerup item, the weight of this powerup being orange
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 50
    1: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-50: 0 # random value between 0 and 50

  #####################
  # Locations Options #
  #####################
  includeExoticArmors:
    # Wether to add crafting Wolfskin armor and Chunkium armor as locations
    'false': 50
    'true': 0

  includeLegendaryWeapons:
    # Wether to add crafting legendary weapons as locations
    # These are the Wyvern Dagger, Gronk's Sword, Chunky Hammer, Night Blade, Chiefs Spear and Ancient Bow
    'false': 50
    'true': 0

  #############################
  # Powerup Locations Options #
  #############################
  nbPowerupRegions:
    # How many regions to create in logic and put powerups pickup locations into
    # The logic uses multiple regions in order to force late powerups locations (example, White Powerup 87) to be in later spheres (so that one of your friends doesn't need it to enter their sphere 2 for example)
    # Higher values means that it's less likely for powerups locations you will get pretty late to contain items needed earlier
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 20
    4: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-20: 0 # random value between 1 and 20

  whitePerRegion:
    # How many white powerup pickup location to put in each region
    # Note that the total ammount of white powerups you will need to pickup to get the whole location pool is Number Of Regions * Number Of Location Per Region
    # White powerup locations picked up after that won't give you anything
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 50
    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-50: 0 # random value between 1 and 50

  bluePerRegion:
    # Same as above but for the blue powerup locations
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 50
    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-50: 0 # random value between 1 and 50

  orangePerRegion:
    # Same as above but for the orange powerup locations
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 50
    2: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-50: 0 # random value between 1 and 50

  ####################
  # Gameplay Options #
  ####################
  allowLootAsLocations:
    # Allows you to get the locations for crafting tools/weapons/armors by obtaining them through other means
    # (Looting chests, buying from woodmen...)
    'false': 50
    'true': 0

  startingWeapon:
    # What weapon to start with to make the beggining more fun
    # If you choose None, you might have to farm your first powerup region with just a rock
    sword: 50
    bow: 0
    both: 0
    none: 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.
    []
