From 619706ba352c6f3562fad729354fddf1d2adb135 Mon Sep 17 00:00:00 2001 From: ArchLeaders Date: Wed, 12 Jun 2024 01:10:35 -0700 Subject: [PATCH] Move setup to getting started --- wwwroot/docs/getting-started/index.md | 49 ++++++++++++++++++++++++++- wwwroot/downloads/setup/index.md | 41 ---------------------- wwwroot/downloads/toc.yml | 6 ++-- 3 files changed, 51 insertions(+), 45 deletions(-) delete mode 100644 wwwroot/downloads/setup/index.md diff --git a/wwwroot/docs/getting-started/index.md b/wwwroot/docs/getting-started/index.md index 8b3a794..9faa315 100644 --- a/wwwroot/docs/getting-started/index.md +++ b/wwwroot/docs/getting-started/index.md @@ -1 +1,48 @@ -# Getting Started \ No newline at end of file +--- +title: Getting Started +--- + +# TKMM Installation & Setup + +> [!NOTE] +> Before starting, make sure you have downloaded [TKMM Launcher](../../downloads) from the [downloads](../../downloads) page. + +--- + +Once you download the launcher, open it, and click on Install. + +![Image of the TKMM Launcher before TKMM is installed](../../images/Setup_01_Launcher.png) + + +Once installation is complete, the Install button should change to say Launch. Click Launch to open TKMM. Once TKMM loads, you should land on the home screen. + +![Image of TKMM's Home page](../../images/Setup_02_Homepage.png) + + + If you click on the three lines near the top left of the window, the navigation sidebar will expand to show the names of each tab. Click on the **Settings** tab, which is represented by the cogwheel icon. + +![Image of TKMM's Common Settings page](../../images/Setup_03_CommonSettings.png) + + +For all users, whether you plan to use TKMM to package mods or to merge mods to play with them, you will need to specify your game dump location. In the **Common** settings category, shown in the above image, choose the folder that contains a full romfs dump of Tears of the Kingdom. This is the folder that contains many other directories, such as a `Model` folder, a `Pack` folder, a `TexToGo` folder, and many others. Note that the version of your game dump is the version that TKMM will export mods for. For example, if your game dump is from v1.1.2 of TOTK, then TKMM's merged mod folder will be compatible with v1.1.2. TKMM's merging system is version agnostic, meaning that regardless of the game version a mod was made for, TKMM can export it to the version of your game dump. + +Next, select the **Merging** tab. Here is an image of this tab, followed by a description of each of the options: + +![Image of TKMM's Merging Settings page](../../images/Setup_04_MergingSettings.png) + + +1. Merged Mod Output Folder + +This is where you can choose the output path for your mods when you merge them. When you merge mods, the contents of this folder will be deleted, so it's recommended to create a new folder for this. + +2. Target Language + +If you are using a mod that edits the localization files found in the **Mals** folder in the romfs, there is a chance that it doesn't support all languages. If the language entry for a given string does not exist for a given language, it will appear in game as *MsgNotFound*. If you choose your target language, TKMM is able to automatically move a mod's localization edits to the file for your language, removing the *MsgNotFound* issues. + +3. Use Ryujinx + +By enabling this option, merging your mods will automatically export a copy of your Merged Mod Output Folder to the default mods path for Ryujinx. This is a quality of life option that mitigates the need for you to move your merged export to the emulator's mods folder yourself. + +4. Use Japanese Citrus Fruit + +By enabling this option, merging your mods will automatically export a copy of your Merged Mod Output Folder to the default mods path for Japanese Citrus Fruit. This is a quality of life option that mitigates the need for you to move your merged export to the emulator's mods folder yourself. \ No newline at end of file diff --git a/wwwroot/downloads/setup/index.md b/wwwroot/downloads/setup/index.md deleted file mode 100644 index 385676d..0000000 --- a/wwwroot/downloads/setup/index.md +++ /dev/null @@ -1,41 +0,0 @@ -# Setup - -Once you download the launcher, open it, and click on Install. - -![Image of the TKMM Launcher before TKMM is installed](../../images/Setup_01_Launcher.png) - - -Once installation is complete, the Install button should change to say Launch. Click Launch to open TKMM. Once TKMM loads, you should land on the home screen. - -![Image of TKMM's Home page](../../images/Setup_02_Homepage.png) - - - If you click on the three lines near the top left of the window, the navigation sidebar will expand to show the names of each tab. Click on the **Settings** tab, which is represented by the cogwheel icon. - -![Image of TKMM's Common Settings page](../../images/Setup_03_CommonSettings.png) - - -For all users, whether you plan to use TKMM to package mods or to merge mods to play with them, you will need to specify your game dump location. In the **Common** settings category, shown in the above image, choose the folder that contains a full romfs dump of Tears of the Kingdom. This is the folder that contains many other directories, such as a `Model` folder, a `Pack` folder, a `TexToGo` folder, and many others. Note that the version of your game dump is the version that TKMM will export mods for. For example, if your game dump is from v1.1.2 of TOTK, then TKMM's merged mod folder will be compatible with v1.1.2. TKMM's merging system is version agnostic, meaning that regardless of the game version a mod was made for, TKMM can export it to the version of your game dump. - -Next, select the **Merging** tab. Here is an image of this tab, followed by a description of each of the options: - -![Image of TKMM's Merging Settings page](../../images/Setup_04_MergingSettings.png) - - -1. Merged Mod Output Folder - -This is where you can choose the output path for your mods when you merge them. When you merge mods, the contents of this folder will be deleted, so it's recommended to create a new folder for this. - -2. Target Language - -If you are using a mod that edits the localization files found in the **Mals** folder in the romfs, there is a chance that it doesn't support all languages. If the language entry for a given string does not exist for a given language, it will appear in game as *MsgNotFound*. If you choose your target language, TKMM is able to automatically move a mod's localization edits to the file for your language, removing the *MsgNotFound* issues. - -3. Use Ryujinx - -By enabling this option, merging your mods will automatically export a copy of your Merged Mod Output Folder to the default mods path for Ryujinx. This is a quality of life option that mitigates the need for you to move your merged export to the emulator's mods folder yourself. - -4. Use Japanese Citrus Fruit - -By enabling this option, merging your mods will automatically export a copy of your Merged Mod Output Folder to the default mods path for Japanese Citrus Fruit. This is a quality of life option that mitigates the need for you to move your merged export to the emulator's mods folder yourself. - -This sentence uses `$` delimiters to show math inline: $\sqrt{3x-1}+(1+x)^2$ \ No newline at end of file diff --git a/wwwroot/downloads/toc.yml b/wwwroot/downloads/toc.yml index 409aaec..348bbff 100644 --- a/wwwroot/downloads/toc.yml +++ b/wwwroot/downloads/toc.yml @@ -1,4 +1,4 @@ -- name: Download +- name: Downloads href: index.md -- name: Setup - href: setup/ +- name: Getting Started + href: ../docs/getting-started