WebHost: Make links to game settings less redundant in gameinfo pages.

Reformat all tutorial pages using PyCharm reformat.
This commit is contained in:
Hussein Farran 2022-01-09 14:57:00 -05:00
parent b94d401d09
commit 88ce841bf6
20 changed files with 245 additions and 175 deletions

View File

@ -2,8 +2,8 @@
## Where is the settings page? ## Where is the settings page?
The player settings page for this game contains all the options you need to configure and export a config file. Player The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
settings page link: [LttP Player Settings Page](../player-settings). config file.
## What does randomization do to this game? ## What does randomization do to this game?

View File

@ -2,8 +2,8 @@
## Where is the settings page? ## Where is the settings page?
The player settings page for this game contains all the options you need to configure and export a config file. Player The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
settings page link: [Factorio Player Settings Page](../player-settings). config file.
## What does randomization do to this game? ## What does randomization do to this game?

View File

@ -2,8 +2,8 @@
## Where is the settings page? ## Where is the settings page?
The player settings page for this game contains all the options you need to configure and export a config file. Player The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
settings page link: [Minecraft Player Settings Page](../player-settings). config file.
## What does randomization do to this game? ## What does randomization do to this game?

View File

@ -2,8 +2,8 @@
## Where is the settings page? ## Where is the settings page?
The player settings page for this game contains all the options you need to configure and export a config file. Player The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
settings page link: [Ocarina of Time Player Settings Page](../player-settings). config file.
## What does randomization do to this game? ## What does randomization do to this game?

View File

@ -2,8 +2,8 @@
## Where is the settings page? ## Where is the settings page?
The player settings page for this game contains all the options you need to configure and export a config file. Player The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
settings page link: [Risk of Rain 2 Player Settings Page](../player-settings). config file.
## What does randomization do to this game? ## What does randomization do to this game?

View File

@ -1,22 +1,27 @@
# Rogue Legacy (PC) # Rogue Legacy (PC)
## Where is the settings page? ## Where is the settings page?
The player settings page for this game is located <a href="../player-settings">here</a>. It contains all the options
you need to configure and export a config file. The [player settings page for this game](../player-settings) is located contains all the options you need to configure
and export a config file.
## What does randomization do to this game? ## What does randomization do to this game?
You are not able to buy skill upgrades in the manor upgrade screen, and instead, need to find them in order to level up You are not able to buy skill upgrades in the manor upgrade screen, and instead, need to find them in order to level up
your character to make fighting the 5 bosses easier. your character to make fighting the 5 bosses easier.
## What items and locations get shuffled? ## What items and locations get shuffled?
All the skill upgrades, class upgrades, runes packs, and equipment packs are shuffled in the manor upgrade screen,
diary checks, chests and fairy chests, and boss rewards. Skill upgrades are also grouped in packs of 5 to make the All the skill upgrades, class upgrades, runes packs, and equipment packs are shuffled in the manor upgrade screen, diary
finding of stats less of a chore. Runes and Equipment are also grouped together. checks, chests and fairy chests, and boss rewards. Skill upgrades are also grouped in packs of 5 to make the finding of
stats less of a chore. Runes and Equipment are also grouped together.
## Which items can be in another player's world? ## 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.
## When the player receives an item, what happens? ## When the player receives an item, what happens?
When the player receives an item, your character will hold the item above their head and display it to the world. It's When the player receives an item, your character will hold the item above their head and display it to the world. It's
good for business! good for business!

View File

@ -2,8 +2,8 @@
## Where is the settings page? ## Where is the settings page?
The player settings page for this game contains all the options you need to configure and export a config file. Player The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
settings page link: [Secret of Evermore Player Settings Page](../player-settings). config file.
## What does randomization do to this game? ## What does randomization do to this game?

View File

