WebHost: Newlines must die.

This commit is contained in:
Hussein Farran 2021-12-19 23:29:04 -05:00
parent 9212505243
commit a864b893b8
11 changed files with 36 additions and 76 deletions

View File

@ -4,18 +4,13 @@
The player settings page for this game contains all the options you need to configure and export a config file. Player settings page link: [Minecraft Player Settings Page](../player-settings).
## What does randomization do to this game?
Recipes are removed from the crafting book and shuffled into the item pool. It can also optionally change which
structures appear in each dimension. Crafting recipes are re-learned when they are received from other players as
item checks, and occasionally when completing your own achievements.
Recipes are removed from the crafting book and shuffled into the item pool. It can also optionally change which structures appear in each dimension. Crafting recipes are re-learned when they are received from other players as item checks, and occasionally when completing your own achievements.
## What is considered a location check in minecraft?
Location checks in are completed when the player completes various Minecraft achievements. Opening the advancements
menu in-game by pressing "L" will display outstanding achievements.
Location checks in are completed when the player completes various Minecraft achievements. Opening the advancements menu in-game by pressing "L" will display outstanding achievements.
## When the player receives an item, what happens?
When the player receives an item in Minecraft, it either unlocks crafting recipes or puts items into the player's
inventory directly.
When the player receives an item in Minecraft, it either unlocks crafting recipes or puts items into the player's inventory directly.
## What is the victory condition?
Victory is achieved when the player kills the Ender Dragon, enters the portal in The End, and completes the credits
sequence either by skipping it or watching hit play out.
Victory is achieved when the player kills the Ender Dragon, enters the portal in The End, and completes the credits sequence either by skipping it or watching hit play out.

View File

@ -4,22 +4,17 @@
The player settings page for this game contains all the options you need to configure and export a config file. Player settings page link: [Ocarina of Time Player Settings Page](../player-settings).
## What does randomization do to this game?
Items which the player would normally acquire throughout the game have been moved around. Logic remains, so the game
is always able to be completed, but because of the item shuffle the player may need to access certain areas before
they would in the vanilla game.
Items which the player would normally acquire throughout the game have been moved around. Logic remains, so the game is always able to be completed, but because of the item shuffle the player may need to access certain areas before they would in the vanilla game.
## What items and locations get shuffled?
All main inventory items, collectables, and ammunition can be shuffled, and all locations in the game which could
contain any of those items may have their contents changed. Gold Skultulla locations may also be included as necessary
All main inventory items, collectables, and ammunition can be shuffled, and all locations in the game which could contain any of those items may have their contents changed. Gold Skultulla locations may also be included as necessary
checks at the user's discretion.
## Which items can be in another player's world?
Any of the items which can be shuffled may also be placed into another player's world. It is possible to choose to
limit certain items to your own world.
Any of the items which can be shuffled may also be placed into another player's world. It is possible to choose to limit certain items to your own world.
## What does another world's item look like in OoT?
Items belonging to other worlds are represented by an Ocarina of Time.
## When the player receives an item, what happens?
When the player receives an item, Link will hold the item above his head and display it to the world. It's good for
business!
When the player receives an item, Link will hold the item above his head and display it to the world. It's good for business!

View File

@ -15,10 +15,9 @@ The following list is a list of client commands which may be available to you th
- Just typing anything will broadcast a message to all players
#### Remote Commands
- `!hint <item name>` Tells you at which location in whose game your Item is. Note you need to have checked some locations
to earn a hint. You can check how many you have by just running `!hint`
- `!forfeit` If you didn't turn on auto-forfeit or you allowed forfeiting prior to goal completion. Remember that "forfeiting" actually means sending out your remaining items in your world.
- `!collect` Grants you all of the remaining checks in your world. Can only be used after your goal is complete or you have forfeited.
- `!hint <item name>` Tells you at which location in whose game your Item is. Note you need to have checked some locations to earn a hint. You can check how many you have by just running `!hint`
- `!forfeit` If you didn't turn on auto-forfeit or if you allowed forfeiting prior to goal completion. Remember that "forfeiting" actually means sending out your remaining items in your world.
- `!collect` Grants you all the remaining checks in your world. Can only be used after your goal is complete or when you have forfeited.
#### Host only (on Archipelago.gg or in your server console)
- `/forfeit <Player Name>` Forfeits someone regardless of settings and game completion status

