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

Docs: Cherry pick SM guide update from docs consolidation

This commit is contained in:
Scipio Wright 2022-01-05 16:58:49 +01:00 committed by Fabian Dill
parent 967e3028fd
commit f656f08f9b
1 changed files with 72 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,126 +1,143 @@
# Super Metroid Setup Guide # Super Metroid Setup Guide
## Required Software ## Required Software
- [Super Metroid Client](https://github.com/ArchipelagoMW/SuperMetroidClient/releases)
- **sniConnector.lua** (located on the client download page) - SNI Client
- [SNI](https://github.com/alttpo/sni/releases) (Included in the Super Metroid Client) - Included in Archipelago download
- 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
[BizHawk](http://tasvideos.org/BizHawk.html)) from: [snes9x Multitroid Download](https://drive.google.com/drive/folders/1_ej-pwWtCAHYXIrvs5Hro16A1s9Hi3Jz),
- An SD2SNES, [FXPak Pro](https://krikzz.com/store/home/54-fxpak-pro.html), or other compatible hardware - BizHawk from: [BizHawk Website](http://tasvideos.org/BizHawk.html)
- Your Super Metroid ROM file, probably named `Super Metroid (Japan, USA).sfc` - An SD2SNES, FXPak Pro ([FXPak Pro Store Page](https://krikzz.com/store/home/54-fxpak-pro.html)), or other
compatible hardware
- Your legally obtained Super Metroid ROM file, probably named `Super Metroid (Japan, USA).sfc`
## Installation Procedures ## Installation Procedures
### Windows Setup ### Windows Setup
1. Download and install the Super Metroid Client from the link above, making sure to install the most recent version.
**The file is located in the assets section at the bottom of the version information**. 1. During the installation of Archipelago, you will have been asked to install the SNI Client.
If you did not do this, 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 3. 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.
### Macintosh Setup ### Macintosh Setup
- We need volunteers to help fill this section! Please contact **Farrak Kilhn** on Discord if you want to help. - We need volunteers to help fill this section! Please contact **Farrak Kilhn** on Discord if you want to help.
## 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 See the guide on setting up a basic YAML at the Archipelago setup
each player to enjoy an experience customized for their taste, and different players in the same multiworld guide: [Basic Multiworld Setup Guide](/tutorial/archipelago/setup/en)
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
personal settings and export a config file from them. The Player Settings page on the website allows you to configure your personal settings and export a config file from
them. Player settings page: [Super Metroid Player Settings Page](/games/Super%20Metroid/player-settings)
### 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
[YAML Validator](/mysterycheck) page. 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: [YAML Validation page](/mysterycheck)
## 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
the "Generate Game" button. 1. Navigate to the Player Settings page, configure your options, and click the "Generate Game" button.
- Player Settings page: [Super Metroid Player Settings Page](/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
the patch file, and open your emulator for you. 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
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 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 `.apm3` 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 `sniConnector.lua` file you downloaded above 5. Select the `Connector.lua` file in the `Archipelago\SNI\lua` folder.
- Use x86 for 32-bit or x64 for 64-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.
3. Click on the Tools menu and click on **Lua Console** 3. Click on the Tools menu and click on **Lua Console**
4. Click the button to open a new Lua script. 4. Click the button to open a new Lua script.
5. Select the `sniConnector.lua` file you downloaded above 5. Select the `Connector.lua` file in `Archipelago\SNI\lua` folder.
- Use x86 for 32-bit or x64 for 64-bit. Please note the most recent versions of BizHawk are 64-bit only.
#### 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
[here](https://github.com/RedGuyyyy/sd2snes/releases). Other hardware may find helpful information this now. SD2SNES and FXPak Pro users may download the appropriate firmware on the SD2SNES releases page. SD2SNES
[on this page](http://usb2snes.com/#supported-platforms). releases page: [SD2SNES Releases Page](https://github.com/RedGuyyyy/sd2snes/releases)
Other hardware may find helpful information on the usb2snes platforms
page: [usb2snes Supported Platforms 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.
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! When the client shows both SNES Device and Server as connected, you're ready to begin playing. Congratulations 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: [WebHost Seed Generation Page](/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, 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.