morgan/Grinch-AP
1
0
Fork 0
mirror of https://github.com/MarioSpore/Grinch-AP.git synced 2025-10-21 20:21:32 -06:00
Code Issues Packages Projects Releases Wiki Activity

WebHost: Make URLs explicit in FAQ and Archipelago category tutorials.

Browse Source 
Remove unnecessary newlines and other tweaks.
This commit is contained in:
Hussein Farran
2021-11-30 19:34:39 -05:00
parent 56ef918a10
commit fc210c2d18
6 changed files with 58 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
WebHostLib/static/assets/tutorial/archipelago/plando_en.md
View File

@@ -1,14 +1,11 @@
# Archipelago Plando Guide
This guide details the use of the plando modules available with Archipelago. This guide is intended for a more advanced user who has more in-depth knowledge of the randomizer they're playing as well as experience editing YAML files. This guide should take about 10 minutes to read.
## What is Plando?
The purposes of randomizers is to randomize the items in a game to give a new experience.
Plando takes this concept and changes it up by allowing you to plan out certain aspects of the game by placing certain items in certain locations, certain bosses in certain rooms, edit text for certain NPCs/signs, or even force certain region
connections. Each of these options are going to be detailed separately as `item plando`, `boss plando`, `text plando`, and `connection plando`. Every game in archipelago supports item plando but the other plando options are only supported
by certain games. Currently, Minecraft and LTTP both support connection plando, but only LTTP supports text and boss plando.
The purposes of randomizers is to randomize the items in a game to give a new experience. Plando takes this concept and changes it up by allowing you to plan out certain aspects of the game by placing certain items in certain locations, certain bosses in certain rooms, edit text for certain NPCs/signs, or even force certain region connections. Each of these options are going to be detailed separately as `item plando`, `boss plando`, `text plando`, and `connection plando`. Every game in archipelago supports item plando but the other plando options are only supported by certain games. Currently, Minecraft and LTTP both support connection plando, but only LTTP supports text and boss plando.
### Enabling Plando
On the website plando will already be enabled. If you will be generating the game locally plando features must be enabled (opt-in).
* To opt-in go to the archipelago installation (default: `C:\ProgramData\Archipelago`), open the host.yaml with a text editor and find the `plando_options` key. The available plando modules can be enabled by adding them after this such as `plando_options: bosses, items, texts, connections`.
On the website plando will already be enabled. If you will be generating the game locally plando features must be enabled manually (opt-in). To opt-in go to the archipelago installation directory (default: `C:\ProgramData\Archipelago`), open the host.yaml with a text editor and find the `plando_options` key. The available plando modules can be enabled by adding them after this such as `plando_options: bosses, items, texts, connections`.
## Item Plando
Item plando allows a player to place an item in a specific location or specific locations, place multiple items into a list of specific locations both in their own game or in another player's game. **Note that there's a very good chance that
@@ -37,29 +34,30 @@ cross-game plando could very well be broken i.e. placing on of your items in som
* Using the multi placement method, placements are picked randomly.
### Available Items
* [A Link to the Past](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Items.py#L52)
* [Factorio Non-Progressive](https://wiki.factorio.com/Technologies) Note that these use the *internal names*. For example, `advanced-electronics`
* [Factorio Progressive](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/factorio/Technologies.py#L374)
* [Minecraft](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Items.py#L14)
* [Ocarina of Time](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/oot/Items.py#L61)
* [Risk of Rain 2](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/ror2/Items.py#L8)
* [Slay the Spire](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/spire/Items.py#L13)
* [Subnautica](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/subnautica/items.json)
* [Timespinner](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/timespinner/Items.py#L11)
* A Link to the Past: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Items.py#L52](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Items.py#L52)
* Factorio Non-Progressive: [https://wiki.factorio.com/Technologies](https://wiki.factorio.com/Technologies)
* Note that these use the *internal names*. For example, `advanced-electronics`
* Factorio Progressive: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/factorio/Technologies.py#L374](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/factorio/Technologies.py#L374)
* Minecraft: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Items.py#L14](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Items.py#L14)
* Ocarina of Time: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/oot/Items.py#L61](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/oot/Items.py#L61)
* Risk of Rain 2: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/ror2/Items.py#L8](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/ror2/Items.py#L8)
* Slay the Spire: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/spire/Items.py#L13](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/spire/Items.py#L13)
* Subnautica: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/subnautica/items.json](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/subnautica/items.json)
* Timespinner: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/timespinner/Items.py#L11](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/timespinner/Items.py#L11)
### Available Locations
* [A Link to the Past](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Regions.py#L429)
* [Factorio](https://wiki.factorio.com/Technologies) Same as items
* [Minecraft](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Locations.py#L18)
* [Ocarina of Time](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/oot/LocationList.py#L38)
* [Risk of Rain 2](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/ror2/Locations.py#L17) This is a special
case. The locations are "ItemPickup[number]" up to the maximum set in the yaml.
* [Slay the Spire](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/spire/Locations.py)
* [Subnautica](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/subnautica/locations.json)
* [Timespinner](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/timespinner/Locations.py#L13)
* A Link to the Past: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Regions.py#L429](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Regions.py#L429)
* Factorio: [https://wiki.factorio.com/Technologies](https://wiki.factorio.com/Technologies)
* Minecraft: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Locations.py#L18](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Locations.py#L18)
* Ocarina of Time: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/oot/LocationList.py#L38](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/oot/LocationList.py#L38)
* Risk of Rain 2: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/ror2/Locations.py#L17](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/ror2/Locations.py#L17)
* This is a special case. The locations are "ItemPickup[number]" up to the maximum set in the yaml.
* Slay the Spire: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/spire/Locations.py](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/spire/Locations.py)
* Subnautica: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/subnautica/locations.json](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/subnautica/locations.json)
* Timespinner: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/timespinner/Locations.py#L13](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/timespinner/Locations.py#L13)
A list of all available items and locations can also be found in the [server's datapackage](/api/datapackage).
A list of all available items and locations can also be found in the server's datapackage. Data package JSON: [click here](/api/datapackage).
### Examples
```yaml
plando_items:
@@ -119,10 +117,10 @@ plando_items:
4. This block has an 80% chance of occuring and when it does will place all but 1 of the items randomly among the four locations chosen here.
## Boss Plando
As this is currently only supported by A Link to the Past instead of explaining here please refer to the [relevant guide](/tutorial/zelda3/plando/en)
As this is currently only supported by A Link to the Past instead of explaining here please refer to the Z3 plando guide. Z3 plando guide: [click here](/tutorial/zelda3/plando/en)
## Text Plando
As this is currently only supported by A Link to the Past instead of explaining here please refer to the [relevant guide](/tutorial/zelda3/plando/en)
As this is currently only supported by A Link to the Past instead of explaining here please refer to the Z3 plando guide. Z3 plando guide: [click here](/tutorial/zelda3/plando/en)
## Connections Plando
This is currently only supported by Minecraft and A Link to the Past. As the way that these games interact with their connections is different I will only explain the basics here while more specifics for Link to the Past connection plando can be found in its plando guide.
@@ -131,9 +129,9 @@ This is currently only supported by Minecraft and A Link to the Past. As the way
* Every connection has an `entrance` and an `exit`. These can be unlinked like in A Link to the Past insanity entrance shuffle.
* `direction` can be `both`, `entrance`, or `exit` and determines in which direction this connection will operate.
[Link to the Past connections](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/EntranceShuffle.py#L3852)
Link to the Past connections: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/EntranceShuffle.py#L3852](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/EntranceShuffle.py#L3852)
[Minecraft connections](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Regions.py#L62)
Minecraft connections: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Regions.py#L62](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Regions.py#L62)
### Examples
```yaml