Skip to content

Commit

Permalink
Using Mods began
Browse files Browse the repository at this point in the history
  • Loading branch information
AsteroidPizza39 committed Jun 12, 2024
1 parent 5e3c162 commit a00b042
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions wwwroot/docs/getting-started/using-mods/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,19 @@
This page will guide you on how to install mods, configure options for mods, and manage mod profiles.

## Installing Mods
You can install mods from a file archive, a folder, or from TKMM's built-in GameBanana tab.

### Installing Mods From An Archive
TKMM supports installing mods from several archive types, including `rar`, `zip`, `7z`, and a custom format, `TKCL`. The first three are generic archive types that you may already be familiar with from using mods. `TKCL` files are produced by developers using TKMM, and are the best option when available, since they were specifically designed for use in TKMM. To install a mod from a file, you can drag and drop the file onto the homepage of TKMM, or locate it in your computer's files by choosing `Install File` in the `Mod` dropdown at the top of the screen. If your active profile already has at least one mod installed, you can click on the Install button at the bottom of the mod list. Additionally, the keyboard shortcut `Ctrl + I` will prompt you to select a file to install a mod from.
<p>
<img width="550" src="./images/UseMods_Archive_01.png">
</p>


### Installing Mods From A Folder
TKMM supports installing a mod from a folder, provided it has the correct structure. The folder must only contain in it a romfs and/or exefs folder, and any files added using the packaging tab. To install a mod from a folder, you can drag and drop the folder onto the homepage of TKMM, or locate it in your computer's file system by choosing `Install Folder` in the `Mod` dropdown at the top of the screen. Additionally, the keyboard shortcut `Ctrl + Shift + I` will prompt you to select a folder to install a mod from. This is the recommended method for mod developers who want to be able to quickly test their mod without having to package it.

### Installing Mods From TKMM's GameBanana Tab


## Configuring Options
Expand Down

0 comments on commit a00b042

Please sign in to comment.