diff --git a/wwwroot/docs/faq/index.md b/wwwroot/docs/faq/index.md deleted file mode 100644 index 87b9930..0000000 --- a/wwwroot/docs/faq/index.md +++ /dev/null @@ -1 +0,0 @@ -# Frequently Asked Questions \ No newline at end of file diff --git a/wwwroot/docs/getting-started/index.md b/wwwroot/docs/getting-started/index.md deleted file mode 100644 index dcf67c0..0000000 --- a/wwwroot/docs/getting-started/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: Getting Started ---- - -# TKMM Installation & Setup - -> [!IMPORTANT] -> Before starting, make sure you have downloaded and installed the [.NET 8 runtime](../../downloads) from the [downloads](../../downloads) page. -> -> If this step is not completed, the application will instantly crash. - ---- - -## Installation - -From the [downloads](../../downloads) page, locate the correct version for your operating system. - -Click one of the options for `TKMM Launcher` to download a `zip` file containing the `tkmm-launcher` executable. When the download has completed, extract and run this executable. - -If the correct [.NET runtime](../../downloads) is installed, the following window will open. - -

- tkmm launcher window -

- -> [!WARNING] -> If you are installing on the Steam Deck and/or cannot run as the super-user, uncheck `Create Shortcuts` to avoid needing elevated permissions. - -Click `Install` to begin the installation process. - -When the installation completes, click `Launch` to open TKMM. - -## Setup - -When TKMM first starts, you will likely be asked to configure your game path. - -

- invalid settings page -

- -The accent color used in TKMM will vary based on your system's accent color. - -> [!NOTE] -> If you do not already have the game dump on your computer, please google how to do it, as we cannot directly provide the resources needed to do so. - -Once you have the game dump, use the `...` button to browse to that location. - -> If the setting did not turn green, make sure you have a complete game dump and you selected the right folder (it will be the folder containing `ActorSystem`, `AI`, `AISchedule`, etc.). - -When everything is done correctly, you should have something similar to this. - -> [!IMPORTANT] -> The game dump provided must be the same version you are using on your Switch or emulator. -> -> For example, if you are playing `v1.1.2`, make sure your game dump is `v1.1.2` as well. - -

- -

- -> [!NOTE] -> Even when the game path is correct, the status bar will still show an `Invalid setting, GamePath is invalid.` error. Click the `Save` button in the bottom left to resolve this and save the settings. - -To learn more about configuring the TKMM settings, read through the [Settings](./settings) page. - -To get started using mods, check out the [Using Mods](./using-mods) page. \ No newline at end of file diff --git a/wwwroot/docs/getting-started/toc.yml b/wwwroot/docs/getting-started/toc.yml deleted file mode 100644 index 611292e..0000000 --- a/wwwroot/docs/getting-started/toc.yml +++ /dev/null @@ -1,6 +0,0 @@ -- name: Getting Started - href: index.md -- name: Settings - href: settings/ -- name: Using Mods - href: using-mods/ diff --git a/wwwroot/docs/getting-started/using-mods/images/UseMods_01_01.png b/wwwroot/docs/getting-started/using-mods/images/UseMods_01_01.png deleted file mode 100644 index 26750a3..0000000 Binary files a/wwwroot/docs/getting-started/using-mods/images/UseMods_01_01.png and /dev/null differ diff --git a/wwwroot/docs/getting-started/using-mods/images/UseMods_03_01.png b/wwwroot/docs/getting-started/using-mods/images/UseMods_03_01.png deleted file mode 100644 index 32f2cef..0000000 Binary files a/wwwroot/docs/getting-started/using-mods/images/UseMods_03_01.png and /dev/null differ diff --git a/wwwroot/docs/getting-started/using-mods/images/UseMods_03_02.png b/wwwroot/docs/getting-started/using-mods/images/UseMods_03_02.png deleted file mode 100644 index 53dd42f..0000000 Binary files a/wwwroot/docs/getting-started/using-mods/images/UseMods_03_02.png and /dev/null differ diff --git a/wwwroot/docs/getting-started/images/Launcher.png b/wwwroot/docs/images/Launcher.png similarity index 100% rename from wwwroot/docs/getting-started/images/Launcher.png rename to wwwroot/docs/images/Launcher.png diff --git a/wwwroot/docs/getting-started/images/Settings_NoGamePath.png b/wwwroot/docs/images/Settings_NoGamePath.png similarity index 100% rename from wwwroot/docs/getting-started/images/Settings_NoGamePath.png rename to wwwroot/docs/images/Settings_NoGamePath.png diff --git a/wwwroot/docs/getting-started/images/Settings_WithGamePath.png b/wwwroot/docs/images/Settings_WithGamePath.png similarity index 100% rename from wwwroot/docs/getting-started/images/Settings_WithGamePath.png rename to wwwroot/docs/images/Settings_WithGamePath.png diff --git a/wwwroot/docs/index.md b/wwwroot/docs/index.md index 7d8b3af..6cf3446 100644 --- a/wwwroot/docs/index.md +++ b/wwwroot/docs/index.md @@ -1 +1,66 @@ -# Documentation \ No newline at end of file +--- +title: Getting Started +--- + +# TKMM Installation & Setup + +> [!IMPORTANT] +> Before starting, make sure you have downloaded and installed the [.NET 8 runtime](../downloads) from the [downloads](../downloads) page. +> +> If this step is not completed, the application will instantly crash. + +--- + +## Installation + +From the [downloads](../downloads) page, locate the correct version for your operating system. + +Click one of the options for `TKMM Launcher` to download a `zip` file containing the `tkmm-launcher` executable. When the download has completed, extract and run this executable. + +If the correct [.NET runtime](../downloads) is installed, the following window will open. + +

