# 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 MultiworldGG options are valid at this site:
#        https://multiworld.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 Pikuniku Template

game: Pikuniku
requires:
  version: 0.7.263 # Version of MWGG required for this yaml to work as expected.
  game:
    Pikuniku: 0.3.1 # Version of the world required for this yaml to work as expected.

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

  allow_collecting_from:
    # If other players are allowed to '!collect' items from your world.
    'false': 0
    'true': 50

  ##################
  # Sanity Options #
  ##################
  coinsanity:
    # Adds every freestanding coin in the world as a location check.
    # When enabled, Coins are added to the item pool as progression items,
    # and shop purchases logically require receiving Coins.
    'false': 50
    'true': 0

  ################
  # Item Options #
  ################
  early_pencil_hat:
    # Determines how the Pencil Hat is placed.
    # 
    # - Early Local: Placed in an early sphere in your own world.
    # - Early Global: Placed in an early sphere any world in the multiworld. (Default)
    # - Shuffled: Placed anywhere in the multiworld. This will make you get stuck quickly.
    early_local: 0
    early_global: 50
    shuffled: 0

  ####################
  # Cosmetic Options #
  ####################
  piku_color:
    # Randomizes Piku's color scheme.
    # 
    # Accepts one of the named modes below, or a 6-digit hex color code
    # (e.g. "#FF0000" or "FF0000") to force Piku to always use that exact color.
    # 
    # - Off: Piku keeps its normal color. (Default)
    # - Random Per Screen: Piku is given a new random color every time you enter a screen.
    # - Random Per Seed: Piku is given a single random color for the entire seed.
    'off': 50
    random_per_screen: 0
    random_per_seed: 0

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

  death_link_amnesty:
    # How many deaths it takes to send a DeathLink. DeathLinks only apply during the
    # platforming challenges or bossfights.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 30
    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-30: 0 # random value between 1 and 30

  ######################
  # Excluded Locations #
  ######################
  exclude_locations:
    # Prevent these locations from having an important item.
    ['Sunshine HQ Dancing Bug', 'Mr. Sunshine Trophy', 'Sunshine Inc. Robot Trophy']

  ###########################
  # 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, Arrow: 3}
    {}

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

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