Skip to content

Commit

Permalink
Merge pull request #13 from TKMM-Team/seo-optimizations
Browse files Browse the repository at this point in the history
Search Engine Optimizations
  • Loading branch information
MasterBubbles authored Oct 12, 2024
2 parents b5e0e5b + 01d48e1 commit 7fe17ed
Show file tree
Hide file tree
Showing 9 changed files with 136 additions and 37 deletions.
1 change: 1 addition & 0 deletions wwwroot/about/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
_layout: landing
title: About
description: Basic information about TKMM and the development team.
---

# About
Expand Down
5 changes: 5 additions & 0 deletions wwwroot/docfx.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
{
"build": {
"sitemap": {
"baseUrl": "https://tkmm.org",
"priority": 1.0,
"changefreq": "weekly"
},
"content": [
{
"files": [
Expand Down
1 change: 1 addition & 0 deletions wwwroot/docs/creating-mods/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Packaging Mods
description: Documentation for creating mods with TKMM for desktop.
---

# Packaging
Expand Down
1 change: 1 addition & 0 deletions wwwroot/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Getting Started
description: Documentation on how to get started using TKMM on desktop.
---

# Getting Started
Expand Down
1 change: 1 addition & 0 deletions wwwroot/docs/settings/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Settings
description: Settings documentation for the TKMM desktop application.
---

# Settings
Expand Down
1 change: 1 addition & 0 deletions wwwroot/docs/using-mods/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Using Mods
description: Documentation on how to install, manage and merge mods in TKMM.
---

# Using Mods
Expand Down
5 changes: 4 additions & 1 deletion wwwroot/downloads/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
---
title: Downloads
title: Download TKMM
description: Downloads page for TKMM.
---

# Download TKMM

# [Windows](#tab/windows)

> Downloads for Windows
Expand Down
106 changes: 90 additions & 16 deletions wwwroot/faq/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,82 @@
---
_layout: landing
title: FAQ
title: TKMM - Frequently Asked Questions (FAQ)
description: Frequently asked questions for TKMM troubleshooting.
---

<script type="application/ld+json">
{
"@context": "https://schema.org",
"@type": "FAQPage",
"mainEntity": [
{
"@type": "Question",
"name": "Why do I need a full game dump?",
"acceptedAnswer": {
"@type": "Answer",
"text": "To save space and be more copyright-friendly, TKMM stores mods without any of the game's copyrighted content.\n\nThis is achieved by comparing the game's copyrighted file with the modded file.\n\nWhile this makes distributing mods easier, it also means that TKMM needs access to a copy of the game.\n\nDistributing any part of the game files is illegal, thus, TKMM requires you to provide your own legally obtained copy of the game."
}
},
{
"@type": "Question",
"name": "Why can't I use version 1.0.0?",
"acceptedAnswer": {
"@type": "Answer",
"text": "The first version of Tears of the Kingdom is very different from every other version.\n\nWith the large number of changes, it becomes challenging to distinguish changes made by modders and changes from the update.\n\nThis is why version 1.0.0 of Tears of the Kingdom is not supported by TKMM."
}
},
{
"@type": "Question",
"name": "Can mods be made compatible for any version?",
"acceptedAnswer": {
"@type": "Answer",
"text": "TKMM will apply the edits from each RomFS mod to the exact version of your game dump, which needs to be at least version <a href=\"#why-cant-i-use-version-100\">1.1.0 or later</a>.\n\nThis however will not be the case for ExeFS mods and cheats, those need to be directly compatible with your target version."
}
},
{
"@type": "Question",
"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 <kbd><samp>Merging</samp></kbd> / <kbd><samp>Target Language</samp></kbd> 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 <ins>USen</ins>."
}
},
{
"@type": "Question",
"name": "What files can TKMM merge?",
"acceptedAnswer": {
"@type": "Answer",
"text": "TKMM can merge archive files (<code>.sarc</code>, <code>.pack</code>), parameter files (<code>.bgyml</code>), the resource database (RSDB), the Mals system (Mals) and the resource size table (RESTBL).\n\nSupport for texture archives (<code>.bntx</code>) and audio archives (<code>.bars</code>) is planned for future releases.\n\nTKMM will never support AI files (<code>.ainb</code>), animation sequence files (<code>.asb</code>), timeline files (<code>.bfevtm</code>) or event flow files (<code>.bfevfl</code>)."
}
},
{
"@type": "Question",
"name": "Why aren't my mods showing up in-game?",
"acceptedAnswer": {
"@type": "Answer",
"text": "If you play on emulator, please ensure you configured the proper <a href=\"https://tkmm.org/docs/using-mods/#emulator-setup\">Export Location</a>. Otherwise, please refer to the <a href=\"https://tkmm.org/docs/using-mods/#switch-setup\">Switch Setup</a> section of the documentation."
}
},
{
"@type": "Question",
"name": "Why am I getting errors / crashes in-game?",
"acceptedAnswer": {
"@type": "Answer",
"text": "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.\n\nYou can check for corrupted or missing data with <kbd><samp>Tools</samp></kbd> &gt; <kbd><samp>Check Dump Integrity</samp></kbd>. If it detects any issues, refer to the <a href=\"https://zeldamods.org/wiki/Help:Dumping_games#Switch\">RomFS dumping</a> 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*).\n\nIn 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 <a href=\"https://tkmm.org/docs/using-mods/#ordering-mods\">priority order</a> of the mods in question.\n\nFor mods with <a href=\"https://tkmm.org/docs/using-mods/#configuring-mod-options\">configurable options</a>, please ensure you selected those according to your preferences.\n\nIf all else fails and your issue is persistent, please open an issue on the <a href=\"https://github.com/TKMM-Team/Tkmm/issues/new\">GitHub repository</a>, or report the issue on our <a href=\"https://discord.gg/BbVXenRFVc\">Discord server</a>."
}
},
{
"@type": "Question",
"name": "Where are logs stored?",
"acceptedAnswer": {
"@type": "Answer",
"text": "The TKMM logs are stored in the <code>log.txt</code> file in the folder <code>\Documents\TotK Mod Manager</code>."
}
}
]
}
</script>

# Frequently Asked Questions

This page contains answers to frequently asked questions.
Expand All @@ -23,17 +97,17 @@ 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.

---

## 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 <a href="#why-cant-i-use-version-100">1.1.0 or later</a>.

This however will not be the case for ExeFS mods and cheats, those need to be directly compatible with your target version.

Expand All @@ -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 <kbd><samp>Merging</samp></kbd> / <kbd><samp>Target Language</samp></kbd> 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 <ins>USen</ins>.

---

## 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 (<code>.sarc</code>, <code>.pack</code>), parameter files (<code>.bgyml</code>), 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 (<code>.bntx</code>) and audio archives (<code>.bars</code>) 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 (<code>.ainb</code>), animation sequence files (<code>.asb</code>), timeline files (<code>.bfevtm</code>) or event flow files (<code>.bfevfl</code>).

---

## 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 <a href="https://tkmm.org/docs/using-mods/#emulator-setup">Export Location</a>. Otherwise, please refer to the <a href="https://tkmm.org/docs/using-mods/#switch-setup">Switch Setup</a> 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 <kbd><samp>Tools</samp></kbd> &gt; <kbd><samp>Check Dump Integrity</samp></kbd>. 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 <kbd><samp>Tools</samp></kbd> &gt; <kbd><samp>Check Dump Integrity</samp></kbd>. If it detects any issues, refer to the <a href="https://zeldamods.org/wiki/Help:Dumping_games#Switch">RomFS dumping</a> 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 <a href="https://tkmm.org/docs/using-mods/#ordering-mods">priority order</a> 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 <a href="https://tkmm.org/docs/using-mods/#configuring-mod-options">configurable options</a>, 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 <a href="https://github.com/TKMM-Team/Tkmm/issues/new">GitHub repository</a>, or report the issue on our <a href="https://discord.gg/BbVXenRFVc">Discord server</a>.

---

## 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 <code>log.txt</code> file in the folder <code>\Documents\TotK Mod Manager</code>.

52 changes: 32 additions & 20 deletions wwwroot/index.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,68 @@
---
_layout: landing
title: Home
_appTitle: ~
title: TotK Mod Manager | Home
description: The home page for TKMM, a tool for managing and merging Tears of the Kingdom mods.
---

<script type="application/ld+json">
{
"@context": "https://schema.org/",
"@type": "SoftwareApplication",
"name": "TotK Mod Manager",
"operatingSystem": "Windows 8.1+, Linux, Steam Deck, macOS",
"applicationCategory": ["GameApplication", "UtilitiesApplication"],
"offers": {
"@type": "Offer",
"price": 0
}
}
</script>

<div align="center">
<a href=""><img src="images/Icon-Transparent-1024.png" width="300vh"></a>
<a href="" title="TKMM landing page"><img src="images/Icon-Transparent-1024.png" width="300vh" alt="TKMM Logo"></a>
<h1 id="main-title">Tears of the Kingdom Mod Manager</h1>
</div>

<p align="center" style="text-align: center;">
<a href="https://github.com/TKMM-Team/Tkmm/releases">
<img src="https://img.shields.io/github/v/tag/TKMM-Team/Tkmm?style=for-the-badge&logoColor=C71B42&color=C71B42&labelColor=2A2C33&logo=git&label=Version" alt="Releases'"/>
<img src="https://img.shields.io/github/v/tag/TKMM-Team/Tkmm?style=for-the-badge&logoColor=C71B42&color=C71B42&labelColor=2A2C33&logo=git&label=Version" alt="GitHub releases page"/>
</a> &nbsp;
<a href="https://discord.com/invite/3tNUBWQRXv">
<img src="https://img.shields.io/discord/1179611100183011429?style=for-the-badge&logoColor=5865F2&color=5865F2&labelColor=2A2C33&logo=discord&label=discord" alt="Discord"/>
<img src="https://img.shields.io/discord/1179611100183011429?style=for-the-badge&logoColor=5865F2&color=5865F2&labelColor=2A2C33&logo=discord&label=discord" alt="Discord server invite link"/>
</a> &nbsp;
<a href="https://github.com/TKMM-Team/Tkmm">
<img src="https://img.shields.io/github/stars/TKMM-Team/Tkmm?style=for-the-badge&logoColor=FFCB41&color=FFCB41&labelColor=2A2C33&logo=github" alt="Stars"/>
<img src="https://img.shields.io/github/stars/TKMM-Team/Tkmm?style=for-the-badge&logoColor=FFCB41&color=FFCB41&labelColor=2A2C33&logo=github" alt="GitHub repository"/>
</a>
</p>

<div align="center">
<h4>Merge mods like never before!</h4>
</div>

---

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.

## Download TKMM
This is currently only supported on desktop platforms, however, support for running on Switch hardware, mobile devices and the web is being worked on.

<div id="download-btns">
<a class="download-btn" id="download-all" href="./downloads/">Downloads</a>
</div>
Check out the [getting started](/docs/) page to download and use 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">
<img src="https://img.shields.io/github/license/TKMM-Team/Tkmm?logoColor=c6cdde&color=c6cdde&logo=opensourceinitiative&style=for-the-badge&labelColor=2A2C33" alt="Issues"/>
<img src="https://img.shields.io/github/license/TKMM-Team/Tkmm?logoColor=c6cdde&color=c6cdde&logo=opensourceinitiative&style=for-the-badge&labelColor=2A2C33" alt="TKMM license"/>
</a> &nbsp;
<a href="https://github.com/TKMM-Team/Tkmm/issues">
<img src="https://img.shields.io/github/issues/TKMM-Team/Tkmm?logoColor=red&color=red&logo=github&style=for-the-badge&labelColor=2A2C33" alt="Issues"/>
<img src="https://img.shields.io/github/issues/TKMM-Team/Tkmm?logoColor=red&color=red&logo=github&style=for-the-badge&labelColor=2A2C33" alt="GitHub repository issue tracker"/>
</a> &nbsp;
<a href="https://github.com/TKMM-Team/Tkmm/pulls">
<img src="https://img.shields.io/github/issues-pr/TKMM-Team/Tkmm?style=for-the-badge&labelColor=2A2C33&logoColor=blue&color=blue&logo=github" alt="Open Pull Requests"/>
<img src="https://img.shields.io/github/issues-pr/TKMM-Team/Tkmm?style=for-the-badge&labelColor=2A2C33&logoColor=blue&color=blue&logo=github" alt="Open pull-requests"/>
</a> &nbsp;
<a href="https://github.com/TKMM-Team/Tkmm/pulls">
<img src="https://img.shields.io/github/issues-pr-closed/TKMM-Team/Tkmm?style=for-the-badge&labelColor=2A2C33&logoColor=5751FF&color=5751FF&logo=github" alt="Closed Pull Requests"/>
<img src="https://img.shields.io/github/issues-pr-closed/TKMM-Team/Tkmm?style=for-the-badge&labelColor=2A2C33&logoColor=5751FF&color=5751FF&logo=github" alt="Closed pull-requests"/>
</a>
</p>

*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!*

0 comments on commit 7fe17ed

Please sign in to comment.