From 33510f72a9d7b31711feae164bb05bbe5efa89d0 Mon Sep 17 00:00:00 2001 From: alwaysintreble Date: Wed, 29 Jun 2022 10:29:55 -0500 Subject: [PATCH 1/4] advanced yaml cleanup --- worlds/generic/docs/advanced_settings_en.md | 58 ++++++++++----------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/worlds/generic/docs/advanced_settings_en.md b/worlds/generic/docs/advanced_settings_en.md index 11d01c3fc4a0..38b7f3975e87 100644 --- a/worlds/generic/docs/advanced_settings_en.md +++ b/worlds/generic/docs/advanced_settings_en.md @@ -52,7 +52,7 @@ For `nested_option_two`, `option_two_setting_one` will be rolled 14 times and `o times against each other. This means `option_two_setting_two` will be more likely to occur, but it isn't guaranteed, adding more randomness and "mystery" to your settings. Every configurable setting supports weights. -### Root Options +## Root Options Currently, there are only a few options that are root options. Everything else should be nested within one of these root options or in some cases nested within other nested options. The only options that should exist in root @@ -95,14 +95,14 @@ games you want settings for. more triggers in the triggers guide. Triggers guide: [Archipelago Triggers Guide](/tutorial/Archipelago/triggers/en) -### Game Options +## Game Options One of your root settings will be the name of the game you would like to populate with settings. Since it is possible to give a weight to any option it is possible to have one file that can generate a seed for you where you don't know which game you'll play. For these cases you'll want to fill the game options for every game that can be rolled by these settings. If a game can be rolled it **must** have a settings section even if it is empty. -#### Universal Game Options +### Universal Game Options Some options in Archipelago can be used by every game but must still be placed within the relevant game's section. @@ -174,6 +174,8 @@ A Link to the Past: - Moon Pearl start_location_hints: - Spike Cave + priority_locations: + - Links House exclude_locations: - Cave 45 item_links: @@ -207,49 +209,47 @@ Timespinner: * `description` gives us a general overview so if we pull up this file later we can understand the intent. * `name` is `Example Player` and this will be used in the server console when sending and receiving items. -* `game` has an equal chance of being either `A Link to the Past` or `Timespinner` with a 10/20 chance for each. The reason for this is becuase each game has a weight of 10 and the toal of all weights is 20. +* `game` has an equal chance of being either `A Link to the Past` or `Timespinner` with a 10/20 chance for each. This is +because each game has a weight of 10 and the total of all weights is 20. * `requires` is set to required release version 0.3.2 or higher. -* `accesibility` is set to `none` which will set this seed to beatable only meaning some locations and items may be - completely inaccessible but the seed will still be completable. +* `accessibility` is set to `none` which will set this seed to beatable only, so some locations and items may be +completely inaccessible but the seed will still be completable. * `progression_balancing` is set on, giving it the default value, meaning we will likely receive important items - earlier increasing the chance of having things to do. +earlier increasing the chance of having things to do. * `A Link to the Past` defines a location for us to nest all the game options we would like to use for our - game `A Link to the Past`. +game `A Link to the Past`. * `smallkey_shuffle` is an option for A Link to the Past which determines how dungeon small keys are shuffled. In this - example we have a 1/2 chance for them to either be placed in their original dungeon and a 1/2 chance for them to be - placed anywhere amongst the multiworld. +example we have a 1/2 chance for them to either be placed in their original dungeon and a 1/2 chance for them to be +placed anywhere amongst the multiworld. * `crystals_needed_for_gt` determines the number of crystals required to enter the Ganon's Tower entrance. In this - example a random number will be chosen from the allowed range for this setting (0 through 7) but will be weighted - towards a lower number. +example a random number will be chosen from the allowed range for this setting (0 through 7) but will be weighted +towards a lower number. * `crystals_needed_for_ganon` determines the number of crystals required to beat Ganon. In this example a number between - 1 and 7 will be chosen at random, weighted towards a high number. +1 and 7 will be chosen at random, weighted towards a high number. * `start_inventory` defines an area for us to determine what items we would like to start the seed with. For this - example we have: - * `Pegasus Boots: 1` which gives us 1 copy of the Pegasus Boots - * `Bombs (3)` gives us 2 packs of 3 bombs or 6 total bombs +example we have: + * `Pegasus Boots: 1` which gives us 1 copy of the Pegasus Boots + * `Bombs (3): 2` gives us 2 packs of 3 bombs or 6 total bombs * `start_hints` gives us a starting hint for the hammer available at the beginning of the multiworld which we can use - with no cost. +with no cost. * `local_items` forces the `Bombos`, `Ether`, and `Quake` medallions to all be placed within our own world, meaning we - have to find it ourselves. +have to find it ourselves. * `non_local_items` forces the `Moon Pearl` to be placed in someone else's world, meaning we won't be able to find it. * `start_location_hints` gives us a starting hint for the `Spike Cave` location available at the beginning of the - multiworld that can be used for no cost. +multiworld that can be used for no cost. +* `priority_locations` forces a progression item to be placed on the `Links House` location. * `exclude_locations` forces a not important item to be placed on the `Cave 45` location. * `item_links` * For `A Link to the Past` all players in the `rods` item link group will share their fire and ice rods and the player -items will be replaced with single rupees. - * For `Timespinner` all players in the `TSAll` item link group will share their entire item pool and the`Twin Pyramid - * For `A Link to the Past` all players in the `rods` item link group will share their fire and ice rods and the player items will be replaced with single rupees. * For `Timespinner` all players in the `TSAll` item link group will share their entire item pool and the `Twin Pyramid -Key` and `Timespinner Wheel` will be forced among the worlds of those in the group. The `null` replacement item will, instead -of forcing a specific chosen item, allow the generator to randomly pick a filler item in place of putting in another one of the linked item. +Key` and `Timespinner Wheel` will be forced among the worlds of those in the group. The `null` replacement item will, +instead of forcing a specific chosen item, allow the generator to randomly pick a filler item to replace the player items. * `triggers` allows us to define a trigger such that if our `smallkey_shuffle` option happens to roll the `any_world` - result it will also ensure that `bigkey_shuffle`, `map_shuffle`, and `compass_shuffle` are also forced to - the `any_world` - result. +result it will also ensure that `bigkey_shuffle`, `map_shuffle`, and `compass_shuffle` are also forced to the +`any_world` result. More information on triggers can be found in the [triggers guide](/tutorial/Archipelago/triggers/en). -### Generating Multiple Worlds +## Generating Multiple Worlds YAML files can be configured to generate multiple worlds using only one file. This is mostly useful if you are playing an asynchronous multiworld (shortened to async) and are wanting to submit multiple worlds as they can be condensed into one file, removing the need to manage separate files if one chooses to do so. @@ -257,7 +257,7 @@ As a precautionary measure, before submitting a multi-game yaml like this one in To configure your file to generate multiple worlds, use 3 dashes `---` on an empty line to separate the ending of one world and the beginning of another world. -#### Example +### Example ```yaml description: Example of generating multiple worlds. World 1 of 3 From 92a30977a3fd2efc9112c084102787dbfb0f513b Mon Sep 17 00:00:00 2001 From: alwaysintreble Date: Wed, 29 Jun 2022 10:49:47 -0500 Subject: [PATCH 2/4] Update advanced_settings_en.md --- worlds/generic/docs/advanced_settings_en.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/worlds/generic/docs/advanced_settings_en.md b/worlds/generic/docs/advanced_settings_en.md index 38b7f3975e87..592f41343a9e 100644 --- a/worlds/generic/docs/advanced_settings_en.md +++ b/worlds/generic/docs/advanced_settings_en.md @@ -175,7 +175,7 @@ A Link to the Past: start_location_hints: - Spike Cave priority_locations: - - Links House + - Link's House exclude_locations: - Cave 45 item_links: From 9e8a983d6de2bc832a19a39a31b0fcef9e3e7fa8 Mon Sep 17 00:00:00 2001 From: alwaysintreble Date: Wed, 29 Jun 2022 22:09:52 -0500 Subject: [PATCH 3/4] i hate this game now --- worlds/generic/docs/advanced_settings_en.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/worlds/generic/docs/advanced_settings_en.md b/worlds/generic/docs/advanced_settings_en.md index 592f41343a9e..5a88a9b5859e 100644 --- a/worlds/generic/docs/advanced_settings_en.md +++ b/worlds/generic/docs/advanced_settings_en.md @@ -237,7 +237,7 @@ have to find it ourselves. * `non_local_items` forces the `Moon Pearl` to be placed in someone else's world, meaning we won't be able to find it. * `start_location_hints` gives us a starting hint for the `Spike Cave` location available at the beginning of the multiworld that can be used for no cost. -* `priority_locations` forces a progression item to be placed on the `Links House` location. +* `priority_locations` forces a progression item to be placed on the `Link's House` location. * `exclude_locations` forces a not important item to be placed on the `Cave 45` location. * `item_links` * For `A Link to the Past` all players in the `rods` item link group will share their fire and ice rods and the player From 19aa54aa3d263ac27f7daf899823085aa1c403c3 Mon Sep 17 00:00:00 2001 From: alwaysintreble Date: Sat, 2 Jul 2022 13:13:40 -0500 Subject: [PATCH 4/4] formatting reverting --- worlds/generic/docs/advanced_settings_en.md | 38 ++++++++++----------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/worlds/generic/docs/advanced_settings_en.md b/worlds/generic/docs/advanced_settings_en.md index 5a88a9b5859e..a0808fb444f8 100644 --- a/worlds/generic/docs/advanced_settings_en.md +++ b/worlds/generic/docs/advanced_settings_en.md @@ -210,44 +210,44 @@ Timespinner: * `description` gives us a general overview so if we pull up this file later we can understand the intent. * `name` is `Example Player` and this will be used in the server console when sending and receiving items. * `game` has an equal chance of being either `A Link to the Past` or `Timespinner` with a 10/20 chance for each. This is -because each game has a weight of 10 and the total of all weights is 20. + because each game has a weight of 10 and the total of all weights is 20. * `requires` is set to required release version 0.3.2 or higher. -* `accessibility` is set to `none` which will set this seed to beatable only, so some locations and items may be -completely inaccessible but the seed will still be completable. +* `accessibility` is set to `none` which will set this seed to beatable only, so some locations and items may be + completely inaccessible but the seed will still be completable. * `progression_balancing` is set on, giving it the default value, meaning we will likely receive important items -earlier increasing the chance of having things to do. + earlier increasing the chance of having things to do. * `A Link to the Past` defines a location for us to nest all the game options we would like to use for our -game `A Link to the Past`. + game `A Link to the Past`. * `smallkey_shuffle` is an option for A Link to the Past which determines how dungeon small keys are shuffled. In this -example we have a 1/2 chance for them to either be placed in their original dungeon and a 1/2 chance for them to be -placed anywhere amongst the multiworld. + example we have a 1/2 chance for them to either be placed in their original dungeon and a 1/2 chance for them to be + placed anywhere amongst the multiworld. * `crystals_needed_for_gt` determines the number of crystals required to enter the Ganon's Tower entrance. In this -example a random number will be chosen from the allowed range for this setting (0 through 7) but will be weighted -towards a lower number. + example a random number will be chosen from the allowed range for this setting (0 through 7) but will be weighted + towards a lower number. * `crystals_needed_for_ganon` determines the number of crystals required to beat Ganon. In this example a number between -1 and 7 will be chosen at random, weighted towards a high number. + 1 and 7 will be chosen at random, weighted towards a high number. * `start_inventory` defines an area for us to determine what items we would like to start the seed with. For this -example we have: + example we have: * `Pegasus Boots: 1` which gives us 1 copy of the Pegasus Boots * `Bombs (3): 2` gives us 2 packs of 3 bombs or 6 total bombs * `start_hints` gives us a starting hint for the hammer available at the beginning of the multiworld which we can use -with no cost. + with no cost. * `local_items` forces the `Bombos`, `Ether`, and `Quake` medallions to all be placed within our own world, meaning we -have to find it ourselves. + have to find it ourselves. * `non_local_items` forces the `Moon Pearl` to be placed in someone else's world, meaning we won't be able to find it. * `start_location_hints` gives us a starting hint for the `Spike Cave` location available at the beginning of the -multiworld that can be used for no cost. + multiworld that can be used for no cost. * `priority_locations` forces a progression item to be placed on the `Link's House` location. * `exclude_locations` forces a not important item to be placed on the `Cave 45` location. * `item_links` * For `A Link to the Past` all players in the `rods` item link group will share their fire and ice rods and the player -items will be replaced with single rupees. + items will be replaced with single rupees. * For `Timespinner` all players in the `TSAll` item link group will share their entire item pool and the `Twin Pyramid -Key` and `Timespinner Wheel` will be forced among the worlds of those in the group. The `null` replacement item will, -instead of forcing a specific chosen item, allow the generator to randomly pick a filler item to replace the player items. + Key` and `Timespinner Wheel` will be forced among the worlds of those in the group. The `null` replacement item will, + instead of forcing a specific chosen item, allow the generator to randomly pick a filler item to replace the player items. * `triggers` allows us to define a trigger such that if our `smallkey_shuffle` option happens to roll the `any_world` -result it will also ensure that `bigkey_shuffle`, `map_shuffle`, and `compass_shuffle` are also forced to the -`any_world` result. More information on triggers can be found in the [triggers guide](/tutorial/Archipelago/triggers/en). + result it will also ensure that `bigkey_shuffle`, `map_shuffle`, and `compass_shuffle` are also forced to the + `any_world` result. More information on triggers can be found in the [triggers guide](/tutorial/Archipelago/triggers/en). ## Generating Multiple Worlds