From 3cadd1287cc4f925b75b75bc487e9dcd4ea8c471 Mon Sep 17 00:00:00 2001 From: ArchLeaders Date: Sat, 12 Oct 2024 10:40:27 -0700 Subject: [PATCH 01/10] Generate sitemap --- wwwroot/docfx.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/wwwroot/docfx.json b/wwwroot/docfx.json index 39097f9..67d6cb9 100644 --- a/wwwroot/docfx.json +++ b/wwwroot/docfx.json @@ -1,5 +1,10 @@ { "build": { + "sitemap": { + "baseUrl": "https://tkmm.org", + "priority": 1.0, + "changefreq": "weekly" + }, "content": [ { "files": [ From c8e649d710b28e70bb6585fe7007b3810a35af9b Mon Sep 17 00:00:00 2001 From: ArchLeaders Date: Sat, 12 Oct 2024 10:48:35 -0700 Subject: [PATCH 02/10] Update landing page description --- wwwroot/index.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/wwwroot/index.md b/wwwroot/index.md index 962b13b..682aebf 100644 --- a/wwwroot/index.md +++ b/wwwroot/index.md @@ -1,6 +1,6 @@ --- _layout: landing -title: Home +title: TotK Mod Manager | Home ---
@@ -20,15 +20,15 @@ title: Home

-
-

Merge mods like never before!

-
- --- -TKMM is a mod manager and merger for Tears of the Kingdom developed by [TKMM-Team](./about#the-team). +TKMM, or Tears of the Kingdom Mod Manager, is a mod merger and manager for TotK (yes, we have a very creative name). -If you wish to show your support for the project, please leave a star on the [GitHub repository](https://github.com/TKMM-Team/Tkmm). +Unlike other mod managers for TotK, TKMM merges the individual mod files to ensure the best possible compatibility with every mod available. + +This is currently only supported on desktop platforms, however, support for running on Switch hardware, mobile devices and the web is being worked on. + +Check out the [getting started](/docs/) page to use TKMM! ## Download TKMM @@ -38,6 +38,8 @@ If you wish to show your support for the project, please leave a star on the [Gi --- +If you wish to show your support for the project, please leave a star on the [GitHub repository](https://github.com/TKMM-Team/Tkmm). +

Issues From 7928893edccbe48fc9554bf5f2388dbdf468a536 Mon Sep 17 00:00:00 2001 From: ArchLeaders Date: Sat, 12 Oct 2024 10:51:32 -0700 Subject: [PATCH 03/10] Remove downloads from landing page --- wwwroot/index.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/wwwroot/index.md b/wwwroot/index.md index 682aebf..b1fd893 100644 --- a/wwwroot/index.md +++ b/wwwroot/index.md @@ -28,13 +28,7 @@ Unlike other mod managers for TotK, TKMM merges the individual mod files to ensu This is currently only supported on desktop platforms, however, support for running on Switch hardware, mobile devices and the web is being worked on. -Check out the [getting started](/docs/) page to use TKMM! - -## Download TKMM - -

+Check out the [getting started](/docs/) page to download and use TKMM! --- From 07a902a522e76ba1e817f51ada47e03790c05472 Mon Sep 17 00:00:00 2001 From: ArchLeaders Date: Sat, 12 Oct 2024 11:17:48 -0700 Subject: [PATCH 04/10] Update landing page for seo --- wwwroot/index.md | 33 ++++++++++++++++++++++++--------- 1 file changed, 24 insertions(+), 9 deletions(-) diff --git a/wwwroot/index.md b/wwwroot/index.md index b1fd893..ab14572 100644 --- a/wwwroot/index.md +++ b/wwwroot/index.md @@ -1,22 +1,37 @@ --- _layout: landing title: TotK Mod Manager | Home +description: The home page for TKMM, a tool for managing and merging Tears of the Kingdom mods. --- + +
- + TKMM Logo

Tears of the Kingdom Mod Manager

- Releases' + GitHub releases page   - Discord + Discord server invite link   - Stars + GitHub repository

@@ -36,17 +51,17 @@ If you wish to show your support for the project, please leave a star on the [Gi

- Issues + TKMM license   - Issues + GitHub repository issue tracker   - Open Pull Requests + Open pull-requests   - Closed Pull Requests + Closed pull-requests

-*Join our Discord community [here](https://discord.com/invite/3tNUBWQRXv) for news and updates!* +*Join our [Discord community](https://discord.com/invite/3tNUBWQRXv) for news and updates!* From d571f42a1d7289a45cb295ed7b9317635a66623c Mon Sep 17 00:00:00 2001 From: ArchLeaders Date: Sat, 12 Oct 2024 11:49:03 -0700 Subject: [PATCH 05/10] Add page descriptions --- wwwroot/about/index.md | 1 + wwwroot/docs/creating-mods/index.md | 1 + wwwroot/docs/index.md | 1 + wwwroot/docs/settings/index.md | 1 + wwwroot/docs/using-mods/index.md | 1 + 5 files changed, 5 insertions(+) diff --git a/wwwroot/about/index.md b/wwwroot/about/index.md index 78f27ce..caa249d 100644 --- a/wwwroot/about/index.md +++ b/wwwroot/about/index.md @@ -1,6 +1,7 @@ --- _layout: landing title: About +description: Basic information about TKMM and the development team. --- # About diff --git a/wwwroot/docs/creating-mods/index.md b/wwwroot/docs/creating-mods/index.md index 8a56f85..7d59b3c 100644 --- a/wwwroot/docs/creating-mods/index.md +++ b/wwwroot/docs/creating-mods/index.md @@ -1,5 +1,6 @@ --- title: Packaging Mods +description: Documentaion for creating mods with TKMM for desktop. --- # Packaging diff --git a/wwwroot/docs/index.md b/wwwroot/docs/index.md index 561cdcd..4756cd6 100644 --- a/wwwroot/docs/index.md +++ b/wwwroot/docs/index.md @@ -1,5 +1,6 @@ --- title: Getting Started +description: Documentation on how to get stated using TKMM on desktop. --- # Getting Started diff --git a/wwwroot/docs/settings/index.md b/wwwroot/docs/settings/index.md index 2af6321..fd50b30 100644 --- a/wwwroot/docs/settings/index.md +++ b/wwwroot/docs/settings/index.md @@ -1,5 +1,6 @@ --- title: Settings +description: Settings documentation for the TKMM desktop application. --- # Settings diff --git a/wwwroot/docs/using-mods/index.md b/wwwroot/docs/using-mods/index.md index 2b62851..cee017a 100644 --- a/wwwroot/docs/using-mods/index.md +++ b/wwwroot/docs/using-mods/index.md @@ -1,5 +1,6 @@ --- title: Using Mods +description: Documentation on how to install, manage and merge mods in TKMM. --- # Using Mods From 5d1cf0bf0ca808e29dfce410fc7cdf23729ba041 Mon Sep 17 00:00:00 2001 From: ArchLeaders Date: Sat, 12 Oct 2024 11:49:26 -0700 Subject: [PATCH 06/10] Create faq structured data --- wwwroot/faq/index.md | 106 ++++++++++++++++++++++++++++++++++++------- 1 file changed, 90 insertions(+), 16 deletions(-) diff --git a/wwwroot/faq/index.md b/wwwroot/faq/index.md index 68062f8..a518f5f 100644 --- a/wwwroot/faq/index.md +++ b/wwwroot/faq/index.md @@ -1,8 +1,82 @@ --- _layout: landing -title: FAQ +title: TKMM - Frequently Asked Questions (FAQ) +description: Frequently asked questions for TKMM troubleshooting. --- + + # Frequently Asked Questions This page contains answers to frequently asked questions. @@ -23,9 +97,9 @@ Distributing any part of the game files is illegal, thus, TKMM requires you to p ## Why can't I use version 1.0.0? -The first version of Tears of the Kingdom is largely different from every version. +The first version of Tears of the Kingdom is very different from every other version. -With the large number of changes, it becomes difficult to distinguish changes made by modders and changes from the update. +With the large number of changes, it becomes challenging to distinguish changes made by modders and changes from the update. This is why version 1.0.0 of Tears of the Kingdom is not supported by TKMM. @@ -33,7 +107,7 @@ This is why version 1.0.0 of Tears of the Kingdom is not supported by TKMM. ## Can mods be made compatible for any version? -TKMM will apply the edits from each RomFS mod to the exact version of your game dump, which needs to be at least version [1.1.0 or later](#why-cant-i-use-version-100). +TKMM will apply the edits from each RomFS mod to the exact version of your game dump, which needs to be at least version 1.1.0 or later. This however will not be the case for ExeFS mods and cheats, those need to be directly compatible with your target version. @@ -43,43 +117,43 @@ This however will not be the case for ExeFS mods and cheats, those need to be di When mods edit or add more text, every language will not always be included. TKMM can handle this by applying text edits to the language you use in the game. -In order to fix this problem, navigate to `Settings` > `Merging` > `Target Language` > then ensure your region and language are properly selected. +In order to fix this problem, go to the settings page and navigate to Merging / Target Language then ensure your region and language are properly selected. -For example, if you play in English and your region is set to America, you should select `USen`. +For example, if you play in English and your region is set to America, you should select USen. --- ## What files can TKMM merge? -TKMM can merge archive files (`.sarc`, `.pack`), parameter files (`.bgyml`), the resource database (RSDB), the Mals system (Mals) and the resource size table (RESTBL). +TKMM can merge archive files (.sarc, .pack), parameter files (.bgyml), the resource database (RSDB), the Mals system (Mals) and the resource size table (RESTBL). -Support for texture archives (`.bntx`) and audio archives (`.bars`) is planned for future releases. +Support for texture archives (.bntx) and audio archives (.bars) is planned for future releases. -TKMM will never support AI files (`.ainb`), animation sequence files (`.asb`), timeline files (`.bfevtm`) or event flow files (`.bfevfl`). +TKMM will never support AI files (.ainb), animation sequence files (.asb), timeline files (.bfevtm) or event flow files (.bfevfl). --- ## Why aren't my mods showing up in-game? -If you play on emulator, please ensure you configured the proper [Export Location](https://tkmm.org/docs/using-mods/#emulator-setup). Otherwise, please refer to the [Switch Setup](https://tkmm.org/docs/using-mods/#switch-setup) section of the documentation. +If you play on emulator, please ensure you configured the proper Export Location. Otherwise, please refer to the Switch Setup section of the documentation. --- ## Why am I getting errors / crashes in-game? -The most common problems are either caused by a corrupted game dump, broken / incompatible mods, or because your RomFS dump isn't the same version as the update you're playing on. +The most common problems are either caused by a corrupted game dump, broken / incompatible mods, or because your RomFS dump isn't the same version as the update you're playing on. -You can check for corrupted or missing data with Tools > Check Dump Integrity. If it detects any issues, refer to the [RomFS dumping](https://zeldamods.org/wiki/Help:Dumping_games#Switch) guide to get a clean game dump. It is recommended to reinstall each mod after redumping (*not needed for mods in the form of TKCL files*). +You can check for corrupted or missing data with Tools > Check Dump Integrity. If it detects any issues, refer to the RomFS dumping guide to get a clean game dump. It is recommended to reinstall each mod after redumping (*not needed for mods in the form of TKCL files*). -In the case of broken or incompatible mods, the best you can do is disable mods one by one and test again until you find which ones are causing problems. Sometimes, this can also be fixed by changing the [priority order](https://tkmm.org/docs/using-mods/#ordering-mods) of the mods in question. +In the case of broken or incompatible mods, the best you can do is disable mods one by one and test again until you find which ones are causing problems. Sometimes, this can also be fixed by changing the priority order of the mods in question. -For mods with [configurable options](https://tkmm.org/docs/using-mods/#configuring-mod-options), please ensure you selected those according to your preferences. +For mods with configurable options, please ensure you selected those according to your preferences. -If all else fails and your issue is persistent, please open an issue on the [GitHub repository](https://github.com/TKMM-Team/Tkmm/issues/new), or report the issue on our [Discord server](https://discord.gg/BbVXenRFVc). +If all else fails and your issue is persistent, please open an issue on the GitHub repository, or report the issue on our Discord server. --- ## Where are logs stored? -The TKMM logs are stored in the `log.txt` file in the folder `\Documents\TotK Mod Manager\`. +The TKMM logs are stored in the log.txt file in the folder \Documents\TotK Mod Manager. From 329e5c8628d8056aa0876d8069f0d885a9d63f7b Mon Sep 17 00:00:00 2001 From: ArchLeaders Date: Sat, 12 Oct 2024 11:53:08 -0700 Subject: [PATCH 07/10] Proving my ability to type --- wwwroot/docs/creating-mods/index.md | 2 +- wwwroot/docs/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/wwwroot/docs/creating-mods/index.md b/wwwroot/docs/creating-mods/index.md index 7d59b3c..1f44288 100644 --- a/wwwroot/docs/creating-mods/index.md +++ b/wwwroot/docs/creating-mods/index.md @@ -1,6 +1,6 @@ --- title: Packaging Mods -description: Documentaion for creating mods with TKMM for desktop. +description: Documentation for creating mods with TKMM for desktop. --- # Packaging diff --git a/wwwroot/docs/index.md b/wwwroot/docs/index.md index 4756cd6..b85646b 100644 --- a/wwwroot/docs/index.md +++ b/wwwroot/docs/index.md @@ -1,6 +1,6 @@ --- title: Getting Started -description: Documentation on how to get stated using TKMM on desktop. +description: Documentation on how to get started using TKMM on desktop. --- # Getting Started From fb559e7b7fb2baeb564a3cd22502030fbfb8f7a9 Mon Sep 17 00:00:00 2001 From: ArchLeaders Date: Sat, 12 Oct 2024 11:53:47 -0700 Subject: [PATCH 08/10] Escape quotes --- wwwroot/faq/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/wwwroot/faq/index.md b/wwwroot/faq/index.md index a518f5f..14c5bbe 100644 --- a/wwwroot/faq/index.md +++ b/wwwroot/faq/index.md @@ -35,7 +35,7 @@ description: Frequently asked questions for TKMM troubleshooting. }, { "@type": "Question", - "name": "Why do I see "MsgNotFound" in-game?", + "name": "Why do I see \"MsgNotFound\" in-game?", "acceptedAnswer": { "@type": "Answer", "text": "When mods edit or add more text, every language will not always be included. TKMM can handle this by applying text edits to the language you use in the game.\n\nIn order to fix this problem, go to the settings page and navigate to Merging / Target Language then ensure your region and language are properly selected.\n\nFor example, if you play in English and your region is set to America, you should select USen." From 4059ac8d38c170c00e44e98131dc4ae94e54afe6 Mon Sep 17 00:00:00 2001 From: ArchLeaders Date: Sat, 12 Oct 2024 11:59:50 -0700 Subject: [PATCH 09/10] Override global app title --- wwwroot/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/wwwroot/index.md b/wwwroot/index.md index ab14572..59777f4 100644 --- a/wwwroot/index.md +++ b/wwwroot/index.md @@ -1,5 +1,6 @@ --- _layout: landing +_appTitle: ~ title: TotK Mod Manager | Home description: The home page for TKMM, a tool for managing and merging Tears of the Kingdom mods. --- From 01d48e14cecb5dd46660cf3b1734dfe87a3689af Mon Sep 17 00:00:00 2001 From: ArchLeaders Date: Sat, 12 Oct 2024 12:00:16 -0700 Subject: [PATCH 10/10] Add header to downloads page --- wwwroot/downloads/index.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/wwwroot/downloads/index.md b/wwwroot/downloads/index.md index 1db617f..2b7981a 100644 --- a/wwwroot/downloads/index.md +++ b/wwwroot/downloads/index.md @@ -1,7 +1,10 @@ --- -title: Downloads +title: Download TKMM +description: Downloads page for TKMM. --- +# Download TKMM + # [Windows](#tab/windows) > Downloads for Windows