View File

@ -2,8 +2,7 @@
This guide details the use of the Archipelago YAML trigger system. This guide is intended for a more advanced user with more in-depth knowledge of Archipelago YAML options as well as experience editing YAML files. This guide should take about 5 minutes to read.
## What are triggers?
Triggers allow you to customize your game settings by allowing you to define one or many options which only occur under specific conditions. These are essentially "if, then" statements for options in your game.
A good example of what you can do with triggers is the custom mercenary mode YAML that was created using entirely triggers and plando.
Triggers allow you to customize your game settings by allowing you to define one or many options which only occur under specific conditions. These are essentially "if, then" statements for options in your game. A good example of what you can do with triggers is the custom mercenary mode YAML that was created using entirely triggers and plando.
Mercenary mode YAML: [Mercenary Mode YAML on GitHub](https://github.com/alwaysintreble/Archipelago-yaml-dump/blob/main/Snippets/Mercenary%20Mode%20Snippet.yaml)

View File

@ -4,23 +4,13 @@ This guide encompasses the use cases for rolling and hosting multiworld games on
## Rolling the Seed On the Website
1. After gathering the YAML files together in one location, select all the files and compress them into a `.ZIP` file.
2. Next go to the "Generate Game" page. Generate game page: [Archipelago Seed Generation Page](https://archipelago.gg/generate). Here, you can adjust some server settings such as forfeit rules and the cost for a player to use a hint before generation.
3. After adjusting the host settings to your liking click on the Upload File button and using the explorer window that opens,
navigate to the location where you zipped the player files and upload this zip. The page will generate your game and refresh
multiple times to check on completion status.
4. After the generation completes you will be on a Seed Info page that provides
the seed, the date/time of creation, a link to the spoiler log, if available, and links to any rooms created from this seed.
5. To begin playing, click on "Create New Room", which will take you to the room page. From here you can navigate back to the
Seed Info page or to the Tracker page. Sharing the link to the room page with your friends will provide them with the
necessary info and files for them to connect to the multiworld.
3. After adjusting the host settings to your liking click on the Upload File button and using the explorer window that opens, navigate to the location where you zipped the player files and upload this zip. The page will generate your game and refresh multiple times to check on completion status.
4. After the generation completes you will be on a Seed Info page that provides the seed, the date/time of creation, a link to the spoiler log, if available, and links to any rooms created from this seed.
5. To begin playing, click on "Create New Room", which will take you to the room page. From here you can navigate back to the Seed Info page or to the Tracker page. Sharing the link to the room page with your friends will provide them with the necessary info and files for them to connect to the multiworld.
## Hosting a Pre-Generated Multiworld on the Website
The easiest and most recommended method is to generate the game on the website which will allow you to create a private
room with all the necessary files you can share, as well as hosting the game and supporting item trackers for various games.
The easiest and most recommended method is to generate the game on the website which will allow you to create a private room with all the necessary files you can share, as well as hosting the game and supporting item trackers for various games.
If for some reason the seed was rolled on a machine, then either the resulting zip file or the resulting `AP_XXXXX.archipelago`
inside the zip file can be uploaded to the host game page. Host game page: [Archipelago Seed Upload Page](https://archipelago.gg/uploads)
If for some reason the seed was rolled on a machine, then either the resulting zip file or the resulting `AP_XXXXX.archipelago` inside the zip file can be uploaded to the host game page. Host game page: [Archipelago Seed Upload Page](https://archipelago.gg/uploads)
This will give a page with the seed info and a
link to the spoiler log, if it exists. Click on "Create New Room" and then share the link to the resulting page the other players
so that they can download their patches or mods. The room will also have a link to a Multiworld Tracker and tell you
what the players need to connect to from their clients.
This will give a page with the seed info and a link to the spoiler log, if it exists. Click on "Create New Room" and then share the link to the resulting page the other players so that they can download their patches or mods. The room will also have a link to a Multiworld Tracker and tell you what the players need to connect to from their clients.

View File

@ -105,8 +105,7 @@ server, you can also issue the `!help` command to learn about additional command
"Connecting to Someone Else's Factorio Game" above.
## Troubleshooting
In case any problems should occur, the Archipelago Client will create a file `FactorioClient.txt` in the `/logs`.
The contents of this file may help you troubleshoot an issue on your own and is vital for requesting help from other
In case any problems should occur, the Archipelago Client will create a file `FactorioClient.txt` in the `/logs`. The contents of this file may help you troubleshoot an issue on your own and is vital for requesting help from other
people in Archipelago.
## Additional Resources

View File

@ -19,8 +19,7 @@
4. Browse for `EmuHawk.exe` located inside your Bizhawk folder (from step 1) and click **Open**.
## Obtaining your Archipelago yaml file and randomized ROM
Unlike most other Archipelago.gg games Final Fantasy 1 is randomized by the
main randomizer at [https://finalfantasyrandomizer.com/](https://finalfantasyrandomizer.com/).
Unlike most other Archipelago.gg games Final Fantasy 1 is randomized by the main randomizer at [https://finalfantasyrandomizer.com/](https://finalfantasyrandomizer.com/).
Generate a game by going to the site and performing the following steps:
1. Select the randomization options (also known as `Flags` in the community) of your choice. If you do not know what you prefer, or it is your first time playing select the "Archipelago" preset on the main page.

View File

@ -13,24 +13,18 @@ You can install the Archipelago mod using r2modman in one of two ways.
One, you can use the Thunderstore website and click on the "Install with Mod Manager" link.
You can also search for the "Archipelago" mod in the r2modman interface.
The mod manager should automatically install all necessary dependencies as well.
You can also search for the "Archipelago" mod in the r2modman interface. The mod manager should automatically install all necessary dependencies as well.
### Running the Modded Game
Click on the "Start modded" button in the top left in r2modman to start the game with the
Archipelago mod installed.
Click on the "Start modded" button in the top left in r2modman to start the game with the Archipelago mod installed.
## Joining an Archipelago Session
There will be a menu button on the right side of the screen in the character select menu.
Click it in order to bring up the in lobby mod config.
From here you can expand the Archipelago sections and fill in the relevant info.
Keep password blank if there is no password on the server.
There will be a menu button on the right side of the screen in the character select menu. Click it in order to bring up the in lobby mod config. From here you can expand the Archipelago sections and fill in the relevant info. Keep password blank if there is no password on the server.
Simply check `Enable Archipelago?` and when you start the run it will automatically connect.
## Gameplay
The Risk of Rain 2 players send checks by causing items to spawn in-game. That means opening chests or killing bosses, generally.
An item check is only sent out after a certain number of items are picked up. This count is configurable in the player's YAML.
The Risk of Rain 2 players send checks by causing items to spawn in-game. That means opening chests or killing bosses, generally. An item check is only sent out after a certain number of items are picked up. This count is configurable in the player's YAML.
## YAML Settings
An example YAML would look like this:

View File

@ -105,8 +105,6 @@ The recommended way to host a game is to use our hosting service. The process is
- Generate page: [WebHost Seed Generation Page](/generate)
4. Wait a moment while the seed is generated.
5. When the seed is generated, you will be redirected to a "Seed Info" page.
6. Click "Create New Room". This will take you to the server page. Provide the link to this page to your players,
so they may download their patch files from there.
7. Note that a link to a MultiWorld Tracker is at the top of the room page. The tracker shows the progress of all
players in the game. Any observers may also be given the link to this page.
6. Click "Create New Room". This will take you to the server page. Provide the link to this page to your players, so they may download their patch files from there.
7. Note that a link to a MultiWorld Tracker is at the top of the room page. The tracker shows the progress of all players in the game. Any observers may also be given the link to this page.
8. Once all players have joined, you may begin playing.

View File

@ -9,7 +9,7 @@
## General Concept
The timespinner Randomizer loads Timespinner.exe from the same folder, and alters its state in memory to allow for randomization of the items.
The Timespinner Randomizer loads Timespinner.exe from the same folder, and alters its state in memory to allow for randomization of the items.
## Installation Procedures

View File

@ -2,22 +2,17 @@
## 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
### Bosses
- This module is enabled by default and available to be used on
[https://archipelago.gg/generate](/generate)
- 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
- Instructions are separated by a semicolon
- 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:
- Example: `Eastern Palace-Trinexx`
@ -119,8 +114,7 @@ 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
@ -147,9 +141,8 @@ plando_texts:
uncle_dying_sewer: 1
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. You've been warned." at that location.
![Example plando text at Uncle](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. You've been warned." at that location.
### Connections
- This module is disabled by default.
@ -177,5 +170,4 @@ plando_connections:
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