From f3ddfb96f37bfa2f6e7a8eace060b89e5890bd33 Mon Sep 17 00:00:00 2001 From: Chris Wilson Date: Mon, 18 Oct 2021 09:02:52 -0400 Subject: [PATCH] Add Super Metroid setup guide, update LttP setup guide --- .../assets/gameInfo/en_Super Metroid.md | 0 .../tutorial/super-metroid/multiworld_en.md | 126 ++++++++++++++++++ .../static/assets/tutorial/tutorials.json | 19 +++ .../assets/tutorial/zelda3/multiworld_en.md | 112 ++++++---------- 4 files changed, 183 insertions(+), 74 deletions(-) create mode 100644 WebHostLib/static/assets/gameInfo/en_Super Metroid.md create mode 100644 WebHostLib/static/assets/tutorial/super-metroid/multiworld_en.md diff --git a/WebHostLib/static/assets/gameInfo/en_Super Metroid.md b/WebHostLib/static/assets/gameInfo/en_Super Metroid.md new file mode 100644 index 00000000..e69de29b diff --git a/WebHostLib/static/assets/tutorial/super-metroid/multiworld_en.md b/WebHostLib/static/assets/tutorial/super-metroid/multiworld_en.md new file mode 100644 index 00000000..88f8b844 --- /dev/null +++ b/WebHostLib/static/assets/tutorial/super-metroid/multiworld_en.md @@ -0,0 +1,126 @@ +# Super Metroid Setup Guide + +## Required Software +- [Super Metroid Client](https://github.com/ArchipelagoMW/SuperMetroidClient/releases) +- **sniConnector.lua** (located on the client download page) +- [SNI](https://github.com/alttpo/sni/releases) (Included in the Super Metroid Client) +- Hardware or software capable of loading and playing SNES ROM files + - An emulator capable of connecting to SNI + ([snes9x Multitroid](https://drive.google.com/drive/folders/1_ej-pwWtCAHYXIrvs5Hro16A1s9Hi3Jz), + [BizHawk](http://tasvideos.org/BizHawk.html)) + - An SD2SNES, [FXPak Pro](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` + +## Installation Procedures + +### 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**. +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 files. + 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...** + 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** + 5. Browse for your emulator's `.exe` file and click **Open**. This file should be located inside + the folder you extracted in step one. + +### Macintosh Setup +- We need volunteers to help fill this section! Please contact **Farrak Kilhn** on Discord if you want to help. + +## Create a Config (.yaml) File + +### 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 +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? +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. + +### 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. + +## 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. +2. You will be presented with a "Seed Info" page. +3. Click the "Create New Room" link. +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 + 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. + +## Joining a MultiWorld Game + +### 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 +launch the client, and will also create your ROM in the same place as your patch file. + +### Connect to the client + +#### 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 +Firewall. + +##### snes9x Multitroid +1. Load your ROM file if it hasn't already been loaded. +2. Click on the File menu and hover on **Lua Scripting** +3. Click on **New Lua Script Window...** +4. In the new window, click **Browse...** +5. Select the `sniConnector.lua` file you downloaded above + +##### 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: + `Config --> Cores --> SNES --> BSNES` + Once you have changed the loaded core, you must restart BizHawk. +2. Load your ROM file if it hasn't already been loaded. +3. Click on the Tools menu and click on **Lua Console** +4. Click the button to open a new Lua script. +5. Select the `sniConnector.lua` file you downloaded above + +#### 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 +[here](https://github.com/RedGuyyyy/sd2snes/releases). Other hardware may find helpful information +[on this page](http://usb2snes.com/#supported-platforms). + +1. Close your emulator, which may have auto-launched. +2. Power on your device and load the ROM. + +### 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 +Status: Connected". + +### 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! + +## Hosting a MultiWorld game +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. +2. Create a zip file containing your players' config files. +3. Upload that zip file to the website linked above. +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. +8. Once all players have joined, you may begin playing. diff --git a/WebHostLib/static/assets/tutorial/tutorials.json b/WebHostLib/static/assets/tutorial/tutorials.json index 6d60f141..b01f67e5 100644 --- a/WebHostLib/static/assets/tutorial/tutorials.json +++ b/WebHostLib/static/assets/tutorial/tutorials.json @@ -223,5 +223,24 @@ ] } ] + }, + { + "gameTitle": "Super Metroid", + "tutorials": [ + { + "name": "Multiworld Setup Guide", + "description": "A guide to setting up the Super Metroid Client on your computer. This guide covers single-player, multiworld, and related software.", + "files": [ + { + "language": "English", + "filename": "super-metroid/multiworld_en.md", + "link": "super-metroid/multiworld/en", + "authors": [ + "Farrak Kilhn" + ] + } + ] + } + ] } ] diff --git a/WebHostLib/static/assets/tutorial/zelda3/multiworld_en.md b/WebHostLib/static/assets/tutorial/zelda3/multiworld_en.md index c93a98d8..ed2fe4b7 100644 --- a/WebHostLib/static/assets/tutorial/zelda3/multiworld_en.md +++ b/WebHostLib/static/assets/tutorial/zelda3/multiworld_en.md @@ -1,14 +1,9 @@ # A Link to the Past Randomizer Setup Guide -
- -
- ## Required Software -- [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases) -- [SNI](https://github.com/alttpo/sni/releases) (Included in Archipelago) +- [Z3Client](https://github.com/ArchipelagoMW/Z3Client/releases) +- **sniConnector.lua** (located on the client download page) +- [SNI](https://github.com/alttpo/sni/releases) (Included in the Super Metroid Client) - Hardware or software capable of loading and playing SNES ROM files - An emulator capable of connecting to SNI ([snes9x Multitroid](https://drive.google.com/drive/folders/1_ej-pwWtCAHYXIrvs5Hro16A1s9Hi3Jz), @@ -19,19 +14,14 @@ ## Installation Procedures ### Windows Setup -1. Download and install Archipelago 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**. If you intend to play normal -multiworld games, you want `Setup.Archipelago.exe` - - During the installation process, you will be asked to browse for your Japanese 1.0 ROM file. If you have - installed this software before and are simply upgrading now, you will not be prompted to locate your - ROM file a second time. - - You may also be prompted to install Microsoft Visual C++. If you already have this software on your computer - (possibly because a Steam game installed it already), the installer will not prompt you to install it again. +1. Download and install the Z3Client 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**. + - 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 for launching ROM files. 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** 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 @@ -40,37 +30,41 @@ for launching ROM files. ### Macintosh Setup - We need volunteers to help fill this section! Please contact **Farrak Kilhn** on Discord if you want to help. -## Configuring your YAML file +## Create a Config (.yaml) File -### 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 +### 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 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 YAML file? -The [Generate Game](/games/A Link to the Past/player-settings) page on the website allows you to configure your personal settings and -export a YAML file from them. +### 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 +your personal settings and export a config file from them. -### Verifying your YAML file -If you would like to validate your YAML file to make sure it works, you may do so on the +### 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. ## Generating a Single-Player Game -1. Navigate to the [Player Settings](/games/A%20Link%20to%20the%20Past/player-settings) page, configure your options, and click the "Generate Game" button. -2. You will be presented with a "Seed Info" page, where you can download your patch file. -3. Double-click on your patch file, and the emulator should launch with your game automatically. As the - Client is unnecessary for single player games, you may close it and the WebUI. +1. Navigate to the [Player Settings](/games/A%20Link%20to%20the%20Past/player-settings) page, configure your options, + and click the "Generate Game" button. +2. You will be presented with a "Seed Info" page. +3. Click the "Create New Room" link. +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 + 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. ## Joining a MultiWorld Game ### Obtain your patch file and create your ROM -When you join a multiworld game, you will be asked to provide your YAML 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 `.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 file 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 @@ -84,23 +78,17 @@ Firewall. 2. Click on the File menu and hover on **Lua Scripting** 3. Click on **New Lua Script Window...** 4. In the new window, click **Browse...** -5. Browse to the location you extracted snes9x Multitroid to, enter the `lua` folder, and choose `multibridge.lua` -6. Observe a name has been assigned to you, and that the client shows "SNES Device: Connected", with that same - name in the upper left corner. +5. Select the `sniConnector.lua` file you downloaded above ##### 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: + these menu options: `Config --> Cores --> SNES --> BSNES` Once you have changed the loaded core, you must restart BizHawk. 2. Load your ROM file if it hasn't already been loaded. 3. Click on the Tools menu and click on **Lua Console** 4. Click the button to open a new Lua script. -5. Browse to your MultiWorld Utilities installation directory, and into the following directories: - `SNI` -6. Select `Connector.lua` and click Open. -7. Observe a name has been assigned to you, and that the client shows "SNES Device: Connected", with that same - name in the upper left corner. +5. Select the `sniConnector.lua` file you downloaded above #### With hardware This guide assumes you have downloaded the correct firmware for your device. If you have not @@ -110,54 +98,30 @@ done so already, please do this now. SD2SNES and FXPak Pro users may download th 1. Close your emulator, which may have auto-launched. 2. Power on your device and load the ROM. -3. Observe the client window now shows "SNES Device: Connected", and lists the name of your device. -### Connect to the MultiServer -The patch file which launched your client should have automatically connected you to the MultiServer. +### 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 -Status: Connected". If the client does not connect after a few moments, you may need to refresh the page. +Status: Connected". ### 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! ## Hosting a MultiWorld game -The recommended way to host a game is to use the hosting service provided on -[the website](/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 YAML files from your players. -2. Create a zip file containing your players' YAML files. +1. Collect config files from your players. +2. Create a zip file containing your players' config files. 3. Upload that zip file to the website linked above. 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. - **Note:** The patch files provided on this page will allow players to automatically connect to the server, - while the patch files on the "Seed Info" page will not. -7. Note that a link to a MultiWorld Tracker is at the top of the room page. You should also provide this link - to your players, so they can watch the progress of the game. Any observers may also be given the link to - this page. + 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. - -## Auto-Tracking -If you would like to use auto-tracking for your game, several pieces of software provide this functionality. -The recommended software for auto-tracking is currently -[OpenTracker](https://github.com/trippsc2/OpenTracker/releases). - -### Installation -1. Download the appropriate installation file for your computer (Windows users want the `.msi` file). -2. During the installation process, you may be asked to install the Microsoft Visual Studio Build Tools. A link - to this software is provided during the installation procedure, and it must be installed manually. - -### Enable auto-tracking -1. With OpenTracker launched, click the Tracking menu at the top of the window, then choose **AutoTracker...** -2. Click the **Get Devices** button -3. Select your SNES device from the drop-down list -4. If you would like to track small keys and dungeon items, check the box labeled **Race Illegal Tracking** -5. Click the **Start Autotracking** button -6. Close the AutoTracker window, as it is no longer necessary -