Using Mods

This guide will go through installing mods, configuring mod options, and finally merging and exporting the merged mods.

Installing Mods

To install a mod file, use Mod > Install File or the Install button below the mod list.

The supported files formats are .tkcl, .zip, .rar and .7z.

Tip

If you are installing .7z files, update your Application Settings' 7z Path to make installation faster.

Installing a Mod Folder

To install a mod folder, use Mod > Install Folder.

Mod folders must contain a romfs, exefs or cheats folder.

Installing a Mod from GameBanana

To install a mod from GameBanana, use Mod > Install from Argument and provide the mod ID or URL.

Alternatively, you can use the built-in GameBanana browser to browse and install mods.

Installing a Mod from the GameBanana Browser

To open the built-in GameBanana browser, click the GameBanana Mod Browser ⁽¹⁾ tab in the navigation bar.

To install a mod from the built-in GameBanana browser, click the mod title ⁽²⁾ and select a file in the dialog popup ⁽³⁾.

Once you have selected the file you wish to install, click Install ⁽⁴⁾ and wait for the installation to complete.

Note

When possible, install the file that matches your game version.

Configuring Mod Options

To configure options when installing a mod, click the prompt ⁽¹⁾ in the bottom right or the Options ⁽²⁾ button.

Note

If the mod has no options, there will not be a prompt and the Options button will not be visible.

Options are sorted into groups. Each group has a type to define how you pick the options.

• Single allows you to select 1 or 0 options.
• Single Required means you must select 1 option (the first option is always selected by default).
• Multi allows you to select any number of options (including 0).
• Multi Required allows you to select any number of options but 1 must remain selected.

Click anywhere on the option group ⁽³⁾ to expand the available options ⁽⁴⁾.

Once the options are configured to your liking, press the Back Arrow ⁽⁵⁾ button in the top left to hide the options.

Ordering Mods

Mods often contain files that TKMM cannot merge. To resolve this, TKMM retains the order of mods to overwrite mods with a lower priority.

The mod at the top of the list will have the highest priority ⁽¹⁾, and the mod at the bottom of the list will have the lowest priority ⁽²⁾.

To change the order of mods, select one and use the up ⁽³⁾ and down ⁽⁴⁾ arrows to move the mod.

You can also move the mods by selecting and dragging them with your cursor.

The order of your mods is highly subjective. Larger mods are typically placed with lower priority, but you may have to tweak it to get everything working the way you want.

Tip

If you are having issues with a certain mod, consult the mod author for guidance on placing it your mod list.

Merging Mods

To merge your mods, press the Merge ⁽¹⁾ button or use the keyboard shortcut Ctrl + M.

If you wish to disable a mod, uncheck the checkbox on the mod. Press merge to apply your changes.

Merging may take some time, so be patient. When merging has completed a green banner ⁽¹⁾ will appear to notify you of completion.

• If you are playing on a Switch emulator, refer to the emulator setup section.
• If you are playing on a physical Switch, refer to the Switch setup section.

Emulator Setup

To setup exporting for one or more Switch emulators, use Mod > Edit Export Locations or Ctrl + L to edit the export locations.

Note

On the currently available version (1.0.0-beta11), this option is only accessible from the Settings page, under Merging > Export Locations.

• If you are using yuzu, enable the first entry listed ⁽¹⁾.
• If you are using Ryujinx, enable the second entry listed ⁽²⁾.

If you are using another emulator, click the + ⁽³⁾ button and paste the path to a TKMM subfolder in your emulator's mod folder.

Click Close ⁽⁴⁾ to save and close.

Tip

You do not need to merge again after editing your export locations.

Switch Setup

Before starting, insert your SD card into your computer or use the Hekate USB Tools (Tools > USB Tools > SD Card in Hekate) to transfer over USB.

Navigate to Tools > Export to SD Card or use Ctrl + E to open the export dialog.

From there, select the SD card from the dropdown ⁽¹⁾.

Finally, press Export ⁽²⁾ and wait for the export to complete.

Caution

Mods previously installed in atmosphere will be permanently deleted.
Make sure atmosphere/contents/0100F2C0115B6000 is empty before proceeding.