@ -1,29 +1,35 @@
# Slay the Spire (PC) # Slay the Spire (PC)
## Where is the settings page? ## Where is the settings page?
The player settings page for this game is located <a href="../player-settings">here</a>. It contains all the options
you need to configure and export a config file. The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
config file.
## What does randomization do to this game? ## What does randomization do to this game?
Every non-boss relic drop, every boss relic and rare card drop, and every other card draw is replaced with an Every non-boss relic drop, every boss relic and rare card drop, and every other card draw is replaced with an
archipelago item. In heart runs, the blue key is also disconnected from the Archipelago item, so you can gather both. archipelago item. In heart runs, the blue key is also disconnected from the Archipelago item, so you can gather both.
## What items and locations get shuffled? ## What items and locations get shuffled?
15 card packs, 10 relics, and 3 boss relics and rare card drops are shuffled into the item pool and can be found at any 15 card packs, 10 relics, and 3 boss relics and rare card drops are shuffled into the item pool and can be found at any
location that would normally give you these items, except for card packs, which are found at every other normal enemy location that would normally give you these items, except for card packs, which are found at every other normal enemy
encounter. encounter.
## Which items can be in another player's world? ## 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.
## When the player receives an item, what happens? ## When the player receives an item, what happens?
When the player receives an item, you will see the counter in the top right corner with the Archipelago symbol increment When the player receives an item, you will see the counter in the top right corner with the Archipelago symbol increment
by one. By clicking on this icon, it'll open a menu that lists all the items you received, but have not yet accepted. by one. By clicking on this icon, it'll open a menu that lists all the items you received, but have not yet accepted.
You can take any relics and card packs sent to you and add them to your current run. It is advised that you do not open You can take any relics and card packs sent to you and add them to your current run. It is advised that you do not open
this menu until you are outside an encounter or event to prevent the game from soft-locking. this menu until you are outside an encounter or event to prevent the game from soft-locking.
## What happens if a player dies in a run? ## What happens if a player dies in a run?
When a player dies, they will be taken back to the main menu and will need to reconnect to start climbing the spire
from the beginning, but they will have access to all the items ever sent to them in the Archipelago menu in the top When a player dies, they will be taken back to the main menu and will need to reconnect to start climbing the spire from
right. Any items found in an earlier run will not be sent again if you encounter them in the same location. the beginning, but they will have access to all the items ever sent to them in the Archipelago menu in the top right.
Any items found in an earlier run will not be sent again if you encounter them in the same location.

View File

@ -2,8 +2,8 @@
## Where is the settings page? ## Where is the settings page?
The player settings page for this game contains all the options you need to configure and export a config file. Player The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
settings page link: [Subnautica Player Settings Page](../player-settings). config file.
## What does randomization do to this game? ## What does randomization do to this game?

View File

@ -2,8 +2,8 @@
## Where is the settings page? ## Where is the settings page?
The player settings page for this game contains all the options you need to configure and export a config file. Player The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
settings page link: [Super Metroid Player Settings Page](../player-settings). config file.
## What does randomization do to this game? ## What does randomization do to this game?

View File

@ -2,8 +2,8 @@
## Where is the settings page? ## Where is the settings page?
The player settings page for this game contains all the options you need to configure and export a config file. Player The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
settings page link: [Timespinner Player Settings Page](../player-settings). config file.
## What does randomization do to this game? ## What does randomization do to this game?

View File

@ -26,11 +26,13 @@ The following commands are available in these clients: SNIClient, FactorioClient
- Just typing anything will broadcast a message to all players - Just typing anything will broadcast a message to all players
##### FF1Client Only ##### FF1Client Only
The following command is only available when using the FF1Client for the Final Fantasy Randomizer. The following command is only available when using the FF1Client for the Final Fantasy Randomizer.
- `/nes` Shows the current status of the NES connection. - `/nes` Shows the current status of the NES connection.
##### SNIClient Only ##### SNIClient Only
The following command is only available when using the SNIClient for SNES based games. The following command is only available when using the SNIClient for SNES based games.
- `/snes` Attempts to connect to your SNES device via SNI. - `/snes` Attempts to connect to your SNES device via SNI.
@ -38,11 +40,13 @@ The following command is only available when using the SNIClient for SNES based
- `/slow_mode` Toggles on or off slow mode, which limits the rate in which you receive items. - `/slow_mode` Toggles on or off slow mode, which limits the rate in which you receive items.
##### FactorioClient Only ##### FactorioClient Only
The following command is only available when using the FactorioClient to play Factorio with Archipelago. The following command is only available when using the FactorioClient to play Factorio with Archipelago.
- `/factorio <command text>` Sends the command argument to the Factorio server as a command. - `/factorio <command text>` Sends the command argument to the Factorio server as a command.
#### Remote Commands #### Remote Commands
Remote commands may be executed by any client which allows for sending text chat to the Archipelago server. If your Remote commands may be executed by any client which allows for sending text chat to the Archipelago server. If your
client does not allow for sending chat then you may connect to your game slot with the TextClient which comes with the client does not allow for sending chat then you may connect to your game slot with the TextClient which comes with the
Archipelago installation. In order to execute the command you need to merely send a text message with the command, Archipelago installation. In order to execute the command you need to merely send a text message with the command,
@ -51,7 +55,8 @@ including the exclamation point.
- `!help` Returns a listing of available remote commands. - `!help` Returns a listing of available remote commands.
- `!license` Returns the software licensing information. - `!license` Returns the software licensing information.
- `!options` Returns the current server options, including password in plaintext. - `!options` Returns the current server options, including password in plaintext.
- `!admin <command>` Executes a command as if you typed it into the server console. Remote administration must be enabled. - `!admin <command>` Executes a command as if you typed it into the server console. Remote administration must be
enabled.
- `!players` Returns info about the currently connected and non-connected players. - `!players` Returns info about the currently connected and non-connected players.
- `!status` Returns information about your team. (Currently all players as teams are unimplemented.) - `!status` Returns information about your team. (Currently all players as teams are unimplemented.)
- `!remaining` Lists the items remaining in your game, but not where they are or who they go to. - `!remaining` Lists the items remaining in your game, but not where they are or who they go to.
@ -59,8 +64,8 @@ including the exclamation point.
- `!checked` Lists all the location checks you've done from the server's perspective. - `!checked` Lists all the location checks you've done from the server's perspective.
- `!alias <alias>` Sets your alias. - `!alias <alias>` Sets your alias.
- `!getitem <item>` Cheats an item, if it is enabled in the server. - `!getitem <item>` Cheats an item, if it is enabled in the server.
- `!hint_location <location>` Hints for a location specifically. Useful in games where item names may match location names - `!hint_location <location>` Hints for a location specifically. Useful in games where item names may match location
such as Factorio. names such as Factorio.
- `!hint <item name>` Tells you at which location in whose game your Item is. Note you need to have checked some - `!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` 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 " - `!forfeit` If you didn't turn on auto-forfeit or if you allowed forfeiting prior to goal completion. Remember that "

