mirror of
https://github.com/MarioSpore/Grinch-AP.git
synced 2025-10-21 20:21:32 -06:00
WebHost: Undo all softwrapping changes because people don't like it. Fair enough!
This commit is contained in:
@@ -1,9 +1,12 @@
|
||||
# A Link to the Past Randomizer Plando Guide
|
||||
|
||||
## Configuration
|
||||
|
||||
1. Plando features have to be enabled first, before they can be used (opt-in).
|
||||
2. To do so, go to your installation directory (Windows default: `C:\ProgramData\Archipelago`), then open the host.yaml file with a text editor.
|
||||
3. In it, you're looking for the option key `plando_options`. To enable all plando modules you can set the value to `bosses, items, texts, connections`
|
||||
2. To do so, go to your installation directory (Windows default: `C:\ProgramData\Archipelago`), then open the host.yaml
|
||||
file with a text editor.
|
||||
3. In it, you're looking for the option key `plando_options`. To enable all plando modules you can set the value
|
||||
to `bosses, items, texts, connections`
|
||||
|
||||
## Modules
|
||||
|
||||
@@ -11,10 +14,11 @@
|
||||
|
||||
- This module is enabled by default and available to be used on [https://archipelago.gg/generate](/generate)
|
||||
- Plando versions of boss shuffles can be added like any other boss shuffle option in a yaml and weighted.
|
||||
- Boss Plando works as a list of instructions from left to right, if any arenas are empty at the end, it defaults to vanilla.
|
||||
- Boss Plando works as a list of instructions from left to right, if any arenas are empty at the end, it defaults to
|
||||
vanilla.
|
||||
- Instructions are separated by a semicolon.
|
||||
- Available Instructions:
|
||||
- Direct Placement:
|
||||
- Direct Placement:
|
||||
- Example: `Eastern Palace-Trinexx`
|
||||
- Takes a particular Arena and particular boss, then places that boss into that arena
|
||||
- Ganons Tower has 3 placements, `Ganons Tower Top`, `Ganons Tower Middle` and `Ganons Tower Bottom`
|
||||
@@ -24,12 +28,13 @@
|
||||
- In this example, it would fill Desert Palace, but not Tower of Hera.
|
||||
- Boss Shuffle:
|
||||
- Example: `simple`
|
||||
- Runs a particular boss shuffle mode to finish construction instead of vanilla placement, typically used as
|
||||
a last instruction.
|
||||
- Runs a particular boss shuffle mode to finish construction instead of vanilla placement, typically used as
|
||||
a last instruction.
|
||||
- [Available Bosses](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Bosses.py#L135)
|
||||
- [Available Arenas](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Bosses.py#L150)
|
||||
|
||||
#### Examples
|
||||
|
||||
```yaml
|
||||
boss_shuffle:
|
||||
Turtle Rock-Trinexx;basic: 1
|
||||
@@ -37,14 +42,15 @@ boss_shuffle:
|
||||
Mothula: 3
|
||||
Ganons Tower Bottom-Kholdstare;Trinexx;Kholdstare: 4
|
||||
```
|
||||
1. Would be basic boss shuffle but prevent Trinexx from appearing outside of Turtle Rock,
|
||||
as there's only one Trinexx in the pool
|
||||
|
||||
1. Would be basic boss shuffle but prevent Trinexx from appearing outside of Turtle Rock, as there's only one Trinexx in
|
||||
the pool
|
||||
2. Regular full boss shuffle. With a 2 in 10 chance to occur.
|
||||
3. A Mothula Singularity, as Mothula works in any arena.
|
||||
4. A Trinexx -> Kholdstare Singularity that prevents ice Trinexx in GT
|
||||
|
||||
|
||||
### Items
|
||||
|
||||
- This module is disabled by default.
|
||||
- Has the options from_pool, world, percentage, force and either item and location or items and locations
|
||||
- All of these options support subweights
|
||||
@@ -72,12 +78,13 @@ boss_shuffle:
|
||||
- items denotes the items to use, can be given a number to have multiple of that item
|
||||
- locations lists the possible locations those items can be placed in
|
||||
- placements are picked randomly, not sorted in any way
|
||||
- Warning: Placing non-Dungeon Prizes on Prize locations and
|
||||
Prizes on non-Prize locations will break the game in various ways.
|
||||
- Warning: Placing non-Dungeon Prizes on Prize locations and Prizes on non-Prize locations will break the game in
|
||||
various ways.
|
||||
- [Available Items](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Items.py#L52)
|
||||
- [Available Locations](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Regions.py#L434)
|
||||
|
||||
#### Examples
|
||||
|
||||
```yaml
|
||||
plando_items:
|
||||
- item: # 1
|
||||
@@ -114,25 +121,28 @@ plando_items:
|
||||
from_pool: true
|
||||
```
|
||||
|
||||
1. has a 50% chance to occur, which if it does places either the Lamp or Fire Rod in one's own Link's House and removes the picked item from the item pool.
|
||||
1. has a 50% chance to occur, which if it does places either the Lamp or Fire Rod in one's own Link's House and removes
|
||||
the picked item from the item pool.
|
||||
2. Always triggers and places the Swords and Bows into one's own Big Chests
|
||||
3. Locks Pendants to The Light World and therefore Crystals to dark world
|
||||
|
||||
### Texts
|
||||
|
||||
- This module is disabled by default.
|
||||
- Has the options `text`, `at`, and `percentage`
|
||||
- percentage is the percentage chance for this text to be placed, can be omitted entirely for 100%
|
||||
- text is the text to be placed.
|
||||
- can be weighted.
|
||||
- `\n` is a newline.
|
||||
- `\n` is a newline.
|
||||
- `@` is the entered player's name.
|
||||
- Warning: Text Mapper does not support full unicode.
|
||||
- [Alphabet](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Text.py#L758)
|
||||
- at is the location within the game to attach the text to.
|
||||
- can be weighted.
|
||||
- [List of targets](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Text.py#L1499)
|
||||
|
||||
|
||||
#### Example
|
||||
|
||||
```yaml
|
||||
plando_texts:
|
||||
- text: "This is a plando.\nYou've been warned."
|
||||
@@ -141,10 +151,13 @@ plando_texts:
|
||||
uncle_dying_sewer: 1
|
||||
percentage: 50
|
||||
```
|
||||
|
||||

|
||||
This has a 50% chance to trigger at all. If it does, it throws a coin between `uncle_leaving_text` and `uncle_dying_sewer`, then places the text "This is a plando. You've been warned." at that location.
|
||||
This has a 50% chance to trigger at all. If it does, it throws a coin between `uncle_leaving_text`
|
||||
and `uncle_dying_sewer`, then places the text "This is a plando. You've been warned." at that location.
|
||||
|
||||
### Connections
|
||||
|
||||
- This module is disabled by default.
|
||||
- Has the options `percentage`, `entrance`, `exit` and `direction`.
|
||||
- All options support subweights
|
||||
@@ -153,10 +166,11 @@ This has a 50% chance to trigger at all. If it does, it throws a coin between `u
|
||||
- entrance is the overworld door
|
||||
- exit is the underworld exit
|
||||
- direction can be `both`, `entrance` or `exit`
|
||||
- doors can be found in [this file](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/EntranceShuffle.py#L3852)
|
||||
|
||||
- doors can be found
|
||||
in [this file](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/EntranceShuffle.py#L3852)
|
||||
|
||||
#### Example
|
||||
|
||||
```yaml
|
||||
plando_connections:
|
||||
- entrance: Links House
|
||||
@@ -167,7 +181,8 @@ plando_connections:
|
||||
direction: both
|
||||
```
|
||||
|
||||
The first block connects the overworld entrance that normally leads to Link's House
|
||||
to put you into the HC West Wing instead, exiting from within there will put you at the Overworld exiting Link's House.
|
||||
The first block connects the overworld entrance that normally leads to Link's House to put you into the HC West Wing
|
||||
instead, exiting from within there will put you at the Overworld exiting Link's House.
|
||||
|
||||
Without the second block, you'd still exit from within Link's House to outside Link's House and the left side Balcony Entrance would still lead into HC West Wing
|
||||
Without the second block, you'd still exit from within Link's House to outside Link's House and the left side Balcony
|
||||
Entrance would still lead into HC West Wing
|
||||
|
||||
Reference in New Issue
Block a user