monorail
/
Archipelago
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix formatting in Plando tutorial

This commit is contained in:
Chris Wilson 2021-01-24 21:31:33 -05:00
parent 635d04f6ec
commit 761f798f39
2 changed files with 29 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
WebHostLib/static/assets/tutorial/zelda3/plando_en.md
View File

@ -2,10 +2,11 @@
## 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\BerserkerMultiWorld),
then open the host.yaml file therein 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\BerserkerMultiWorld`),
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
@ -19,20 +20,21 @@
- Instructions are separated by a semicolon
- Available Instructions:
- Direct Placement:
- Example: "Eastern Palace-Trinexx"
- 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"
- Ganons Tower has 3 placements, `Ganons Tower Top`, `Ganons Tower Middle` and `Ganons Tower Bottom`
- Boss Placement:
- Example: "Trinexx"
- Example: `Trinexx`
- Takes a particular boss and places that boss in any remaining slots in which this boss can function.
- 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.
- Example: `simple`
- Runs a particular boss shuffle mode to finish construction instead of vanilla placement, typically used as
a last instruction.
- [Available Bosses](https://github.com/Berserker66/MultiWorld-Utilities/blob/65fa39df95c90c9b66141aee8b16b7e560d00819/Bosses.py#L135)
- [Available Arenas](https://github.com/Berserker66/MultiWorld-Utilities/blob/65fa39df95c90c9b66141aee8b16b7e560d00819/Bosses.py#L186)
#### Examples:
#### Examples
```yaml
boss_shuffle:
Turtle Rock-Trinexx;basic: 1
@ -62,10 +64,10 @@ boss_shuffle:
- can be true, to target any other player's world
- can be false, to target own world and is the default
- can be null, to target a random world
- force is either "silent", "true" or "false".
- "true" means the item has to be placed, or the generator aborts with an exception.
- "false" means the generator logs a warning if the placement can't be done.
- "silent" means that this entry is entirely ignored if the placement fails and is the default.
- force is either `silent`, `true` or `false`.
- `true` means the item has to be placed, or the generator aborts with an exception.
- `false` means the generator logs a warning if the placement can't be done.
- `silent` means that this entry is entirely ignored if the placement fails and is the default.
- Single Placement
- place a single item at a single location
- item denotes the Item to place
@ -124,12 +126,12 @@ Link's House and removes the picked item from the item pool.
### Texts
- This module is disabled by default.
- Has the options "text", "at" and "percentage"
- 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.
- @ is the entered player's name.
- `\n` is a newline.
- `@` is the entered player's name.
- Warning: Text Mapper does not support full unicode.
- [Alphabet](https://github.com/Berserker66/MultiWorld-Utilities/blob/65fa39df95c90c9b66141aee8b16b7e560d00819/Text.py#L756)
- at is the location within the game to attach the text to.
@ -146,19 +148,18 @@ plando_texts:
percentage: 50
```
![Uncle Example](https://cdn.discordapp.com/attachments/731214280439103580/794953870903083058/unknown.png)
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.\nYou'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".
- Has the options `percentage`, `entrance`, `exit` and `direction`.
- All options support subweights
- percentage is the percentage chance for this to be connected, can be omitted entirely for 100%
- Any Door has 4 total directions, as a door can be unlinked like in insanity ER
- entrance is the overworld door
- exit is the underworld exit
- direction can be "both", "entrance" or "exit"
- direction can be `both`, `entrance` or `exit`
- doors can be found in [this file](https://github.com/Berserker66/MultiWorld-Utilities/blob/main/EntranceShuffle.py)

5
WebHostLib/static/styles/tutorial.css
View File

@ -16,6 +16,11 @@ html{
color: #eeffeb;
}
#tutorial-wrapper img{
max-width: 100%;
border-radius: 6px;
}
#tutorial-wrapper p{
margin-top: 0;
}