View File

@ -1,26 +1,36 @@
# Archipelago Plando Guide # Archipelago Plando Guide
## What is Plando? ## 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 The purposes of randomizers is to randomize the items in a game to give a new experience. Plando takes this concept and
items in certain locations, certain bosses in certain rooms, edit text for certain NPCs/signs, or even force certain region changes it up by allowing you to plan out certain aspects of the game by placing certain items in certain locations,
connections. Each of these options are going to be detailed separately as `item plando`, `boss plando`, `text plando`, 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 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. by certain games. Currently, Minecraft and LTTP both support connection plando, but only LTTP supports text and boss
plando.
### Enabling 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).
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 * 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 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`. `plando_options: bosses, items, texts, connections`.
## Item Plando ## 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 Item plando allows a player to place an item in a specific location or specific locations, place multiple items into a
cross-game plando could very well be broken i.e. placing on of your items in someone else's world playing a different game.** list of specific locations both in their own game or in another player's game. **Note that there's a very good chance
* The options for item plando are `from_pool`, `world`, `percentage`, `force`, and either item and location, or items and locations. that cross-game plando could very well be broken i.e. placing on of your items in someone else's world playing a
* `from_pool` determines if the item should be taken *from* the item pool or *added* to it. This can be true or false different game.**
and defaults to true if omitted.
* The options for item plando are `from_pool`, `world`, `percentage`, `force`, and either item and location, or items
and locations.
* `from_pool` determines if the item should be taken *from* the item pool or *added* to it. This can be true or
false and defaults to true if omitted.
* `world` is the target world to place the item in. * `world` is the target world to place the item in.
* It gets ignored if only one world is generated. * It gets ignored if only one world is generated.
* Can be a number, name, true, false, or null. False is the default. * Can be a number, name, true, false, or null. False is the default.
@ -34,8 +44,8 @@ or silent. Silent is the default.
* If set to true the item must be placed and the generator will throw an error if it is unable to do so. * If set to true the item must be placed and the generator will throw an error if it is unable to do so.
* If set to false the generator will log a warning if the placement can't be done but will still generate. * If set to false the generator will log a warning if the placement can't be done but will still generate.
* If set to silent and the placement fails it will be ignored entirely. * If set to silent and the placement fails it will be ignored entirely.
* `percentage` is the percentage chance for the relevant block to trigger. This can be any value from 0 to 100 and if * `percentage` is the percentage chance for the relevant block to trigger. This can be any value from 0 to 100 and
omitted will default to 100. if omitted will default to 100.
* Single Placement is when you use a plando block to place a single item at a single location. * Single Placement is when you use a plando block to place a single item at a single location.
* `item` is the item you would like to place and `location` is the location to place it. * `item` is the item you would like to place and `location` is the location to place it.
* Multi Placement uses a plando block to place multiple items in multiple locations until either list is exhausted. * Multi Placement uses a plando block to place multiple items in multiple locations until either list is exhausted.
@ -44,8 +54,10 @@ omitted will default to 100.
* Using the multi placement method, placements are picked randomly. * Using the multi placement method, placements are picked randomly.
### Available Items ### Available Items
* [A Link to the Past](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Items.py#L52) * [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 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) * [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) * [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) * [Ocarina of Time](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/oot/Items.py#L61)
@ -55,19 +67,21 @@ omitted will default to 100.
* [Timespinner](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/timespinner/Items.py#L11) * [Timespinner](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/timespinner/Items.py#L11)
### Available Locations ### Available Locations
* [A Link to the Past](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Regions.py#L429) * [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 * [Factorio](https://wiki.factorio.com/Technologies) Same as items
* [Minecraft](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Locations.py#L18) * [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) * [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 * [Risk of Rain 2](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/ror2/Locations.py#L17) This is a
case. The locations are "ItemPickup[number]" up to the maximum set in the yaml. 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) * [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) * [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) * [Timespinner](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](/api/datapackage).
### Examples ### Examples
```yaml ```yaml
plando_items: plando_items:
# example block 1 - Timespinner # example block 1 - Timespinner
@ -120,8 +134,9 @@ plando_items:
percentage: 80 percentage: 80
force: true force: true
``` ```
1. This block has a 50% chance to occur, and if it does will place either the Empire Orb or Radiant Orb on another player's
Starter Chest 1 and removes the chosen item from the item pool. 1. This block has a 50% chance to occur, and if it does will place either the Empire Orb or Radiant Orb on another
player's Starter Chest 1 and removes the chosen item from the item pool.
2. This block will always trigger and will place the player's swords, bow, magic meter, strength upgrades, and hookshots 2. This block will always trigger and will place the player's swords, bow, magic meter, strength upgrades, and hookshots
in their own dungeon major item chests. in their own dungeon major item chests.
3. This block will always trigger and will lock boss relics on the bosses. 3. This block will always trigger and will lock boss relics on the bosses.
@ -129,20 +144,26 @@ in their own dungeon major item chests.
locations chosen here. locations chosen here.
## Boss Plando ## Boss Plando
As this is currently only supported by A Link to the Past instead of explaining here please refer to the 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) [relevant guide](/tutorial/zelda3/plando/en)
## Text Plando ## Text Plando
As this is currently only supported by A Link to the Past instead of explaining here please refer to the 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) [relevant guide](/tutorial/zelda3/plando/en)
## Connections Plando ## 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 This is currently only supported by Minecraft and A Link to the Past. As the way that these games interact with their
plando can be found in its plando guide. connections is different I will only explain the basics here while more specifics for Link to the Past connection plando
* The options for connections are `percentage`, `entrance`, `exit`, and `direction`. Each of these options support subweights. can be found in its plando guide.
* The options for connections are `percentage`, `entrance`, `exit`, and `direction`. Each of these options support
subweights.
* `percentage` is the percentage chance for this connection from 0 to 100 and defaults to 100. * `percentage` is the percentage chance for this connection from 0 to 100 and defaults to 100.
* Every connection has an `entrance` and an `exit`. These can be unlinked like in A Link to the Past insanity entrance shuffle. * 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. * `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)
@ -150,6 +171,7 @@ plando can be found in its plando guide.
[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)
### Examples ### Examples
```yaml ```yaml
plando_connections: plando_connections:
# example block 1 - Link to the Past # example block 1 - Link to the Past

