-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
cf5e9c6
commit 32a0896
Showing
28 changed files
with
80 additions
and
80 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Binary file not shown.
Binary file not shown.
Binary file not shown.
File renamed without changes
File renamed without changes
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,66 @@ | ||
# Documentation | ||
--- | ||
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. | ||
|
||
<p> | ||
<img width="650" src="./images/Launcher.png" alt="tkmm launcher window"> | ||
</p> | ||
|
||
> [!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. | ||
|
||
<p> | ||
<img width="650" src="./images/Settings_NoGamePath.png" alt="invalid settings page"> | ||
</p> | ||
|
||
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. | ||
<p> | ||
<img width="650" src="./images/Settings_WithGamePath.png"> | ||
</p> | ||
|
||
> [!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. |
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/ |
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
- name: Downloads | ||
href: index.md | ||
- name: Getting Started | ||
href: ../docs/getting-started | ||
href: ../docs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
_layout: landing | ||
title: FAQ | ||
--- | ||
|
||
# Frequently Asked Questions |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,5 +2,7 @@ | |
href: downloads/ | ||
- name: Documentation | ||
href: docs/ | ||
- name: FAQ | ||
href: faq/ | ||
- name: About | ||
href: about/ |