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

WebHost: Update English SoE documentation.

This commit is contained in:
Hussein Farran 2021-12-02 20:14:53 -05:00
parent 40805ee870
commit d45bbb89b9
1 changed files with 28 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
WebHostLib/static/assets/tutorial/secret-of-evermore/multiworld_en.md
View File

@ -1,57 +1,50 @@
# Secret of Evermore Setup Guide # Secret of Evermore Setup Guide
## Required Software ## Required Software
- [SNI](https://github.com/alttpo/sni/releases) v0.0.59 or newer (included in Archipelago 0.2.1 setup) - SNI from: [https://github.com/alttpo/sni/releases](https://github.com/alttpo/sni/releases)
- v0.0.59 or newer (included in Archipelago 0.2.1 setup)
- 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 with ROM access - An emulator capable of connecting to SNI with ROM access. Any one of the following will work:
- [snes9x-rr](https://github.com/gocha/snes9x-rr/releases) or - snes9x-rr from: [https://github.com/gocha/snes9x-rr/releases](https://github.com/gocha/snes9x-rr/releases)
- [BizHawk](http://tasvideos.org/BizHawk.html) or - BizHawk from: [http://tasvideos.org/BizHawk.html](http://tasvideos.org/BizHawk.html)
- [bsnes-plus-nwa](https://github.com/black-sliver/bsnes-plus) - bsnes-plus-nwa from: [https://github.com/black-sliver/bsnes-plus](https://github.com/black-sliver/bsnes-plus)
- Or SD2SNES, [FXPak Pro](https://krikzz.com/store/home/54-fxpak-pro.html), or other compatible hardware - Or 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 Secret of Evermore US ROM file, probably named `Secret of Evermore (USA).sfc` - Your legally obtained Secret of Evermore US ROM file, probably named `Secret of Evermore (USA).sfc`
## 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/Secret%20of%20Evermore/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/Secret%20of%20Evermore/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: [click here](/mysterycheck)
[YAML Validator](/mysterycheck) page.
## Generating a Single-Player Game ## Generating a Single-Player Game
Stand-alone "Evermizer" has a way of balancing single-player games, but may not always be on par feature-wise. Stand-alone "Evermizer" has a way of balancing single-player games, but may not always be on par feature-wise. Head over to [https://evermizer.com](https://evermizer.com) if you want to try the official stand-alone, otherwise read below.
Head over to [evermizer.com](https://evermizer.com) if you want to try the official stand-alone, otherwise read below.
1. Navigate to the [Player Settings](/games/Secret%20of%20Evermore/player-settings) page, configure your options, and 1. Navigate to the Player Settings page, configure your options, and
click the "Generate Game" button. click the "Generate Game" button.
- Player Settings page: [click here](/games/Secret%20of%20Evermore/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. Run your patch file through [apbpatch](https://evermizer.com/apbpatch) and load it in your emulator or console. 5. Run your patch file through the apbpatch on evermizer.com and load it in your emulator or console.
* apbpatch page: [click here](https://evermizer.com/apbpatch)
## 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 `.apsoe` 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 `.apsoe` extension.
Put your patch file on your desktop or somewhere convenient, open [apbpatch](https://evermizer.com/apbpatch) and Put your patch file on your desktop or somewhere convenient, open the apbpatch page on evermizer.com and generate your ROM from it. Load the ROM file in your emulator or console. apbpatch page: [https://evermizer.com/apbpatch](https://evermizer.com/apbpatch)
generate your ROM from it. Load the ROM file in your emulator or console.
### Connect to SNI ### Connect to SNI
#### With an emulator #### With an emulator
Start SNI either from the Archipelago install folder or the stand-alone version. Start SNI either from the Archipelago install folder or the stand-alone version. 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-rr ##### snes9x-rr
1. Load your ROM file if it hasn't already been loaded. 1. Load your ROM file if it hasn't already been loaded.
@ -81,35 +74,31 @@ This should automatically connect to SNI.
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.
#### 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. Copy the ROM file to your SD card. 1. Copy the ROM file to your SD card.
2. Load the ROM file from the menu. 2. Load the ROM file from the menu.
### Open the client ### Open the client
Open [ap-soeclient](http://evermizer.com/apclient) in a modern browser. Do not switch tabs, open it in a new window Open ap-soeclient ([http://evermizer.com/apclient](http://evermizer.com/apclient)) in a modern browser. Do not switch tabs, open it in a new window if you want to use the browser while playing. Do not minimize the window with the client.
if you want to use the browser while playing. Do not minimize the window with the client.
The client should automatically connect to SNI, the "SNES" status should change to green. The client should automatically connect to SNI, the "SNES" status should change to green.
### Connect to the Archipelago Server ### Connect to the Archipelago Server
Enter `/connect server:port` in the client's command prompt and press enter. You'll find `server:port` on the same page Enter `/connect server:port` in the client's command prompt and press enter. You'll find `server:port` on the same page that had the patch file.
that had the patch file.
### Play the game ### Play the game
When the game is loaded but not yet past the intro cutscene, the "Game" status is yellow. When the client shows "AP" as When the game is loaded but not yet past the intro cutscene, the "Game" status is yellow. When the client shows "AP" as green and "Game" as yellow, you're ready to play. The intro can be skipped pressing the START button and "Game" should change to green. Congratulations on successfully joining a multiworld game!
green and "Game" as yellow, you're ready to play. The intro can be skipped pressing the START button and "Game" should
change to green. 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.
- 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,