Merge pull request #14 from TKMM-Team/wiki-2.0.0

Merge Wiki 2.0.0 Updates

.gitignore

@@ -1 +1,3 @@
-**/_site
+**/_site
+*.idea/
+*.run/

Folder.DotSettings

@@ -0,0 +1,2 @@
+<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=tkmm/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>

publish.ps1

@@ -0,0 +1 @@
+docfx --serve .\wwwroot\docfx.json

wwwroot/docfx.json

@@ -18,6 +18,7 @@
     "resource": [
       {
         "files": [
+          "**/scripts/**",
           "**/images/**",
           "favicon.ico",
           "logo.png",

wwwroot/docs/index.md

@@ -11,59 +11,30 @@ To learn how to install and merge mods, check out the [Using Mods](./using-mods/
 
 ## Installation
 
-On the [downloads](../downloads) page, locate and download the <kbd><samp>TKMM Launcher</samp></kbd> and <kbd><samp>.NET Runtime</samp></kbd> for your operating system.
+Navigate to the [downloads](../downloads) page and download the version for your operating system.
 
-When the downloads have completed, open the **.NET Runtime** installer and follow the prompts to completion.
-
-<p>
-    <img width="450" src="./images/(1.0)-DotnetRuntimeComplete.png" alt="TKMM launcher window.">
-</p>
-
-Once the **.NET Runtime** has finished installing, extract the **TKMM Launcher** zip file and run the contained executable.
-
-The following window will open.
-
-<p>
-    <img width="650" src="./images/(1.1)-Launcher.png" alt="TKMM launcher window.">
-</p>
-
-Click <kbd><samp>Install</samp></kbd> to begin the installation process.
+After downloading the version for your operating system, extract the archive contents file and run the contained executable. The following window will open.
 
 > [!IMPORTANT]
-> The TKMM installer requires a stable internet connection.
-
-When the installation completes, click <kbd><samp>Launch</samp></kbd> to open TKMM.
-
-## Setup
-
-When TKMM first starts, you will most likely be asked to configure your game path.
+> TKMM user data (i.e. mods and profiles) is stored next to the executable.<br>
+> To avoid errors, avoid moving your TKMM installation, or move the entire installation folder.
 
 <p>
-    <img width="650" src="./images/(1.3)-EmptyGamePath.png" alt="Invalid empty game path.">
+    <img width="650" src="./images/Setup_First.png" alt="TKMM Setup Starting Screen.">
 </p>
 
-This field contains the path to your Tears of the Kingdom RomFS game dump.
-
-RomFS means `Read-Only Memory File System`, it is all of the files extracted from the game (not a NSP or XCI).
-
-If you do not already have a RomFS dump, please follow [this guide from zeldamods.org](https://zeldamods.org/wiki/Help:Dumping_games#Switch) to legally obtain one.
-
-> [!IMPORTANT]
-> When dumping your copy of the game, make sure you include the `1.1.0` update or later. `1.0.0` is [not supported by TKMM](/faq/#why-cant-i-use-version-100).
-
-<p>
-    <img width="650" src="./images/(1.4)-InvalidGameVersion.png" alt="Invalid empty game path">
-</p>
-
-Once you have dumped your copy of the game's romfs, use the <kbd><samp>...</samp></kbd> button to browse to its location.
-
-When the game path is set correctly the field will turn green.
-
-<p>
-    <img width="650" src="./images/(1.5)-GoodGamePath.png" alt="Good game path entered.">
-</p>
+Follow the setup wizard to configure the game dump and language for TKMM. 
 
 > [!NOTE]
 > TKMM will output mods for the same version as the provided game dump.
 >
 > For example, if you are playing on `v1.1.2`, make sure your game dump is for `v1.1.2` as well.
+> Multiple game dump versions can be provided, and you can choose which version to output mods for from the Settings tab.
+> 
+> If you were not prompted to directly input a game dump location, then the preferred version will be automatically set based on the update detected.
+
+Once finished, you will land on the mods tab as shown below.
+
+<p>
+    <img width="650" src="./images/TKMM_ModsEmpty.png" alt="The TKMM Mods tab with no mods currently installed.">
+</p>

wwwroot/docs/using-mods/index.md

@@ -14,6 +14,7 @@ To install a mod file, use <kbd><samp>Mod</samp></kbd> &gt; <kbd><samp>Install F
 The supported files formats are `.tkcl`, `.zip`, `.rar` and `.7z`.
 
 > [!TIP]
+> *(\*Desktop version only)*<br>
 > If you are installing `.7z` files, update your [Application Settings](../settings/#7z-path)' [7z Path](../settings/#application-settings) to make installation faster.
 
 <br>
@@ -126,46 +127,50 @@ Merging may take some time, so be patient. When merging has completed a green ba
     <img width="650" src="./images/MergeCompleted.png" alt="Merge Completed">
 </p>
 
-- If you are playing on a **Switch emulator**, refer to the <a href="#emulator-setup" rel="nofollow">emulator setup</a> section.
-- If you are playing on a **physical Switch**, refer to the <a href="#switch-setup" rel="nofollow">Switch setup</a> section.
+- If you are playing on a **physical Switch** but using TKMM on your PC, refer to the <a href="#switch-setup" rel="nofollow">Switch setup</a> section.
 
 <br>
 
-### Emulator Setup
+### Export Locations (Optional)
 
-To setup exporting for one or more Switch emulators, use <kbd><samp>Mod</samp></kbd> &gt; <kbd><samp>Edit Export Locations</samp></kbd> or <kbd>Ctrl</kbd> + <kbd>L</kbd> to edit the export locations.
+Export locations allow you to export your merged output to multiple locations without copying the contents.
 
-> [!NOTE]
-> On the currently available version (**1.0.0-beta11**), this option is only accessible from the Settings page, under <kbd><samp>Merging</kbd></samp> > <kbd><samp>Export Locations</kbd></samp>. 
+To setup export locations, navigate to <kbd><samp>Mod</samp></kbd> &gt; <kbd><samp>Edit Export Locations</samp></kbd>
+or <kbd>Ctrl</kbd> + <kbd>L</kbd> to open the export location editor.
 
-<br>
+Press the <kbd><samp>+</samp></kbd> <sup>[(3)](./images/ExportLocations.png)</sup> button to create a new entry, and then use the folder icon to browse to a folder
+or paste the folder path in the text box. 
+
+Repeat this step for any additional export locations you would like to have.
 
-- If you are using **yuzu**, enable the **first** entry listed <sup>[(1)](./images/ExportLocations.png)</sup>.
-- If you are using **Ryujinx**, enable the **second** entry listed <sup>[(2)](./images/ExportLocations.png)</sup>.
+> [!IMPORTANT]
+> An export location must refer to an empty folder, and cannot be the `Merge Output Folder`
+> specified in the `Merging` settings.
 
 <p>
     <img width="650" src="./images/ExportLocations.png" alt="Export Locations">
 </p>
 
-If you are using another emulator, click the <kbd><samp>+</samp></kbd> <sup>[(3)](./images/ExportLocations.png)</sup> button and paste the path to a <strong style="color:#c94646">TKMM subfolder</strong> in your emulator's mod folder.
-
 Click <kbd><samp>Close</samp></kbd> <sup>[(4)](./images/ExportLocations.png)</sup> to save and close.
 
 > [!TIP]
 > You do not need to merge again after editing your export locations.
 
 <br>
 
-### Switch Setup
+### PC to Switch Setup
+
+If you are playing on Switch, but using TKMM on desktop, follow these steps to use the merged mods
+from TKMM on your Switch.
 
 Before starting, insert your SD card into your computer or use the [Hekate USB Tools](https://switchway.net/transfer-files-via-usb/) (<kbd><samp>Tools</samp></kbd> &gt; <kbd><samp>USB Tools</samp></kbd> &gt; <kbd><samp>SD Card</samp></kbd> in Hekate) to transfer over USB.
 
 Navigate to <kbd><samp>Tools</samp></kbd> &gt; <kbd><samp>Export to SD Card</samp></kbd> or use <kbd>Ctrl</kbd> + <kbd>E</kbd> to open the export dialog.
 
-From there, select the SD card from the dropdown <sup>[(1)](./images/ExportForSwitch.png)</sup>.
+From there, select the SD card from the dropdown <sup>[(1)](#Image-ExportForSwitch)</sup>.
 
 <p>
-    <img width="650" src="./images/ExportForSwitch.png" alt="Export for Switch">
+    <img id="Image-ExportForSwitch" width="650" src="./images/ExportForSwitch.png" alt="Export for Switch">
 </p>
 
 Finally, press <kbd><samp>Export</samp></kbd> <sup>[(2)](./images/ExportForSwitch.png)</sup> and wait for the export to complete.

wwwroot/downloads/app-image/index.md

@@ -0,0 +1,11 @@
+---
+_layout: landing
+_appTitle: ~
+title: Thank You for Downloading TKMM
+---
+
+# Thank You for Downloading TKMM
+
+Open a terminal next to the `Tkmm.AppImage` and run `chmod +x ./Tkmm.AppImage` to ensure the file can be executed.
+
+Then, simply run the AppImage file from anywhere and enjoy!

wwwroot/downloads/index.md

@@ -3,77 +3,84 @@ title: Download TKMM
 description: Downloads page for TKMM.
 ---
 
+<script src="../scripts/helpers.js">
+</script>
+
 # Download TKMM
 
 # [Windows](#tab/windows)
 
-> Downloads for Windows
+> Download for Windows
 > 
 > <div id="download-btns">
->  <a class="download-btn" id="download-windows" href="https://github.com/TKMM-Team/Tkmm/releases/latest/download/TKMM-Launcher-win-x64.zip">TKMM Launcher (x64)</a>
->  <a class="download-btn" id="download-src" href="https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-8.0.11-windows-x64-installer">.NET Runtime (x64)</a>
+>  <a class="download-btn" id="download-windows" onclick="ReturnToPage('/downloads/zip')" href="https://github.com/TKMM-Team/Tkmm/releases/latest/download/Tkmm-win-x64.zip">TKMM (x64)</a>
 > </div>
 
-> Downloads for Windows Snapdragon
+> Download for Windows Snapdragon
 > 
 > <div id="download-btns">
->   <a class="download-btn" id="download-windows" href="https://github.com/TKMM-Team/Tkmm/releases/latest/download/TKMM-Launcher-win-arm64.zip">TKMM Launcher (arm64)</a>
->   <a class="download-btn" id="download-src" href="https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-8.0.11-windows-arm64-installer">.NET 8 Runtime (arm64)</a>
+>   <a class="download-btn" id="download-windows" onclick="ReturnToPage('/downloads/zip')" href="https://github.com/TKMM-Team/Tkmm/releases/latest/download/Tkmm-win-arm64.zip">TKMM (arm64)</a>
 > </div>
 
-# [Linux](#tab/linux)
+# [Switch](#tab/switch)
 
-> Downloads for Linux x64
+> Download for Switch
 > 
 > <div id="download-btns">
->  <a class="download-btn" id="download-linux" href="https://github.com/TKMM-Team/Tkmm/releases/latest/download/TKMM-Launcher-linux-x64.zip">TKMM Launcher (x64)</a>
->  <a class="download-btn" id="download-src" href="https://learn.microsoft.com/dotnet/core/install/linux-package-managers?WT.mc_id=dotnet-35129-website">.NET Runtime Install Guide</a>
+>  <a class="download-btn" id="download-switch" onclick="ReturnToPage('/downloads/switch')" href="https://github.com/TKMM-Team/TKMM-NX/releases/latest/download/tkmm-nx.zip">TKMM-NX</a>
 > </div>
 
-> Downloads for Linux Arm64
+# [Linux](#tab/linux)
+
+> Download portable for Linux x64
 > 
 > <div id="download-btns">
->   <a class="download-btn" id="download-linux" href="https://github.com/TKMM-Team/Tkmm/releases/latest/download/TKMM-Launcher-linux-arm64.zip">TKMM Launcher (arm64)</a>
->   <a class="download-btn" id="download-src" href="https://learn.microsoft.com/dotnet/core/install/linux-package-managers?WT.mc_id=dotnet-35129-website">.NET Runtime Install Guide</a>
+>  <a class="download-btn" id="download-linux" onclick="ReturnToPage('/downloads/zip')" href="https://github.com/TKMM-Team/Tkmm/releases/latest/download/Tkmm-linux-x64.zip">TKMM (x64)</a>
 > </div>
 
-> Flatpak for Linux x64
+> Download portable for Linux Arm64
 > 
-> ```cs
-> flatpak remote-add --user TkmmRepo "https://repo.tkmm.org/.flatpakrepo"
-> flatpak install -y TkmmRepo io.github.tkmm_team.tkmm
-> ```
+> <div id="download-btns">
+>   <a class="download-btn" id="download-linux" onclick="ReturnToPage('/downloads/zip')" href="https://github.com/TKMM-Team/Tkmm/releases/latest/download/Tkmm-linux-arm64.zip">TKMM (arm64)</a>
+> </div>
 
-> [!IMPORTANT]
-> The Flatpak version is required for the Steam Deck and other SteamOS installations.
+> Download AppImage for Linux x64
+>
+> <div id="download-btns">
+>   <a class="download-btn" id="download-linux" download="Tkmm.AppImage" onclick="ReturnToPage('/downloads/app-image')" href="https://github.com/TKMM-Team/Tkmm/releases/latest/download/Tkmm-linux-x64.AppImage">TKMM (x64)</a>
+> </div>
+
+> Download AppImage for Linux Arm64
+>
+> <div id="download-btns">
+>   <a class="download-btn" id="download-linux" download="Tkmm.AppImage" onclick="ReturnToPage('/downloads/app-image')" href="https://github.com/TKMM-Team/Tkmm/releases/latest/download/Tkmm-linux-arm64.AppImage">TKMM (arm64)</a>
+> </div>
 
 # [MacOS (Experimental)](#tab/macos)
 
 > [!WARNING]
-> MacOS builds are not tested by TKMM-Team. Expect bugs, crashes and limited usability.
+> macOS builds are not tested by TKMM Team. Expect bugs, crashes and limited usability.
 
-> Downloads for MacOS Silicon
+> Download for macOS Silicon
 > 
 > <div id="download-btns">
->   <a class="download-btn" id="download-macos" href="https://github.com/TKMM-Team/Tkmm/releases/latest/download/TKMM-Launcher-osx-arm64.zip">TKMM Launcher (arm64)</a>
->   <a class="download-btn" id="download-src" href="https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-8.0.11-macos-arm64-installer">.NET 8 Runtime</a>
+>   <a class="download-btn" id="download-macos" onclick="ReturnToPage('/downloads/zip')" href="https://github.com/TKMM-Team/Tkmm/releases/latest/download/Tkmm-osx-arm64.zip">TKMM (arm64)</a>
 > </div>
 
-> Downloads for MacOS x64
+> Download for macOS x64
 > 
 > <div id="download-btns">
->  <a class="download-btn" id="download-macos" href="https://github.com/TKMM-Team/Tkmm/releases/latest/download/TKMM-Launcher-osx-x64.zip">TKMM Launcher (x64)</a>
->  <a class="download-btn" id="download-src" href="https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-8.0.11-macos-x64-installer">.NET 8 Runtime</a>
+>  <a class="download-btn" id="download-macos" onclick="ReturnToPage('/downloads/zip')" href="https://github.com/TKMM-Team/Tkmm/releases/latest/download/Tkmm-osx-x64.zip">TKMM (x64)</a>
 > </div>
 
 ---
 
 ## Supported Platforms
 
 - **[Windows 8.1+](https://docs.avaloniaui.net/docs/faq#what-versions-of-windows-are-supported)** | Fully supported
-- **Linux** | Partially supported
+- **Switch** | Mostly supported
+- **Linux** | Mostly supported
   - **SteamOS** | Experimental
-  - **Switch (Lakka)** | Work in Progress
 - **MacOS** | Experimental
 
 ## Source Code

wwwroot/downloads/switch/index.md

@@ -0,0 +1,27 @@
+---
+_layout: landing
+_appTitle: ~
+title: Thank You for Downloading TKMM
+---
+
+# Thank You for Downloading TKMM
+
+If you are new to Switch modding, refer to the [Switch hacks](https://switch.hacks.guide/) guide to get started.
+
+---
+
+To install TKMM on your Nintendo Switch, simply extract the contents of the downloaded zip file at the root of your SD card.
+
+Once that is done, you will find a new boot entry for TKMM under `Other Configs` in Hekate.
+
+<p>
+    <img width="650" src="./images/HekateLauncher.png" alt="Hekate Launcher">
+</p>
+
+Please make sure that your keys are dumped with `Lockpick_RCM` and that both the base game and update are installed on your micro SD card (as shown on the capture below).
+
+Otherwise, if it is installed on the internal storage, or your base game is a cartridge, you will need to dump it with nxdumptool (split files also work).
+
+<p>
+    <img width="650" src="./images/TotkInstalled.png" alt="TotK Installed">
+</p>

wwwroot/downloads/zip/index.md

@@ -0,0 +1,14 @@
+---
+_layout: landing
+_appTitle: ~
+title: Thank You for Downloading TKMM
+---
+
+# Thank You for Downloading TKMM
+
+To install, simply create a folder anywhere on your computer, and extract the contents of the downloaded zip into it.
+
+Once installed run the file named `Tkmm`.
+
+> [!NOTE]
+> Linux users may need to run `chmod +x ./Tkmm` before the file is executable.

wwwroot/index.md

@@ -38,17 +38,24 @@ description: "TKMM (TotK Mod Manager) is a tool for managing and merging mods fo
 
 ---
 
+<div id="download-btns">
+  <a class="download-btn" id="download-main" href="./downloads">Download TKMM</a>
+</div>
+<br>
+
 TKMM, or Tears of the Kingdom Mod Manager, is a mod merger and manager for TotK (yes, we have a very creative name).
 
-Unlike other mod managers for TotK, TKMM merges the individual mod files to ensure the best possible compatibility with every mod available.
+Unlike other mod managers for TotK, TKMM merges the individual mod files to ensure the best possible compatibility with
+every mod available.
 
-TKMM is currently only available on desktop platforms, however, support for running on Switch hardware is being worked on (until this is available, mods can be merged on PC then transferred to a Switch).
+TKMM is currently available on desktop (Windows, Linux and macOS) and Switch.
 
-Check out the [getting started](/docs/) page to download and use TKMM!
+Check out the [downloads](./downloads) page to start using TKMM!
 
 ---
 
-If you wish to show your support for the project, please leave a star on the [GitHub repository](https://github.com/TKMM-Team/Tkmm).
+If you wish to show your support for the project, please leave a star on
+the [GitHub repository](https://github.com/TKMM-Team/Tkmm).
 
 <p>
   <a href="https://github.com/TKMM-Team/Tkmm/blob/master/License.md" class="plain">

wwwroot/scripts/helpers.js

@@ -0,0 +1,5 @@
+function ReturnToPage(url) {
+    setTimeout(function () {
+        document.location.pathname = url;
+    }, 10);
+}