From 494cfb3c0448ef15d203113c8a8035bd5b209447 Mon Sep 17 00:00:00 2001 From: Fabian Dill Date: Fri, 10 Sep 2021 15:20:45 +0200 Subject: [PATCH] Setup Guides: update LttP en and de guides with SNI --- .../assets/tutorial/zelda3/multiworld_de.md | 34 ++++++++----------- .../assets/tutorial/zelda3/multiworld_en.md | 17 +++++----- 2 files changed, 23 insertions(+), 28 deletions(-) diff --git a/WebHostLib/static/assets/tutorial/zelda3/multiworld_de.md b/WebHostLib/static/assets/tutorial/zelda3/multiworld_de.md index 8b0d78d8..51ac6020 100644 --- a/WebHostLib/static/assets/tutorial/zelda3/multiworld_de.md +++ b/WebHostLib/static/assets/tutorial/zelda3/multiworld_de.md @@ -2,9 +2,9 @@ ## Benötigte Software - [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases) -- [QUsb2Snes](https://github.com/Skarsnik/QUsb2snes/releases) (Included in the above Utilities) -- Hardware oder Software zum Laden und Abspielen von SNES Rom-Dateien - - Ein Emulator, der lua-scripts abspielen kann +- [SNI](https://github.com/alttpo/sni/releases) (Integriert in Archipelago) +- Hardware oder Software zum Laden und Abspielen von SNES Rom-Dateien fähig zu einer Internetverbindung + - Ein Emulator, der mit SNI verbinden kann ([snes9x Multitroid](https://drive.google.com/drive/folders/1_ej-pwWtCAHYXIrvs5Hro16A1s9Hi3Jz), [BizHawk](http://tasvideos.org/BizHawk.html)) - Ein SD2SNES, [FXPak Pro](https://krikzz.com/store/home/54-fxpak-pro.html), oder andere kompatible Hardware @@ -42,7 +42,7 @@ jeder Spieler sein Spiel nach seinem eigenen Geschmack gestalten, während ander Einstellungen wählen können! ### Wo bekomme ich so eine YAML-Datei her? -Die [Player Settings](/player-settings) Seite auf der Website ermöglicht das einfache Erstellen und Herunterladen +Die [Player Settings](/games/A Link to the Past/player-settings) Seite auf der Website ermöglicht das einfache Erstellen und Herunterladen deiner eigenen `yaml` Datei. Drei verschiedene Voreinstellungen können dort gespeichert werden. ### Deine YAML-Datei ist gewichtet! @@ -74,12 +74,12 @@ bei der [YAML Validator](/mysterycheck) Seite tun. ### Erhalte deine Patch-Datei und erstelle dein ROM Wenn du an einem MultiWorld-Spiel teilnehmen möchtest, wirst du in der Regel vom Host nach deiner YAML-Datei gefragt. Sobald du diese weitergegeben hast, wird der Host einen Link bereitstellen, wo du deinen Patch oder eine .zip-Datei -mit allen Patches herunterladen kannst. Die Patch-Datei hat immer die Endung `.bmbp`. +mit allen Patches herunterladen kannst. Die Patch-Datei hat immer die Endung `.apbp`. ### Mit dem Client verbinden #### Via Emulator -Wenn der client den Emulator automatisch gestartet hat, wird QUsb2Snes ebenfalls im Hintergrund gestartet. +Wenn der client den Emulator automatisch gestartet hat, wird SNI ebenfalls im Hintergrund gestartet. Wenn dies das erste Mal ist, wird möglicherweise ein Fenster angezeigt, wo man bestätigen muss, dass das Programm durch die Windows Firewall kommunizieren darf. @@ -88,8 +88,9 @@ durch die Windows Firewall kommunizieren darf. 2. Klicke auf den Reiter "File" oben im Menü und wähle **Lua Scripting** 3. Klicke auf **New Lua Script Window...** 4. Im sich neu öffnenden Fenster, klicke auf **Browse...** -5. Navigiere zum Ort, wo du snes9x Multitroid installiert hast, öffne den `lua`-Ordner und öffne `multibridge.lua` -6. Schaue im Lua-Fenster nach einem Namen, der dir zugeteilt wird und schaue im Client (WebUI im Browser), ob dort +5. Navigiere zum Verzeichnis, wo du Archipelago installiert hast und dort in den Unterordner `SNI`. +6. Wähle dort die `Connector.lua` und klicke auf Öffnen. +7. Schaue im Lua-Fenster nach einem Namen, der dir zugeteilt wird und schaue im Client (WebUI im Browser), ob dort "Snes Device: Connected" mit demselben Namen dort steht (in der oberen linken Ecke). ##### BizHawk @@ -99,9 +100,8 @@ durch die Windows Firewall kommunizieren darf. 2. Lade die entsprechende ROM-Datei, wenn sie nicht schon automatisch geladen wurde. 3. Klicke auf das Tools-Menü und klicke auf **Lua Console** 4. Klicke auf den Button um ein neues Lua-Script zu öffnen. -5. Navigiere zum Verzeichnis, wo du die Multiworld Utilities installiert hast und dort in folgende Ordner: - `QUsb2Snes/Qusb2Snes/LuaBridge` -6. Wähle dort die `luabridge.lua` und klicke auf Öffnen. +5. Navigiere zum Verzeichnis, wo du Archipelago installiert hast und dort in den Unterordner `SNI`. +6. Wähle dort die `Connector.lua` und klicke auf Öffnen. 7. Schaue im Lua-Fenster nach einem Namen, der dir zugeteilt wird und schaue im Client (WebUI im Browser), ob dort "Snes Device: Connected" mit demselben Namen dort steht (in der oberen linken Ecke) @@ -111,15 +111,11 @@ das noch nicht getan hast, so tue dies am besten jetzt! SD2SNES und FXPak Pro Nu [hier](https://github.com/RedGuyyyy/sd2snes/releases). Nutzer ähnlicher Hardware finden Hilfestellung [auf dieser Seite](http://usb2snes.com/#supported-platforms). -**UM MIT HARDWARE ZU VERBINDEN WIRD AKTUELL EINE ALTE VERSION VON QUSB2SNES BENÖTIGT -([v0.7.16](https://github.com/Skarsnik/QUsb2snes/releases/tag/v0.7.16)).** -Neuere Versionen funktionieren möglicherweise nur eingeschränkt, fehlerhaft oder gar nicht! 1. Schließe deinen Emulator, falls er automatisch gestartet haben sollte. -2. Schließe QUsb2Snes, welches automatisch mit dem Client gestartet wurde (in der Taskleiste zu finden). -3. Starte die richtige version von QUsb2Snes (v0.7.16). -4. Starte deine (Original-)Konsole und lade die ROM-Datei. -5. Schaue auf dein Clientfenster, welches nun "Snes Device: Connected" und den namen deiner Konsole +2. Start SNI +3. Starte deine (Original-)Konsole und lade die ROM-Datei. +4. Schaue auf dein Clientfenster, welches nun "Snes Device: Connected" und den namen deiner Konsole zeigen sollte. ### Mit dem MultiServer verbinden @@ -137,7 +133,7 @@ können du und deine Freunde loslegen! Glückwunsch zum erfolgreichen Beitritt z ## Ein Multiworld-Spiel hosten Die Empfohlene Art, ein Spiel zu hosten, ist, den Service auf -[der website](https://berserkermulti.world/generate) zu nutzen. Das Ganze ist recht einfach: +[der website](/generate) zu nutzen. Das Ganze ist recht einfach: 1. Lasse dir von deinen Mitspielern die YAML-Datei zuschicken. 2. Erstelle einen Zip-komprimierten Ordner´, in den du alle YAML-Dateien deiner Spieler einfügst. diff --git a/WebHostLib/static/assets/tutorial/zelda3/multiworld_en.md b/WebHostLib/static/assets/tutorial/zelda3/multiworld_en.md index 260eec98..ea10c84b 100644 --- a/WebHostLib/static/assets/tutorial/zelda3/multiworld_en.md +++ b/WebHostLib/static/assets/tutorial/zelda3/multiworld_en.md @@ -8,9 +8,9 @@ ## Required Software - [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases) -- [QUsb2Snes](https://github.com/Skarsnik/QUsb2snes/releases) (Included in the above Utilities) +- [SNI](https://github.com/alttpo/sni/releases) (Included in Archipelago) - Hardware or software capable of loading and playing SNES ROM files - - An emulator capable of running Lua scripts + - 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 @@ -19,10 +19,9 @@ ## Installation Procedures ### Windows Setup -1. Download and install the MultiWorld Utilities from the link above, making sure to install the most recent version. +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` - - If you intend to play the doors variant of multiworld, you will want to download the alternate doors file. - 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. @@ -50,7 +49,7 @@ each player to enjoy an experience customized for their taste, and different pla can all have different options. ### Where do I get a YAML file? -The [Generate Game](/player-settings) page on the website allows you to configure your personal settings and +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. ### Verifying your YAML file @@ -68,7 +67,7 @@ If you would like to validate your YAML file to make sure it works, you may do s ### 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 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 `.bmbp` extension. +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. @@ -76,7 +75,7 @@ launch the client, and will also create your ROM file in the same place as your ### Connect to the client #### With an emulator -When the client launched automatically, QUsb2Snes 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. @@ -98,8 +97,8 @@ Firewall. 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: - `QUsb2Snes/Qusb2Snes/LuaBridge` -6. Select `luabridge.lua` and click Open. + `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.