From 52a96044f39ef1c6c8bc62b6a683b767075ee205 Mon Sep 17 00:00:00 2001 From: alwaysintreble <mmmcheese158@gmail.com> Date: Thu, 5 Jan 2023 09:38:07 -0600 Subject: [PATCH 1/5] clarify not using qusb and remove redundancies --- worlds/alttp/docs/multiworld_en.md | 49 +++++------------------------- 1 file changed, 7 insertions(+), 42 deletions(-) diff --git a/worlds/alttp/docs/multiworld_en.md b/worlds/alttp/docs/multiworld_en.md index e758edc22c6e..cbc036dc6313 100644 --- a/worlds/alttp/docs/multiworld_en.md +++ b/worlds/alttp/docs/multiworld_en.md @@ -3,6 +3,8 @@ ## Required Software - [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases). Make sure to check the box for `SNI Client - A Link to the Past Patch Setup` +- [SNI](https://github.com/alttpo/sni/releases). This is automatically included with your Archipelago installation above, +and *IS NOT COMPATIBLE WITH (Q)Usb2Snes* - Hardware or software capable of loading and playing SNES ROM files - An emulator capable of connecting to SNI ([snes9x rr](https://github.com/gocha/snes9x-rr/releases), @@ -27,35 +29,13 @@ modded SNES minis are currently not supported by SNI** 5. Browse for your emulator's `.exe` file and click **Open**. This file should be located inside the folder you extracted in step one. -## 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/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 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 +## Generating a MultiWorld 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. -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 SNIClient 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. + and click the "Export Settings" button. + - For instructions on how to generate an Archipelago game with the settings file, refer to the +[Archipelago Web Guide](/tutorial/Archipelago/using_website/en). + - If you manually edit your config file, you can verify it with our [YAML Validator](/mysterycheck). ## Joining a MultiWorld Game @@ -141,18 +121,3 @@ The client will attempt to reconnect to the new server address, and should momen 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 regarding these commands you can use `/help` for local client commands and `!help` for server commands. - -## 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. From 62eb8ab150e4746ff293a6df7039f1bf61e2fe76 Mon Sep 17 00:00:00 2001 From: alwaysintreble <mmmcheese158@gmail.com> Date: Thu, 5 Jan 2023 09:43:26 -0600 Subject: [PATCH 2/5] SNES mini note --- worlds/alttp/docs/multiworld_en.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/worlds/alttp/docs/multiworld_en.md b/worlds/alttp/docs/multiworld_en.md index cbc036dc6313..b6497a412991 100644 --- a/worlds/alttp/docs/multiworld_en.md +++ b/worlds/alttp/docs/multiworld_en.md @@ -11,7 +11,8 @@ and *IS NOT COMPATIBLE WITH (Q)Usb2Snes* [BizHawk](http://tasvideos.org/BizHawk.html), or [RetroArch](https://retroarch.com?page=platforms) 1.10.1 or newer). Or, - An SD2SNES, [FXPak Pro](https://krikzz.com/store/home/54-fxpak-pro.html), or other compatible hardware. **note: -modded SNES minis are currently not supported by SNI** +modded SNES minis are currently not supported by SNI. Some users have claimed success with (Q)Usb2Snes for this system +but support is not guaranteed.** - Your Japanese v1.0 ROM file, probably named `Zelda no Densetsu - Kamigami no Triforce (Japan).sfc` ## Installation Procedures From 8b08ca04688871ec8de5a16f7ea2b397c6179d49 Mon Sep 17 00:00:00 2001 From: alwaysintreble <mmmcheese158@gmail.com> Date: Thu, 5 Jan 2023 09:45:59 -0600 Subject: [PATCH 3/5] () --- worlds/alttp/docs/multiworld_en.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/worlds/alttp/docs/multiworld_en.md b/worlds/alttp/docs/multiworld_en.md index b6497a412991..0aa6d0c8983d 100644 --- a/worlds/alttp/docs/multiworld_en.md +++ b/worlds/alttp/docs/multiworld_en.md @@ -11,7 +11,7 @@ and *IS NOT COMPATIBLE WITH (Q)Usb2Snes* [BizHawk](http://tasvideos.org/BizHawk.html), or [RetroArch](https://retroarch.com?page=platforms) 1.10.1 or newer). Or, - An SD2SNES, [FXPak Pro](https://krikzz.com/store/home/54-fxpak-pro.html), or other compatible hardware. **note: -modded SNES minis are currently not supported by SNI. Some users have claimed success with (Q)Usb2Snes for this system +modded SNES minis are currently not supported by SNI. Some users have claimed success with QUsb2Snes for this system but support is not guaranteed.** - Your Japanese v1.0 ROM file, probably named `Zelda no Densetsu - Kamigami no Triforce (Japan).sfc` From 56bfec82ba727f3965c93f80486174f1ecd33a33 Mon Sep 17 00:00:00 2001 From: alwaysintreble <mmmcheese158@gmail.com> Date: Tue, 27 Jun 2023 17:20:27 -0500 Subject: [PATCH 4/5] review suggestions --- worlds/alttp/docs/multiworld_en.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/worlds/alttp/docs/multiworld_en.md b/worlds/alttp/docs/multiworld_en.md index 0aa6d0c8983d..70065913391b 100644 --- a/worlds/alttp/docs/multiworld_en.md +++ b/worlds/alttp/docs/multiworld_en.md @@ -2,17 +2,18 @@ ## Required Software -- [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases). Make sure to check the box for `SNI Client - A Link to the Past Patch Setup` -- [SNI](https://github.com/alttpo/sni/releases). This is automatically included with your Archipelago installation above, -and *IS NOT COMPATIBLE WITH (Q)Usb2Snes* +- [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases). Make sure to check the box for +`SNI Client - A Link to the Past Patch Setup` +- [SNI](https://github.com/alttpo/sni/releases). This is automatically included with your Archipelago installation above. +- SNI is not compatible with (Q)Usb2Snes. - Hardware or software capable of loading and playing SNES ROM files - An emulator capable of connecting to SNI ([snes9x rr](https://github.com/gocha/snes9x-rr/releases), [BizHawk](http://tasvideos.org/BizHawk.html), or [RetroArch](https://retroarch.com?page=platforms) 1.10.1 or newer). Or, - An SD2SNES, [FXPak Pro](https://krikzz.com/store/home/54-fxpak-pro.html), or other compatible hardware. **note: -modded SNES minis are currently not supported by SNI. Some users have claimed success with QUsb2Snes for this system -but support is not guaranteed.** +modded SNES minis are currently not supported by SNI. Some users have claimed success with QUsb2Snes for this system, +but it is not supported.** - Your Japanese v1.0 ROM file, probably named `Zelda no Densetsu - Kamigami no Triforce (Japan).sfc` ## Installation Procedures From 663a535e2ed1bc7e7cbe26a4ffcc95843c16d186 Mon Sep 17 00:00:00 2001 From: alwaysintreble <mmmcheese158@gmail.com> Date: Tue, 27 Jun 2023 17:32:13 -0500 Subject: [PATCH 5/5] remove remaining repetitive text --- worlds/alttp/docs/multiworld_en.md | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/worlds/alttp/docs/multiworld_en.md b/worlds/alttp/docs/multiworld_en.md index 59f29f030e51..3d27a7f7ffe0 100644 --- a/worlds/alttp/docs/multiworld_en.md +++ b/worlds/alttp/docs/multiworld_en.md @@ -31,16 +31,6 @@ but it is not supported.** 5. Browse for your emulator's `.exe` file and click **Open**. This file should be located inside the folder you extracted in step one. -## Generating a MultiWorld Game - -1. Navigate to the [Player Settings](/games/A%20Link%20to%20the%20Past/player-settings) page, configure your options, - and click the "Export Settings" button. - - For instructions on how to generate an Archipelago game with the settings file, refer to the -[Archipelago Web Guide](/tutorial/Archipelago/using_website/en). - - If you manually edit your config file, you can verify it with our [YAML Validator](/mysterycheck). - -## 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,