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

WebHost: Update English Super Metroid documentation.

This commit is contained in:
Hussein Farran 2021-12-02 20:22:18 -05:00
parent bfa4d06ecf
commit b7ff5d9a57
1 changed files with 26 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
WebHostLib/static/assets/tutorial/super-metroid/multiworld_en.md
View File

@ -1,15 +1,16 @@
# Super Metroid Setup Guide # Super Metroid Setup Guide
## Required Software ## Required Software
- [Super Metroid Client](https://github.com/ArchipelagoMW/SuperMetroidClient/releases) - Super Metroid Client from: [https://github.com/ArchipelagoMW/SuperMetroidClient/releases](https://github.com/ArchipelagoMW/SuperMetroidClient/releases)
- **sniConnector.lua** (located on the client download page) - **sniConnector.lua** (located on the client download page)
- [SNI](https://github.com/alttpo/sni/releases) (Included in the Super Metroid Client) - SNI from: [https://github.com/alttpo/sni/releases](https://github.com/alttpo/sni/releases)
- Included in the Super Metroid Client
- Hardware or software capable of loading and playing SNES ROM files - Hardware or software capable of loading and playing SNES ROM files
- An emulator capable of connecting to SNI - An emulator capable of connecting to SNI such as:
([snes9x Multitroid](https://drive.google.com/drive/folders/1_ej-pwWtCAHYXIrvs5Hro16A1s9Hi3Jz), - snes9x Multitroid from: [https://drive.google.com/drive/folders/1_ej-pwWtCAHYXIrvs5Hro16A1s9Hi3Jz](https://drive.google.com/drive/folders/1_ej-pwWtCAHYXIrvs5Hro16A1s9Hi3Jz),
[BizHawk](http://tasvideos.org/BizHawk.html)) - BizHawk from: [http://tasvideos.org/BizHawk.html](http://tasvideos.org/BizHawk.html)
- An SD2SNES, [FXPak Pro](https://krikzz.com/store/home/54-fxpak-pro.html), or other compatible hardware - An SD2SNES, FXPak Pro ([https://krikzz.com/store/home/54-fxpak-pro.html](https://krikzz.com/store/home/54-fxpak-pro.html)), or other compatible hardware
- Your Super Metroid ROM file, probably named `Super Metroid (Japan, USA).sfc` - Your legally obtained Super Metroid ROM file, probably named `Super Metroid (Japan, USA).sfc`
## Installation Procedures ## Installation Procedures
@ -32,45 +33,35 @@ for launching ROM files.
## 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 See the guide on setting up a basic YAML at the Archipelago setup guide: [click here](/tutorial/archipelago/setup/en)
it should generate your game. Each player of a multiworld will provide their own config file. This setup allows
each player 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/Super%20Metroid/player-settings) page on the website allows you to configure your The Player Settings page on the website allows you to configure your personal settings and export a config file from them. Player settings page: [click here](/games/Super%20Metroid/player-settings)
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 page. YAML validator page: [click here](/mysterycheck)
[YAML Validator](/mysterycheck) page.
## Generating a Single-Player Game ## Generating a Single-Player Game
1. Navigate to the [Player Settings](/games/Super%20Metroid/player-settings) page, configure your options, and click 1. Navigate to the Player Settings page, configure your options, and click
the "Generate Game" button. the "Generate Game" button.
- Player Settings page: [click here](/games/Super%20Metroid/player-settings)
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 Super Metroid Client will launch automatically, create your ROM from 5. Double-click on your patch file, and the Super Metroid Client will launch automatically, create your ROM from the patch file, and open your emulator for you.
the patch file, and 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 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 `.apm3` extension.
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 `.apm3` extension.
Put your patch file on your desktop or somewhere convenient, and double click it. This should automatically 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.
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. 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 Firewall.
If this is its 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.
@ -90,33 +81,28 @@ Firewall.
5. Select the `sniConnector.lua` file you downloaded above 5. Select the `sniConnector.lua` file you downloaded above
#### With hardware #### With hardware
This guide assumes you have downloaded the correct firmware for your device. If you have not 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 on the SD2SNES releases page. SD2SNES releases page: [https://github.com/RedGuyyyy/sd2snes/releases](https://github.com/RedGuyyyy/sd2snes/releases)
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 Other hardware may find helpful information on the usb2snes platforms page: [http://usb2snes.com/#supported-platforms](http://usb2snes.com/#supported-platforms)
[on this page](http://usb2snes.com/#supported-platforms).
1. Close your emulator, which may have auto-launched. 1. Close your emulator, which may have auto-launched.
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. 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.
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 client will attempt to reconnect to the new server address, and should momentarily show "Server Status: Connected".
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 When the client shows both SNES Device and Server as connected, you're ready to begin playing. Congratulations on successfully joining a multiworld game!
on successfully joining a multiworld game!
## 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. The process is relatively simple:
1. Collect config files from your players. 1. Collect config files from your players.
2. Create a zip file containing your players' config files. 2. Create a zip file containing your players' config files.
3. Upload that zip file to the website linked above. 3. Upload that zip file to the Generate page above.
- Generate page: [click here](/generate)
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,