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

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

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

  amount_of_grass:
    # In this randomizer, your goal is to collect enough grass and go to the final platform.
    # This option sets the total amount of grass in the game. Remaining items become flower filler items.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 10
    # Maximum value is 160
    100: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-10-160: 0 # random value between 10 and 160

  required_grass_percentage:
    # This options sets the percentage of grass you need in order to win when you go to the final platform.
    # 0 means you don't need any grass at all and just need to find the final platform.
    # Note: choosing max grass and 100% required may lead to some FillErrors in solo games.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 100
    70: 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

  goal:
    # Sets which button or platform is the goal that needs to be reached to win the game.
    # You can choose the following:
    # - Button 31-1: the goal from the original, the golden button!
    # - Button 1-1: the first button in the game.
    # - random_known_button: a random button. The UI will show you which button it is.
    # - random_unknown_button: a random button. The UI will NOT show you which button it is until pressed.
    # - Platform 1-5: right next to the starting platform
    # - Platform 21-1: easy to reach platform in Cluster 21 (bottom-left)
    # - Platform 29-2: epic high platform in Cluster 29 for which you need Cluster 25 and jumppads (top-left)
    # - random_known_platform: randomly chosen platform. The UI will show you which platform it is.
    # - random_unknown_platform: randomly chosen platform. The UI will NOT show you which platform it is until you jump on it.
    # - random_known: a random button or platform. The UI will show you which one it is.
    # - random_unknown: a random button or platform. The UI will NOT show you which one it is.
    # Note: if you choose an unknown goal, you can !hint Goal Location and it will tell you the location.
    button_31_1: 50
    button_1_1: 0
    random_known_button: 0
    random_unknown_button: 0
    platform_1_5: 0
    platform_21_1: 0
    platform_29_2: 0
    random_known_platform: 0
    random_unknown_platform: 0
    random_known: 0
    random_unknown: 0

  cubes:
    # Cubes are also location checks in the main gamemode! This option determines when you can collect cubes.
    # Always: cubes are always collectable (they are red).
    # Red Cubes Bag: you need to find the Red Cubes Bag item first to be able to collect cubes.
    # Never: there are no cubes at all in your game (and they are not location checks).
    always: 0
    red_cubes_bag: 50
    never: 0

  extra_cubes:
    # This option adds extra cubes throughout the main game (above water).
    # For some you need Pipes (some are *in* pipes), Jump Pads or Swim.
    # Always: extra cubes are always collectable (they are green).
    # Red Cubes Bag: you need to find the Red Cubes Bag item first to be able to collect extra cubes.
    # Green Cubes Bag: you need to find the Green Cubes Bag item first to be able to collect extra cubes.
    # Never: there are no extra cubes at all in your game.
    always: 0
    red_cubes_bag: 0
    green_cubes_bag: 50
    never: 0

  number_of_minigames:
    # Refunct allows for adding several minigames to your game, which you have to unlock first.
    # This options sets how many minigames are included in the game.
    # Set this to -1 if you want all minigames. Set this to 0 if you don't want any minigames.
    # Another option allows you to tweak how likely each minigame is to be included, but the default is probably OK!
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is -1
    # Maximum value is 15
    7: 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

  nerf_minigame_checks:
    # Most minigames have a lot of checks (~37).
    # If this option is *on*, flowers will be forced into the minigames, so that only 10 items per minigame are not necessarily flowers.
    # With the option *off*, all items in the minigames are actual checks.
    'false': 50
    'true': 0

  number_of_unlocks_per_minigame:
    # Each minigame needs to be unlocked first by finding its unlock item in the main game.
    # This option sets how many unlock items of each minigame are there in the main game.
    # Just one unlock item is enough to play, so having more than one makes it more likely that you can play that minigame.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 2
    1: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-2: 0 # random value between 1 and 2

  minigames_likeliness:
    # Refunct allows for adding several minigames to your game, which each have their own items and locations.
    # You can switch between Move Rando (main game) and the minigames in the Archipelago menu in-game.
    # This setting determines the likeliness of each minigame to be included.
    # The default settings are tweaked already so that the "better" minigames are more likely to appear.
    # You can set the likeliness of a minigame to 0 and it will never appear. 
    # 
    # Vanilla Minigame:
    # Adding this minigame will let you play the original vanilla refunct game, once you unlock it.
    # You have all your abilities and every button is a check.
    #  
    # Seeker Minigame:
    # Adding this minigame will let you search for 10 platforms that are not grassified yet, once you unlock it.
    # You have all your abilities and jumping on empty platforms will give you checks.
    #  
    # Button Galore Minigame:
    # This minigame spawns you in a game with all plaforms already there.
    # And you just press every button that there is for a check.
    # 
    # OG Randomizer Minigame:
    # This is where it all started, you'll get to play the very first Refunct randomizer.
    # Hitting a button triggers a random platform to appear somewhere in the level, and it gives a check!
    # 
    # Block Brawl Minigame:
    # A randomly generated arena of blocks appears, and your goal is to get the cubes within them.
    # There are four colors of cubes, each has to be unlocked separately.
    # The number of checks are 5, 20, 45 and 80 in total if you have 1, 2, 3 or 4 colors unlocked respectively.
    # The more blocks you pick up in one go, the more points you get. Score points to get checks!
    # Hitting New Game will reshuffle the blocks and cubes but you will keep your points.
    # There is no guarantee cubes are reachable so reset as needed.
    # 
    # Climb Minigames:
    # There are different Climb minigames that you can play: Line, Spiral, Chaos and Narrow.
    # You will have to climb up 100 meters of randomly placed platforms, and you get checks for every 10 meters climbed.
    # Each minigame has a slightly different pattern of platform placements.
    # These gamemodes might need some skill and patience (which is why they are off by default) :)
    # 
    # Block Blub Minigame:
    # This is the underwater version of Block Brawl!
    # This is much easier and shorter than Block Brawl, it still has four color of cubes, but only 32 checks in total.
    # 
    # Refunct Mountain Minigame:
    # The vanilla game, except there's no wall jump, ledge grab, lifts and pipes.
    # Instead, there is a dash! Press the buttons for checks.
    # PRESS E TO DASH, YOU (CURRENTLY) CANNOT REBIND THIS IN-GAME (which is why it's off by default)
    # Tip: use steam controller settings to map dash to a button of your choice.
    # 
    # Rando Mountain Minigame:
    # Randomized button order in a world with *only* jump and dash (no swim or anything else).
    # Press the buttons for checks.
    # PRESS E TO DASH, YOU (CURRENTLY) CANNOT REBIND THIS IN-GAME (which is why it's off by default)
    # Tip: use steam controller settings to map dash to a button of your choice.
    # 
    # Funny Bridge Game Minigame:
    # Based on the Glass Bridge game from Squid Game.
    # Five pairs of platforms appear, but only one of each pair is real.
    # Are you lucky enough to beat the game?
    # This minigame has one check :)
    # 
    # Clique:
    # Based on Archipelago game "Clique". Hard-mode!
    # There is one free item in this minigame. Once the "button activation" item is found, 
    # you can press the button for another check.
    # 
    # Custom Minigame:
    # You can now play custom maps as part of archipelago! Every button you press is a check.
    # Download *any* custom map you want, you can find them pinned in the archipelago-refunct post/thread.
    # Put the custom map in the correct folder (open the mod, press CTRL+SHIFT+M, "Open Maps Folder").
    # And then when starting the minigame, choose the map you want to play!
    Block Blub Minigame: 2
    Block Brawl Minigame: 5
    Button Galore Minigame: 2
    Climb Chaos Minigame: 1
    Climb Line Minigame: 1
    Climb Narrow Minigame: 1
    Climb Spiral Minigame: 1
    Clique: 1
    Custom Minigame: 1
    Funny Bridge Game Minigame: 1
    OG Randomizer Minigame: 5
    Rando Mountain Minigame: 5
    Refunct Mountain Minigame: 2
    Seeker Minigame: 2
    Vanilla Minigame: 2

  see_other_players:
    # When other players have this on too, you can see them walking around in your world!
    # This option is the number of other players you can see. 0 means it is off.
    # You can probably just pick a large number, but the game might lag if you pick too many.
    # Don't worry, you can change this setting in-game too!
    #
    # 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

  effects_and_traps:
    # Refunct has many effect- and trap items. This option will replace flowers by them.
    # This option determines the amount each of them is added.
    # An effect is usually just a pretty visual effect.
    # A trap will affect the gameplay a bit more.
    # Don't worry if you put too many,
    Ascend Trap: 1
    Blurrrgh Trap: 1
    Dark Skies: 3
    Depthless Trap: 1
    Fast-mo Trap: 1
    Hurricane: 3
    No Skylight: 3
    Red Sky: 3
    Slo-mo Trap: 1
    Starry Sky: 3

  rename_grass:
    # This option changes "Grass" to names of actual grass types such as "Fine fescue" and "Kentucky bluegrass".
    # You can choose between the English or the Latin names of the grass types.
    none: 50
    english: 0
    latin: 0
    both: 0

  rename_flowers:
    # This option changes "Flower" to names of actual flowers such as "Rose" and "Tulip".
    # You can choose between the English or the Latin names of the flowers.
    none: 50
    english: 0
    latin: 0
    both: 0

  death_link:
    # When you die, everyone who enabled death link dies. Of course, the reverse is true too.
    'false': 50
    'true': 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.
    []