+ tkmm launcher window +

+ +> [!WARNING] +> If you are installing on the Steam Deck and/or cannot run as the super-user, uncheck `Create Shortcuts` to avoid needing elevated permissions. + +Click `Install` to begin the installation process. + +When the installation completes, click `Launch` to open TKMM. + +## Setup + +When TKMM first starts, you will likely be asked to configure your game path. + +

+ invalid settings page +

+ +The accent color used in TKMM will vary based on your system's accent color. + +> [!NOTE] +> If you do not already have the game dump on your computer, please google how to do it, as we cannot directly provide the resources needed to do so. + +Once you have the game dump, use the `...` button to browse to that location. + +> If the setting did not turn green, make sure you have a complete game dump and you selected the right folder (it will be the folder containing `ActorSystem`, `AI`, `AISchedule`, etc.). + +When everything is done correctly, you should have something similar to this. + +> [!IMPORTANT] +> The game dump provided must be the same version you are using on your Switch or emulator. +> +> For example, if you are playing `v1.1.2`, make sure your game dump is `v1.1.2` as well. + +

+ +

+ +> [!NOTE] +> Even when the game path is correct, the status bar will still show an `Invalid setting, GamePath is invalid.` error. Click the `Save` button in the bottom left to resolve this and save the settings. + +To learn more about configuring the TKMM settings, read through the [Settings](./settings) page. + +To get started using mods, check out the [Using Mods](./using-mods) page. \ No newline at end of file diff --git a/wwwroot/docs/getting-started/settings/images/Settings_General_Application.png b/wwwroot/docs/settings/images/Settings_General_Application.png similarity index 100% rename from wwwroot/docs/getting-started/settings/images/Settings_General_Application.png rename to wwwroot/docs/settings/images/Settings_General_Application.png diff --git a/wwwroot/docs/getting-started/settings/images/Settings_General_Merging.png b/wwwroot/docs/settings/images/Settings_General_Merging.png similarity index 100% rename from wwwroot/docs/getting-started/settings/images/Settings_General_Merging.png rename to wwwroot/docs/settings/images/Settings_General_Merging.png diff --git a/wwwroot/docs/getting-started/settings/images/Settings_General_Packaging.png b/wwwroot/docs/settings/images/Settings_General_Packaging.png similarity index 100% rename from wwwroot/docs/getting-started/settings/images/Settings_General_Packaging.png rename to wwwroot/docs/settings/images/Settings_General_Packaging.png diff --git a/wwwroot/docs/getting-started/settings/index.md b/wwwroot/docs/settings/index.md similarity index 100% rename from wwwroot/docs/getting-started/settings/index.md rename to wwwroot/docs/settings/index.md diff --git a/wwwroot/docs/toc.yml b/wwwroot/docs/toc.yml index 896a60a..611292e 100644 --- a/wwwroot/docs/toc.yml +++ b/wwwroot/docs/toc.yml @@ -1,6 +1,6 @@ -- name: Documentation - href: index.md -- name: FAQ - href: faq/ - name: Getting Started - href: getting-started/ + href: index.md +- name: Settings + href: settings/ +- name: Using Mods + href: using-mods/ diff --git a/wwwroot/docs/getting-started/using-mods/Images/UseMods_01_01.png b/wwwroot/docs/using-mods/images/UseMods_01_01.png similarity index 100% rename from wwwroot/docs/getting-started/using-mods/Images/UseMods_01_01.png rename to wwwroot/docs/using-mods/images/UseMods_01_01.png diff --git a/wwwroot/docs/getting-started/using-mods/Images/UseMods_03_01.png b/wwwroot/docs/using-mods/images/UseMods_03_01.png similarity index 100% rename from wwwroot/docs/getting-started/using-mods/Images/UseMods_03_01.png rename to wwwroot/docs/using-mods/images/UseMods_03_01.png diff --git a/wwwroot/docs/getting-started/using-mods/Images/UseMods_03_02.png b/wwwroot/docs/using-mods/images/UseMods_03_02.png similarity index 100% rename from wwwroot/docs/getting-started/using-mods/Images/UseMods_03_02.png rename to wwwroot/docs/using-mods/images/UseMods_03_02.png diff --git a/wwwroot/docs/getting-started/using-mods/images/UseMods_04_01.png b/wwwroot/docs/using-mods/images/UseMods_04_01.png similarity index 100% rename from wwwroot/docs/getting-started/using-mods/images/UseMods_04_01.png rename to wwwroot/docs/using-mods/images/UseMods_04_01.png diff --git a/wwwroot/docs/getting-started/using-mods/images/UseMods_04_02.png b/wwwroot/docs/using-mods/images/UseMods_04_02.png similarity index 100% rename from wwwroot/docs/getting-started/using-mods/images/UseMods_04_02.png rename to wwwroot/docs/using-mods/images/UseMods_04_02.png diff --git a/wwwroot/docs/getting-started/using-mods/images/UseMods_05_01.png b/wwwroot/docs/using-mods/images/UseMods_05_01.png similarity index 100% rename from wwwroot/docs/getting-started/using-mods/images/UseMods_05_01.png rename to wwwroot/docs/using-mods/images/UseMods_05_01.png diff --git a/wwwroot/docs/getting-started/using-mods/images/UseMods_05_02.png b/wwwroot/docs/using-mods/images/UseMods_05_02.png similarity index 100% rename from wwwroot/docs/getting-started/using-mods/images/UseMods_05_02.png rename to wwwroot/docs/using-mods/images/UseMods_05_02.png diff --git a/wwwroot/docs/getting-started/using-mods/images/UseMods_06_01.png b/wwwroot/docs/using-mods/images/UseMods_06_01.png similarity index 100% rename from wwwroot/docs/getting-started/using-mods/images/UseMods_06_01.png rename to wwwroot/docs/using-mods/images/UseMods_06_01.png diff --git a/wwwroot/docs/getting-started/using-mods/images/UseMods_06_02.png b/wwwroot/docs/using-mods/images/UseMods_06_02.png similarity index 100% rename from wwwroot/docs/getting-started/using-mods/images/UseMods_06_02.png rename to wwwroot/docs/using-mods/images/UseMods_06_02.png diff --git a/wwwroot/docs/getting-started/using-mods/index.md b/wwwroot/docs/using-mods/index.md similarity index 100% rename from wwwroot/docs/getting-started/using-mods/index.md rename to wwwroot/docs/using-mods/index.md diff --git a/wwwroot/downloads/toc.yml b/wwwroot/downloads/toc.yml index 348bbff..f5cdb2b 100644 --- a/wwwroot/downloads/toc.yml +++ b/wwwroot/downloads/toc.yml @@ -1,4 +1,4 @@ - name: Downloads href: index.md - name: Getting Started - href: ../docs/getting-started + href: ../docs diff --git a/wwwroot/faq/index.md b/wwwroot/faq/index.md new file mode 100644 index 0000000..242e388 --- /dev/null +++ b/wwwroot/faq/index.md @@ -0,0 +1,6 @@ +--- +_layout: landing +title: FAQ +--- + +# Frequently Asked Questions \ No newline at end of file diff --git a/wwwroot/toc.yml b/wwwroot/toc.yml index 7132557..331eca3 100644 --- a/wwwroot/toc.yml +++ b/wwwroot/toc.yml @@ -2,5 +2,7 @@ href: downloads/ - name: Documentation href: docs/ +- name: FAQ + href: faq/ - name: About href: about/