From a43b027cded8fd7ad3dd73c5b4653a7ecdfbe1ba Mon Sep 17 00:00:00 2001
From: Fabian Dill <fabian.dill@web.de>
Date: Tue, 19 Oct 2021 02:41:40 +0200
Subject: [PATCH] Subnautica: add an install guide

---
 .../assets/tutorial/Subnautica/setup_en.md    | 32 +++++++++++++++++++
 .../static/assets/tutorial/tutorials.json     | 19 +++++++++++
 2 files changed, 51 insertions(+)
 create mode 100644 WebHostLib/static/assets/tutorial/Subnautica/setup_en.md

diff --git a/WebHostLib/static/assets/tutorial/Subnautica/setup_en.md b/WebHostLib/static/assets/tutorial/Subnautica/setup_en.md
new file mode 100644
index 00000000..2fcae0e4
--- /dev/null
+++ b/WebHostLib/static/assets/tutorial/Subnautica/setup_en.md
@@ -0,0 +1,32 @@
+# Subnautica Randomizer Setup Guide
+
+## Required Software
+
+- [Subnautica](https://store.steampowered.com/app/264710/Subnautica/)
+- [QModManager4](https://www.nexusmods.com/subnautica/mods/201)
+- [Archipelago Mod for Subnautica](https://github.com/Berserker66/ArchipelagoSubnauticaModSrc/releases)
+
+
+## Installation Procedures
+
+1. Install QModManager4 as per its instructions.
+
+2. The folder you installed QModManager4 into will now have a /QMods directory. It might appear after a start of Subnautica. You can also create this folder yourself.
+
+3. Unpack the Archipelago Mod into this folder, so that Subnautica/QMods/Archipelago/ is a valid path.
+
+4. Start Subnautica. You should see a Connect Menu in the topleft of your main Menu. 
+
+## Troubleshooting
+
+If you don't see the connect window check that you see a qmodmanager_log-Subnautica.txt in Subnautica, if not QModManager4 is not correctly installed, otherwise open it and look for `[Info   :   BepInEx] Loading [Archipelago 1.0.0.0]`, version number doesn't matter. If it doesn't show this, then QModManager4 didn't find the Archipelago mod, so check your paths.
+    
+## Joining a MultiWorld Game
+
+1. In Host, enter the address of the server, such as archipelago.gg:38281, your server host should be able to tell you this.
+
+2. In Password enter the server password if one exists, otherwise leave blank.
+
+3. In PlayerName enter your "name" field from the yaml, or website config.
+
+4. Hit Connect. If it says succesfully authenticated you can now create a new savegame or resume the correct savegame.
\ No newline at end of file
diff --git a/WebHostLib/static/assets/tutorial/tutorials.json b/WebHostLib/static/assets/tutorial/tutorials.json
index b01f67e5..1312cb38 100644
--- a/WebHostLib/static/assets/tutorial/tutorials.json
+++ b/WebHostLib/static/assets/tutorial/tutorials.json
@@ -224,6 +224,25 @@
       }
     ]
   },
+  {
+    "gameTitle": "Subnautica",
+    "tutorials": [
+      {
+        "name": "Multiworld Setup Guide",
+        "description": "A guide to setting up the Subnautica randomizer connected to an Archipelago Multiworld",
+        "files": [
+          {
+            "language": "English",
+            "filename": "Subnautica/setup_en.md",
+            "link": "Subnautica/setup/en",
+            "authors": [
+              "Berserker"
+            ]
+          }
+        ]
+      }
+    ]
+  },
   {
     "gameTitle": "Super Metroid",
     "tutorials": [