View File

@ -3,8 +3,7 @@
## Required Software ## Required Software
- The FF1Client - The FF1Client
- Bundled with - Bundled with Archipelago: [Archipelago Releases Page](https://github.com/ArchipelagoMW/Archipelago/releases)
Archipelago: [Archipelago Releases Page](https://github.com/ArchipelagoMW/Archipelago/releases)
- The BizHawk emulator. Versions 2.3.1 and higher are supported. Version 2.7 is recommended - The BizHawk emulator. Versions 2.3.1 and higher are supported. Version 2.7 is recommended
- [BizHawk Official Website](http://tasvideos.org/BizHawk.html) - [BizHawk Official Website](http://tasvideos.org/BizHawk.html)
- Your legally obtained Final Fantasy (USA Edition) ROM file, probably named `Final Fantasy (USA).nes`. Neither - Your legally obtained Final Fantasy (USA Edition) ROM file, probably named `Final Fantasy (USA).nes`. Neither
@ -24,8 +23,8 @@
## Obtaining your Archipelago yaml file and randomized ROM ## Obtaining your Archipelago yaml file and randomized ROM
Unlike most other Archipelago.gg games Final Fantasy 1 is randomized by the main randomizer Unlike most other Archipelago.gg games Final Fantasy 1 is randomized by the main randomizer at
at the [Final Fantasy Randomizer Homepage](https://finalfantasyrandomizer.com/). the [Final Fantasy Randomizer Homepage](https://finalfantasyrandomizer.com/).
Generate a game by going to the site and performing the following steps: Generate a game by going to the site and performing the following steps:
@ -65,4 +64,6 @@ When the client shows both NES and server are connected you are good to go. You
NES at any time by running `/nes` NES at any time by running `/nes`
### Other Client Commands ### Other Client Commands
All other commands may be found on the [Archipelago Server and Client Commands Guide](/tutorial/archipelago/commands/en).
All other commands may be found on the [Archipelago Server and Client Commands Guide](/tutorial/archipelago/commands/en)
.

View File

@ -37,6 +37,7 @@ Using minecraft 1.17.1 connect to the server `localhost`.
Once you are in game type `/connect <AP-Address> (Port) (Password)` where `<AP-Address>` is the address of the Once you are in game type `/connect <AP-Address> (Port) (Password)` where `<AP-Address>` is the address of the
Archipelago server. `(Port)` is only required if the Archipelago server is not using the default port of Archipelago server. `(Port)` is only required if the Archipelago server is not using the default port of
38281. `(Password)` is only required if the Archipelago server you are using has a password set. 38281. `(Password)` is only required if the Archipelago server you are using has a password set.
### Play the game ### Play the game

View File

@ -2,29 +2,34 @@
## Required Software ## Required Software
- Rogue Legacy Randomizer from the [Rogue Legacy Randomizer Releases Page](https://github.com/ThePhar/RogueLegacyRandomizer/releases) - Rogue Legacy Randomizer from
the [Rogue Legacy Randomizer Releases Page](https://github.com/ThePhar/RogueLegacyRandomizer/releases)
## Configuring your YAML file ## Configuring your YAML file
### What is a YAML file and why do I need one? ### What is a YAML file and why do I need one?
Your YAML file contains a set of configuration options which provide the generator with information about how
it should generate your game. Each player of a multiworld will provide their own YAML file. This setup allows Your YAML file contains a set of configuration options which provide the generator with information about how it should
each player to enjoy an experience customized for their taste, and different players in the same multiworld generate your game. Each player of a multiworld will provide their own YAML file. This setup allows each player to enjoy
can all have different options. an experience customized for their taste, and different players in the same multiworld can all have different options.
### Where do I get a YAML file? ### Where do I get a YAML file?
you can customize your settings by visiting the [Rogue Legacy Settings Page](/games/Rogue%20Legacy/player-settings). you can customize your settings by visiting the [Rogue Legacy Settings Page](/games/Rogue%20Legacy/player-settings).
### Connect to the MultiServer ### Connect to the MultiServer
Once in game, press the start button and the AP connection screen should appear. You will fill out the hostname, port, Once in game, press the start button and the AP connection screen should appear. You will fill out the hostname, port,
slot name, and password (if applicable). You should only need to fill out hostname, port, and password if the server slot name, and password (if applicable). You should only need to fill out hostname, port, and password if the server
provides an alternative one to the default values. provides an alternative one to the default values.
### Play the game ### Play the game
Once you have entered the required values, you go to Connect and then select Confirm on the "Ready to Start" screen.
Now you're off to start your legacy! Once you have entered the required values, you go to Connect and then select Confirm on the "Ready to Start" screen. Now
you're off to start your legacy!
## Manual Installation ## Manual Installation
In order to run Rogue Legacy Randomizer you will need to have Rogue Legacy installed on your local machine. Extract the In order to run Rogue Legacy Randomizer you will need to have Rogue Legacy installed on your local machine. Extract the
Randomizer release into a desired folder **outside** of your Rogue Legacy install. Copy the following files from your Randomizer release into a desired folder **outside** of your Rogue Legacy install. Copy the following files from your
Rogue Legacy install into the main directory of your Rogue Legacy Randomizer install: Rogue Legacy install into the main directory of your Rogue Legacy Randomizer install:

View File

@ -6,20 +6,24 @@ For steam-based installation, subscribe to the following mods:
- ModTheSpire from the [Slay the Spire Workshop](https://steamcommunity.com/sharedfiles/filedetails/?id=1605060445) - ModTheSpire from the [Slay the Spire Workshop](https://steamcommunity.com/sharedfiles/filedetails/?id=1605060445)
- BaseMod from the [Slay the Spire Workshop](https://steamcommunity.com/workshop/filedetails/?id=1605833019) - BaseMod from the [Slay the Spire Workshop](https://steamcommunity.com/workshop/filedetails/?id=1605833019)
- Archipelago Multiworld Randomizer Mod from the [Slay the Spire Workshop](https://steamcommunity.com/sharedfiles/filedetails/?id=2596397288) - Archipelago Multiworld Randomizer Mod from
the [Slay the Spire Workshop](https://steamcommunity.com/sharedfiles/filedetails/?id=2596397288)
## Configuring your YAML file ## Configuring your YAML file
### What is a YAML file and why do I need one? ### What is a YAML file and why do I need one?
Your YAML file contains a set of configuration options which provide the generator with information about how
it should generate your game. Each player of a multiworld will provide their own YAML file. This setup allows Your YAML file contains a set of configuration options which provide the generator with information about how it should
each player to enjoy an experience customized for their taste, and different players in the same multiworld generate your game. Each player of a multiworld will provide their own YAML file. This setup allows each player to enjoy
can all have different options. an experience customized for their taste, and different players in the same multiworld can all have different options.
### Where do I get a YAML file? ### Where do I get a YAML file?
you can customize your settings by visiting the [Slay the Spire Settings Page](/games/Slay%20the%20Spire/player-settings).
you can customize your settings by visiting
the [Slay the Spire Settings Page](/games/Slay%20the%20Spire/player-settings).
### Connect to the MultiServer ### Connect to the MultiServer
For Steam-based installations, if you are subscribed to ModTheSpire, when you launch the game, you should have the For Steam-based installations, if you are subscribed to ModTheSpire, when you launch the game, you should have the
option to launch the game with mods. On the mod loader screen, ensure you only have the following mods enabled and then option to launch the game with mods. On the mod loader screen, ensure you only have the following mods enabled and then
start the game: start the game:

View File

@ -17,8 +17,8 @@
### Windows Setup ### Windows Setup
1. During the installation of Archipelago, you will have been asked to install the SNI Client. 1. During the installation of Archipelago, you will have been asked to install the SNI Client. If you did not do this,
If you did not do this, or you are on an older version, you may run the installer again to install the SNI Client. or you are on an older version, you may run the installer again to install the SNI Client.
2. During setup, you will be asked to locate your base ROM file. This is your Super Metroid ROM file. 2. During setup, you will be asked to locate your base ROM file. This is your Super Metroid ROM file.
3. If you are using an emulator, you should assign your Lua capable emulator as your default program for launching ROM 3. If you are using an emulator, you should assign your Lua capable emulator as your default program for launching ROM
files. files.

View File

@ -14,7 +14,12 @@ randomization of the items.
## Installation Procedures ## Installation Procedures
Download latest release on [Timespinner Randomizer Releases](https://github.com/JarnoWesthof/TsRandomizer/releases) you can find the .zip files on the releases page, download the zip for your current platform. Then extract the zip to the folder where your Timespinner game is installed. Then just run TsRandomizer.exe (on windows) or TsRandomizerItemTracker.bin.x86_64 (on linux) or TsRandomizerItemTracker.bin.osx (on mac) instead of Timespinner.exe to start the game in randomized mode, for more info see the [ReadMe for TsRandomizer](https://github.com/JarnoWesthof/TsRandomizer) Download latest release on [Timespinner Randomizer Releases](https://github.com/JarnoWesthof/TsRandomizer/releases) you
can find the .zip files on the releases page, download the zip for your current platform. Then extract the zip to the
folder where your Timespinner game is installed. Then just run TsRandomizer.exe (on windows) or
TsRandomizerItemTracker.bin.x86_64 (on linux) or TsRandomizerItemTracker.bin.osx (on mac) instead of Timespinner.exe to
start the game in randomized mode, for more info see
the [ReadMe for TsRandomizer](https://github.com/JarnoWesthof/TsRandomizer)
## Joining a MultiWorld Game ## Joining a MultiWorld Game
@ -24,10 +29,14 @@ Download latest release on [Timespinner Randomizer Releases](https://github.com/
4. Select "<< Archiplago >>" to open a new menu where you can enter your Archipelago login credentails 4. Select "<< Archiplago >>" to open a new menu where you can enter your Archipelago login credentails
* NOTE: the input fields support Ctrl + V pasting of values * NOTE: the input fields support Ctrl + V pasting of values
5. Select "Connect" 5. Select "Connect"
6. If all went well you will be taken back the difficulty selection menu and the game will start as soon as you select a difficulty 6. If all went well you will be taken back the difficulty selection menu and the game will start as soon as you select a
difficulty
## Where do I get a config file? ## Where do I get a config file?
The [Timespinner Player Settings Page](https://archipelago.gg/games/Timespinner/player-settings) on the website allows you to configure your personal settings and export a config file from them.
The [Timespinner Player Settings Page](https://archipelago.gg/games/Timespinner/player-settings) on the website allows
you to configure your personal settings and export a config file from them.
* The Timespinner Randomizer option "StinkyMaw" is currently always enabled for Archipelago generated seeds * The Timespinner Randomizer option "StinkyMaw" is currently always enabled for Archipelago generated seeds
* The Timespinner Randomizer options "ProgressiveVerticalMovement" & "ProgressiveKeycards" are currently not supported on Archipelago generated seeds * The Timespinner Randomizer options "ProgressiveVerticalMovement" & "ProgressiveKeycards" are currently not supported
on Archipelago generated seeds

View File

@ -1,6 +1,7 @@
# A Link to the Past Randomizer Setup Guide # A Link to the Past Randomizer Setup Guide
## Required Software ## Required Software
- [SNIClient](https://github.com/ArchipelagoMW/Archipelago/releases) included with the main Archipelago install - [SNIClient](https://github.com/ArchipelagoMW/Archipelago/releases) included with the main Archipelago install
or [SuperNintendoClient](https://github.com/ArchipelagoMW/SuperNintendoClient/releases) or [SuperNintendoClient](https://github.com/ArchipelagoMW/SuperNintendoClient/releases)
- If installing Archipelago, make sure to check the box for `SNI Client - A Link to the Past Patch Setup` - If installing Archipelago, make sure to check the box for `SNI Client - A Link to the Past Patch Setup`
@ -13,75 +14,83 @@ or [SuperNintendoClient](https://github.com/ArchipelagoMW/SuperNintendoClient/re
- Your Japanese v1.0 ROM file, probably named `Zelda no Densetsu - Kamigami no Triforce (Japan).sfc` - Your Japanese v1.0 ROM file, probably named `Zelda no Densetsu - Kamigami no Triforce (Japan).sfc`
## Installation Procedures ## Installation Procedures
1. Download and install your preferred client from the link above, making sure to install the most recent version. 1. Download and install your preferred client from the link above, making sure to install the most recent version.
**The installer file is located in the assets section at the bottom of the version information**. **The installer file is located in the assets section at the bottom of the version information**.
- During setup, you will be asked to locate your base ROM file. This is your Japanese Link to the Past ROM file. - During setup, you will be asked to locate your base ROM file. This is your Japanese Link to the Past ROM file.
2. If you are using an emulator, you should assign your Lua capable emulator as your default program 2. If you are using an emulator, you should assign your Lua capable emulator as your default program for launching ROM
for launching ROM files. files.
1. Extract your emulator's folder to your Desktop, or somewhere you will remember. 1. Extract your emulator's folder to your Desktop, or somewhere you will remember.
2. Right-click on a ROM file and select **Open with...** 2. Right-click on a ROM file and select **Open with...**
3. Check the box next to **Always use this app to open .sfc files** 3. Check the box next to **Always use this app to open .sfc files**
4. Scroll to the bottom of the list and click the grey text **Look for another App on this PC** 4. Scroll to the bottom of the list and click the grey text **Look for another App on this PC**
5. Browse for your emulator's `.exe` file and click **Open**. This file should be located inside 5. Browse for your emulator's `.exe` file and click **Open**. This file should be located inside the folder you
the folder you extracted in step one. extracted in step one.
## Create a Config (.yaml) File ## Create a Config (.yaml) File
### What is a config file and why do I need one? ### What is a config file and why do I need one?
Your config file contains a set of configuration options which provide the generator with information about how
it should generate your game. Each player of a multiworld will provide their own config file. This setup allows Your config file contains a set of configuration options which provide the generator with information about how it
each player to enjoy an experience customized for their taste, and different players in the same multiworld should generate your game. Each player of a multiworld will provide their own config file. This setup allows each player
can all have different options. to enjoy an experience customized for their taste, and different players in the same multiworld can all have different
options.
### Where do I get a config file? ### Where do I get a config file?
The [Player Settings](/games/A%20Link%20to%20the%20Past/player-settings) page on the website allows you to configure The [Player Settings](/games/A%20Link%20to%20the%20Past/player-settings) page on the website allows you to configure
your personal settings and export a config file from them. your personal settings and export a config file from them.
### Verifying your config file ### Verifying your config file
If you would like to validate your config file to make sure it works, you may do so on the If you would like to validate your config file to make sure it works, you may do so on the
[YAML Validator](/mysterycheck) page. [YAML Validator](/mysterycheck) page.
## Generating a Single-Player Game ## Generating a Single-Player Game
1. Navigate to the [Player Settings](/games/A%20Link%20to%20the%20Past/player-settings) page, configure your options, 1. Navigate to the [Player Settings](/games/A%20Link%20to%20the%20Past/player-settings) page, configure your options,
and click the "Generate Game" button. and click the "Generate Game" button.
2. You will be presented with a "Seed Info" page. 2. You will be presented with a "Seed Info" page.
3. Click the "Create New Room" link. 3. Click the "Create New Room" link.
4. You will be presented with a server page, from which you can download your patch file. 4. You will be presented with a server page, from which you can download your patch file.
5. Double-click on your patch file, and the Z3Client will launch automatically, create your ROM from 5. Double-click on your patch file, and the Z3Client will launch automatically, create your ROM from the patch file, and
the patch file, and open your emulator for you. open your emulator for you.
6. Since this is a single-player game, you will no longer need the client, so feel free to close it. 6. Since this is a single-player game, you will no longer need the client, so feel free to close it.
## Joining a MultiWorld Game ## Joining a MultiWorld Game
### Obtain your patch file and create your ROM ### Obtain your patch file and create your ROM
When you join a multiworld game, you will be asked to provide your config file to whoever is hosting. Once that
is done, the host will provide you with either a link to download your patch file, or with a zip file containing
everyone's patch files. Your patch file should have a `.apbp` extension.
Put your patch file on your desktop or somewhere convenient, and double click it. This should automatically When you join a multiworld game, you will be asked to provide your config file to whoever is hosting. Once that is done,
launch the client, and will also create your ROM in the same place as your patch file. the host will provide you with either a link to download your patch file, or with a zip file containing everyone's patch
files. Your patch file should have a `.apbp` extension.
Put your patch file on your desktop or somewhere convenient, and double click it. This should automatically launch the
client, and will also create your ROM in the same place as your patch file.
### Connect to the client ### Connect to the client
#### With an emulator #### With an emulator
When the client launched automatically, SNI should have also automatically launched in the background.
If this is its first time launching, you may be prompted to allow it to communicate through the Windows When the client launched automatically, SNI should have also automatically launched in the background. If this is its
Firewall. first time launching, you may be prompted to allow it to communicate through the Windows Firewall.
##### snes9x Multitroid ##### snes9x Multitroid
1. Load your ROM file if it hasn't already been loaded. 1. Load your ROM file if it hasn't already been loaded.
2. Click on the File menu and hover on **Lua Scripting** 2. Click on the File menu and hover on **Lua Scripting**
3. Click on **New Lua Script Window...** 3. Click on **New Lua Script Window...**
4. In the new window, click **Browse...** 4. In the new window, click **Browse...**
5. Select the connector lua file included with your client 5. Select the connector lua file included with your client
- SuperNintendoClient users should download `sniConnector.lua` from the client download page - SuperNintendoClient users should download `sniConnector.lua` from the client download page
- SNIClient users should look in their Archipelago folder for `/SNI/lua/x64` or `/SNI/lua/x86` depending on if - SNIClient users should look in their Archipelago folder for `/SNI/lua/x64` or `/SNI/lua/x86` depending on if the
the emulator is 64-bit or 32-bit. emulator is 64-bit or 32-bit.
##### BizHawk ##### BizHawk
1. Ensure you have the BSNES core loaded. You may do this by clicking on the Tools menu in BizHawk and following
these menu options: 1. Ensure you have the BSNES core loaded. You may do this by clicking on the Tools menu in BizHawk and following these
menu options:
`Config --> Cores --> SNES --> BSNES` `Config --> Cores --> SNES --> BSNES`
Once you have changed the loaded core, you must restart BizHawk. Once you have changed the loaded core, you must restart BizHawk.
2. Load your ROM file if it hasn't already been loaded. 2. Load your ROM file if it hasn't already been loaded.
@ -89,12 +98,13 @@ the emulator is 64-bit or 32-bit.
4. Click Script -> Open Script... 4. Click Script -> Open Script...
5. Select the `Connector.lua` file you downloaded above 5. Select the `Connector.lua` file you downloaded above
- SuperNintendoClient users should download `sniConnector.lua` from the client download page - SuperNintendoClient users should download `sniConnector.lua` from the client download page
- SNIClient users should look in their Archipelago folder for `/SNI/lua/x64` or `/SNI/lua/x86` depending on if - SNIClient users should look in their Archipelago folder for `/SNI/lua/x64` or `/SNI/lua/x86` depending on if the
the emulator is 64-bit or 32-bit. emulator is 64-bit or 32-bit.
#### With hardware #### With hardware
This guide assumes you have downloaded the correct firmware for your device. If you have not
done so already, please do this now. SD2SNES and FXPak Pro users may download the appropriate firmware This guide assumes you have downloaded the correct firmware for your device. If you have not done so already, please do
this now. SD2SNES and FXPak Pro users may download the appropriate firmware
[here](https://github.com/RedGuyyyy/sd2snes/releases). Other hardware may find helpful information [here](https://github.com/RedGuyyyy/sd2snes/releases). Other hardware may find helpful information
[on this page](http://usb2snes.com/#supported-platforms). [on this page](http://usb2snes.com/#supported-platforms).
@ -102,20 +112,22 @@ done so already, please do this now. SD2SNES and FXPak Pro users may download th
2. Power on your device and load the ROM. 2. Power on your device and load the ROM.
### Connect to the Archipelago Server ### Connect to the Archipelago Server
The patch file which launched your client should have automatically connected you to the AP Server.
There are a few reasons this may not happen however, including if the game is hosted on the website but
was generated elsewhere. If the client window shows "Server Status: Not Connected", simply ask the host
for the address of the server, and copy/paste it into the "Server" input field then press enter.
The client will attempt to reconnect to the new server address, and should momentarily show "Server The patch file which launched your client should have automatically connected you to the AP Server. There are a few
Status: Connected". reasons this may not happen however, including if the game is hosted on the website but was generated elsewhere. If the
client window shows "Server Status: Not Connected", simply ask the host for the address of the server, and copy/paste it
into the "Server" input field then press enter.
The client will attempt to reconnect to the new server address, and should momentarily show "Server Status: Connected".
### Play the game ### Play the game
When the client shows both SNES Device and Server as connected, you're ready to begin playing. Congratulations
on successfully joining a multiworld game! You can execute various commands in your client. For more information When the client shows both SNES Device and Server as connected, you're ready to begin playing. Congratulations on
regarding these commands you can use `/help` for local client commands and `!help` for server commands. successfully joining a multiworld game! You can execute various commands in your client. For more information regarding
these commands you can use `/help` for local client commands and `!help` for server commands.
## Hosting a MultiWorld game ## Hosting a MultiWorld game
The recommended way to host a game is to use our [hosting service](/generate). The process is relatively simple: The recommended way to host a game is to use our [hosting service](/generate). The process is relatively simple:
1. Collect config files from your players. 1. Collect config files from your players.
@ -123,8 +135,8 @@ The recommended way to host a game is to use our [hosting service](/generate). T
3. Upload that zip file to the website linked above. 3. Upload that zip file to the website linked above.
4. Wait a moment while the seed is generated. 4. Wait a moment while the seed is generated.
5. When the seed is generated, you will be redirected to a "Seed Info" page. 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, 6. Click "Create New Room". This will take you to the server page. Provide the link to this page to your players, so
so they may download their patch files from there. 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 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. 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. 8. Once all players have joined, you may begin playing.