Skip to content

Commit

Permalink
Add SimpleModManager Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
MarigoldZephyrNio committed Sep 4, 2024
1 parent 4bf8d52 commit a231731
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 0 deletions.
Binary file added docs/homebrew/img/simplemodmanager1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/homebrew/img/simplemodmanager2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/homebrew/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Homebrew apps are stored in `sd:/switch` by default and Homebrew sysmodules are
#### Additional Homebrew apps/sysmodules:

- [EdiZon](edizon.md) (sysmodule and Homebrew app)
- [SimpleModManager](simplemodmanager.md) (Homebrew app)
- [Tesla-Menu](tesla-menu.md) (sysmodule)
- [MissionControl](mission-control.md) (sysmodule)
- [sys-con](sys-con.md)(sysmodule)
Expand Down
30 changes: 30 additions & 0 deletions docs/homebrew/simplemodmanager.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
### Information

SimpleModManager is a [homebrew app](index.md#terminologies) that allows easily adding and removing mods to the layeredFS directory from another directory on the SD card.

#### Common use cases for SimpleModManager:

- Switching between large modpacks
- Enabling and disabling individual mods

!!! warning "What **not** to use SimpleModManager for."
SimpleModManager should not be used for some specific games like Super Smash Bros. Ultimate and The Legend of Zelda: Breath of the Wild and Tears of the Kingdom. This is due to how these games handle mods differently from others.
-----

#### Installation requirements:
- The latest release of [SimpleModManager](https://github.com/nadrino/SimpleModManager/releases/latest) (the `SimpleModManager.nro` file)

#### Installation instructions:
1. Boot into Hekate and go to `Tools` > `USB Tools` > `SD Card`, then plug your Switch into your PC via USB.
2. Your microSD card should now be accessible on your PC, open it.
3. Copy the `SimpleModManager.nro` file the `/switch/` folder on your microSD card.
4. Boot into CFW.

#### Usage instructions:
1. Create a directory named `mods/<game name>/<mod name>/` on the root of the SD card.
- What you put for the mod name does not have to align with anything, put whatever you like!
2. Create the layeredFS directory for your mod that can be found on the [Game Modding](../extras/game_modding.md) page, skipping the `atmosphere` folder inside the `<mod name>` folder.
3. Launch SimpleModManager via the Homebrew Menu and your games will show up, pressing A on them will show the mods available.

![ExampleSwitchTheme](img/simplemodmanager1.jpg){ width="600" }
![ExampleSwitchTheme](img/simplemodmanager2.jpg){ width="600" }
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ nav:
- 'NXTheme Installer': 'homebrew/nxtheme-installer.md'
- 'NX-Shell': 'homebrew/nx-shell.md'
- 'EdiZon': 'homebrew/edizon.md'
- 'SimpleModManager': 'homebrew/simplemodmanager.md/'
- 'Tesla-Menu': 'homebrew/tesla-menu.md'
- 'MissionControl': 'homebrew/mission-control.md'
- 'sys-con': 'homebrew/sys-con.md'
Expand Down

0 comments on commit a231731

Please sign in to comment.