diff --git a/docs/.vitepress/i18n/en_US.js b/docs/.vitepress/i18n/en_US.js index b269ff170..471c24e22 100644 --- a/docs/.vitepress/i18n/en_US.js +++ b/docs/.vitepress/i18n/en_US.js @@ -50,20 +50,7 @@ const themeConfig = { text: localeData.pages["homebrew"], link: `/homebrew/`, items: [ - { text: localeData.pages["homebrew/jksv"], link: `/homebrew/jksv` }, - { text: localeData.pages["homebrew/goldleaf"], link: `/homebrew/goldleaf` }, - { text: localeData.pages["homebrew/ftpd"], link: `/homebrew/ftpd` }, - { text: localeData.pages["homebrew/nxtheme-installer"], link: `/homebrew/nxtheme-installer` }, - { text: localeData.pages["homebrew/nx-shell"], link: `/homebrew/nx-shell` }, - { text: localeData.pages["homebrew/edizon"], link: `/homebrew/edizon` }, - { text: localeData.pages["homebrew/simplemodmanager"], link: `/homebrew/simplemodmanager` }, - { text: localeData.pages["homebrew/tesla-menu"], link: `/homebrew/tesla-menu` }, - { text: localeData.pages["homebrew/mission-control"], link: `/homebrew/mission-control` }, - { text: localeData.pages["homebrew/sys-con"], link: `/homebrew/sys-con` }, - { text: localeData.pages["homebrew/sys-botbase"], link: `/homebrew/sys-botbase` }, - { text: localeData.pages["homebrew/sysdvr"], link: `/homebrew/sysdvr` }, - { text: localeData.pages["homebrew/sys-clk"], link: `/homebrew/sys-clk` }, - { text: localeData.pages["homebrew/ldn_mitm"], link: `/homebrew/ldn_mitm` } + { text: localeData.pages["homebrew/controllers"], link: `/homebrew/controllers` }, ] }, sidebar_common diff --git a/docs/.vitepress/i18n/strings/en_US.json b/docs/.vitepress/i18n/strings/en_US.json index 006890f39..a1c0bbad1 100644 --- a/docs/.vitepress/i18n/strings/en_US.json +++ b/docs/.vitepress/i18n/strings/en_US.json @@ -31,20 +31,7 @@ "extras/updating": "Updating CFW", "faq": "FAQ", "homebrew": "Homebrew", - "homebrew/edizon": "EdiZon", - "homebrew/ftpd": "FTPD", - "homebrew/goldleaf": "Goldleaf", - "homebrew/jksv": "JKSV", - "homebrew/ldn_mitm": "ldn_mitm", - "homebrew/mission-control": "MissionControl", - "homebrew/nx-shell": "NX-Shell", - "homebrew/nxtheme-installer": "NXTheme Installer", - "homebrew/simplemodmanager": "SimpleModManager", - "homebrew/sys-botbase": "sys-botbase", - "homebrew/sys-clk": "sys-clk", - "homebrew/sys-con": "sys-con", - "homebrew/sysdvr": "SysDVR", - "homebrew/tesla-menu": "Tesla Menu", + "homebrew/controllers": "Unofficial Controllers", "multiple-options": "Multiple Options", "user_guide/all/cfw_environment": "CFW on sysMMC vs. CFW on emuMMC", "user_guide/all/launching_cfw": "Launching CFW", diff --git a/docs/homebrew/controllers.md b/docs/homebrew/controllers.md new file mode 100644 index 000000000..dc2bb465c --- /dev/null +++ b/docs/homebrew/controllers.md @@ -0,0 +1,86 @@ +# MissionControl & sys-con + +MissionControl and sys-con are both [sysmodules](index#terminologies) that allo you to use normally-unsupported controllers as if they were natively supported. MissionControl lets you pair controllers over bluetooth and sys-con allows you to use them via USB. A list of supported controllers, along with additional usage instructions and configuration, can be found on [MissionControl's](https://github.com/ndeadly/MissionControl) and [sys-con's](https://github.com/o0Zz/sys-con) github pages. + +## MissionControl requirements + +* An archive manager like [7-Zip](https://www.7-zip.org/) +* The latest release of [MissionControl](https://github.com/ndeadly/MissionControl/releases) (the `MissionControl-(version)-master-(hash).zip` file) + +## MissionControl Installation + +1. Boot into hekate and go to `Tools` > `USB Tools` > `SD Card`, then plug your Switch into your PC via USB. +1. Your microSD card should now be accessible on your PC, open it. +1. Extract the `.zip` file to a location on your computer. + * If your archive manager allows for it, you can also simply open the `.zip` file directly. +1. Copy the *contents* of the (extracted) `.zip` file to the root of your microSD card. + * **Optional:** You can verify if you've installed MissionControl correctly, you should have a folder called `010000000000BD00` (MissionControl) in `sd:/atmosphere/contents`. +1. Boot into CFW. + +## MissionControl Troubleshooting + +### My Switch crashes on boot after I installed MissionControl! + +**Cause:** If your Switch crashes with Error `std::abort (0xFFE)` and Title ID `010000000000BD00`, you're using a version of MissionControl that's incompatible with your Atmosphère version. The expected Atmosphère version is mentioned on each release page of a MissionControl release. + +**Fix:** If there is a release that supports your Atmosphère version, you can update MissionControl by following the [installation instructions](#MissionControl-Installation) above. If this isn't the case, you can remove the `sd:/atmosphere/contents/010000000000BD00` folder (MissionControl) to allow the switch to boot. + +### MissionControl isn't doing anything! + +Since MissionControl is background process, it makes no visual changes when running. You can confirm it's running by connecting a left Joycon or Pro Controller to the console wirelessly and pressing the `DPAD_UP` and `MINUS` buttons together. If MissionControl is active, this will act like the capture button and take a screenshot. If not, it's likely it is not running. + +#### MissionControl is not running! + +**Cause:** Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. + +**Fix:** Try running the archive bit fixer utility by booting hekate and going to `Tools` > `Arch bit • RCM Touch • Pkg1/2` > `Fix Archive Bit`. + +#### MissionControl is running, but my controller isn't working! + +**Cause:** The controller you are using could be unsupported. + +**Fix:** See if your controller is on [the list of supported controllers.](https://github.com/ndeadly/MissionControl#supported-controllers). + +### The issue I'm having isn't on here! + +Read through MissionControls [frequently asked questions](https://github.com/ndeadly/MissionControl#frequently-asked-questions) page. + + +## sys-con requirements + +* An archive manager like [7-Zip](https://www.7-zip.org/) +* The latest release of [sys-con](https://github.com/o0Zz/sys-con/releases) (the `sys-con-(version).zip` file) + +## sys-con Installation + +1. Boot into hekate and go to `Tools` > `USB Tools` > `SD Card`, then plug your Switch into your PC via USB. +1. Your microSD card should now be accessible on your PC, open it. +1. Extract the `.zip` file to a location on your computer. + * If your archive manager allows for it, you can also simply open the `.zip` file directly. +1. Copy the *contents* of the (extracted) `.zip` file to the root of your microSD card. + * **Optional:** You can verify if you've installed sys-con correctly, you should have a folder called `690000000000000D` (sys-con) in `sd:/atmosphere/contents`. +1. Boot into CFW. + +## sys-con Troubleshooting + +### My Switch crashes on boot after I installed sys-con! + +**Cause:** If your Switch crashes with Error `std::abort (0xFFE)` and Title ID `690000000000000D`, you're using a version of sys-con that's incompatible with your Atmosphère version. The expected Atmosphère version is mentioned on each release page of a sys-con release. + +**Fix:** If there is a release that supports your Atmosphère version, you can update sys-con by following the [installation instructions](#sys-con-Installation) above. If this isn't the case, you can remove the `sd:/atmosphere/contents/690000000000000D` folder (sys-con) to allow the switch to boot. + +### sys-con is not running! + +**Cause:** Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. + +**Fix:** Try running the archive bit fixer utility by booting hekate and going to `Tools` > `Arch bit • RCM Touch • Pkg1/2` > `Fix Archive Bit`. + +### sys-con is running, but my controller isn't working! + +**Cause:** The controller you are using could be unsupported. + +**Fix:** See if your controller is on [the list of supported controllers](https://github.com/o0Zz/sys-con/blob/master/doc/TestedControllers.md). + +### The issue I'm having isn't on here! + +Read through sys-cons [troubleshooting](https://github.com/o0Zz/sys-con/blob/master/doc/Troubleshooting.md) page. \ No newline at end of file diff --git a/docs/homebrew/edizon.md b/docs/homebrew/edizon.md deleted file mode 100644 index 715e43682..000000000 --- a/docs/homebrew/edizon.md +++ /dev/null @@ -1,84 +0,0 @@ -# Game Cheats with EdiZon - -For cheats management, [EdiZon](https://github.com/WerWolv/EdiZon) and/or [EdiZon-SE](https://github.com/tomvita/EdiZon-SE) (up to date and offers more features) are recommended. They offer support for Atmosphère's cheat engine, providing an easy way to download new cheats, as well as toggle them on or off. - -## Section I - Requirements - -* An archive manager like [7-Zip](https://www.7-zip.org/) -* The latest release of [EdiZon](https://github.com/WerWolv/EdiZon/releases) (the `EdiZon.nro` file) or [EdiZon-SE](https://github.com/tomvita/EdiZon-SE/releases) (the `EdiZon.zip` file) - -::: tip - -**EdiZon overlay** - -EdiZon also offers a Tesla-Menu overlay, however, the official EdiZon overlay is no longer maintained and will result in Atmosphère crashing when trying to use the EdiZon overlay on firmware version 16.0.0+. - -The maintained overlay can be found on the [EdiZon Overlay GitHub](https://github.com/proferabg/EdiZon-Overlay/releases) repository. - -::: - -## Section II - Installation - -::::: tabs - -:::: tab default EdiZon - -1. Boot into hekate and go to `Tools` > `USB Tools` > `SD Card`, then plug your Switch into your PC via USB. -1. Your microSD card should now be accessible on your PC, open it. -1. Put the `EdiZon.nro` in `sd:/switch`. -1. Boot into CFW. - -:::: - -:::: tab EdiZon-SE - -1. Boot into hekate and go to `Tools` > `USB Tools` > `SD Card`, then plug your Switch into your PC via USB. -1. Your microSD card should now be accessible on your PC, open it. -1. Extract the `.zip` file to a location on your computer. - * If your archive manager allows for it, you can also simply open the `.zip` file directly. -1. Copy the *contents* of the (extracted) `.zip` file to the root of your microSD card. - * **Optional:** You can verify if you've installed EdiZon-SE correctly, you should have a folder called `054e4f4558454000` (EdiZon-SE) in `sd:/atmosphere/contents` and an `EdiZon.nro` file in `sd:/switch/EdiZon`. -1. Boot into CFW. - -:::: - -::::: - -## Section III - Usage - -Atmosphère looks for cheats to load in the `contents` sub-folder of the `atmosphere` folder. The template it looks for is `sd:/atmosphere/contents//cheats/.txt`. -You need to create the `` folder and sub-folders manually: - -* `title_id` being the title or program of a game. This is game specific and can be found on EdiZon's cheat menu (TID and BID, see the bottom of this page for a sample), [switchbrew](https://switchbrew.org/wiki/Title_list/Games) and [nswdb](https://nswdb.com/). - * **Note:** Title ID means the same thing as Program ID. -* `build_id` being the version of a game. This is game specific and can be found on EdiZon's cheat menu (BID, see the bottom of this page for a sample) Cheats can be version specific so make sure the cheats you are using are compatible with your game version. - -**Note:** On Atmosphère 0.9.4 and below `contents` is called `titles`. - -Once the title is launched while in Atmosphère, your cheats should be applied. - -### Preventing cheats from being enabled by default - -To prevent cheats from being enabled by default, you can change your Atmosphère configuration by following the steps below. - -1. Copy `system_settings.ini` from `sd:/atmosphere/config_templates` to `sd:/atmosphere/config` if it's not already there. -1. Open the `system_settings.ini` file with a text editor and edit the line `; dmnt_cheats_enabled_by_default = u8!0x1` to `dmnt_cheats_enabled_by_default = u8!0x0`. - * Make sure you remove the space and the semicolon "`;`" in front of `dmnt_cheats_enabled_by_default`. - -By default, holding the L button while launching a game will disable any game modification. - -Here the Title ID of the game (TID) is `0100646009FBE000` and the Build ID of the game (BID) is `0B9A75586BC1A6C6`. Cheats are loaded from `sd:/atmosphere/contents/0100646009FBE000/cheats/0B9A75586BC1A6C6.txt` in this example. - -![ExampleGameCheat](../extras/img/game_cheating.jpg) - -## Section IV - Additional Information - -For more in-depth details about Atmosphère's cheat engine, you can refer to [this page](https://github.com/Atmosphere-NX/Atmosphere/blob/master/docs/features/cheats.md). - -## Section V - Troubleshooting - -### EdiZon isn't showing up when I open the Homebrew menu! - -Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via hekate for all files. - -This can be done by booting into hekate and going to `Tools` > `Arch bit • RCM Touch • Pkg1/2` > `Fix Archive Bit`. diff --git a/docs/homebrew/ftpd.md b/docs/homebrew/ftpd.md deleted file mode 100644 index adbfca4a4..000000000 --- a/docs/homebrew/ftpd.md +++ /dev/null @@ -1,33 +0,0 @@ -# FTPD - -FTPD is simply an FTP server for the Switch, it can be used to transfer files wirelessly to- and from- your microSD card. - -## Section I - Requirements - -* An FTP client such as [WinSCP](https://winscp.net/eng/download.php) (Windows) -* Any device that can connect to an FTP server with an FTP client - -## Section II - Usage - -::: tip - -**Note** - -This section assumes that the device running the FTP client and your Switch are connected to the same network. If it's not, make sure they are connected to the same network before continuing. - -::: - -1. Launch the FTPD Homebrew app from the Homebrew menu. -1. Open your FTP client of choice. -1. Add a new connection and in the `Host` field of your FTP client, put in the IP address of your Switch mentioned in the top left of FTPD. - * If applicable in your FTP client, check the `Anonymous` box. -1. Type in port `5000` for the port and attempt to connect to your Switch. -1. You should now be able to access your microSD card wirelessly and transfer files to- and from- the microSD card. - -### FTPD's main menu - -![FTPD](img/ftpd.jpg) - -## Section III - Additional Information - -FTPD can also run in the form of a background process (sysmodule), called sys-ftpd. More information, as well as usage and configuration options, can be found on the [sys-ftpd GitHub](https://github.com/cathery/sys-ftpd) repository. diff --git a/docs/homebrew/goldleaf.md b/docs/homebrew/goldleaf.md deleted file mode 100644 index 01596334d..000000000 --- a/docs/homebrew/goldleaf.md +++ /dev/null @@ -1,21 +0,0 @@ -# Goldleaf - -Goldleaf is primarily a very extensive file and console content manager. - -::: details Common use cases for Goldleaf - -* Account management -* Browsing your microSD card -* Browsing the partitions of the internal storage -* Enabling access to the built-in Switch web browser -* Export Switch firmware -* Restoring games to their base game versions -* File management - -And much more! All of the uses for the application can be found on the [Goldleaf GitHub](https://github.com/XorTroll/Goldleaf) repository. - -::: - -## Goldleaf screenshots - -![main menu](img/goldleaf.jpg) diff --git a/docs/homebrew/img/ftpd.jpg b/docs/homebrew/img/ftpd.jpg deleted file mode 100644 index 1c2625d2f..000000000 Binary files a/docs/homebrew/img/ftpd.jpg and /dev/null differ diff --git a/docs/homebrew/img/goldleaf.jpg b/docs/homebrew/img/goldleaf.jpg deleted file mode 100644 index a7b75bf9c..000000000 Binary files a/docs/homebrew/img/goldleaf.jpg and /dev/null differ diff --git a/docs/homebrew/img/jksv.jpg b/docs/homebrew/img/jksv.jpg deleted file mode 100644 index d1630e50c..000000000 Binary files a/docs/homebrew/img/jksv.jpg and /dev/null differ diff --git a/docs/homebrew/img/jksv/appinfo.png b/docs/homebrew/img/jksv/appinfo.png deleted file mode 100644 index b7d7713b6..000000000 Binary files a/docs/homebrew/img/jksv/appinfo.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/audience.png b/docs/homebrew/img/jksv/audience.png deleted file mode 100644 index 520d83c24..000000000 Binary files a/docs/homebrew/img/jksv/audience.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/audience_external.png b/docs/homebrew/img/jksv/audience_external.png deleted file mode 100644 index 97c96a91c..000000000 Binary files a/docs/homebrew/img/jksv/audience_external.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/auth_platform.png b/docs/homebrew/img/jksv/auth_platform.png deleted file mode 100644 index c3576c70a..000000000 Binary files a/docs/homebrew/img/jksv/auth_platform.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/consent_screen.png b/docs/homebrew/img/jksv/consent_screen.png deleted file mode 100644 index b388aab2f..000000000 Binary files a/docs/homebrew/img/jksv/consent_screen.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/contactinfo.png b/docs/homebrew/img/jksv/contactinfo.png deleted file mode 100644 index 19767e5e0..000000000 Binary files a/docs/homebrew/img/jksv/contactinfo.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/create_credentials.png b/docs/homebrew/img/jksv/create_credentials.png deleted file mode 100644 index cd760032b..000000000 Binary files a/docs/homebrew/img/jksv/create_credentials.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/create_project.png b/docs/homebrew/img/jksv/create_project.png deleted file mode 100644 index 572044dd0..000000000 Binary files a/docs/homebrew/img/jksv/create_project.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/enable_gdrive.png b/docs/homebrew/img/jksv/enable_gdrive.png deleted file mode 100644 index 2d3a7d6e6..000000000 Binary files a/docs/homebrew/img/jksv/enable_gdrive.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/enable_services.png b/docs/homebrew/img/jksv/enable_services.png deleted file mode 100644 index 91d59f582..000000000 Binary files a/docs/homebrew/img/jksv/enable_services.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/enabled_services.png b/docs/homebrew/img/jksv/enabled_services.png deleted file mode 100644 index f37645d79..000000000 Binary files a/docs/homebrew/img/jksv/enabled_services.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/file_renamed.png b/docs/homebrew/img/jksv/file_renamed.png deleted file mode 100644 index 3df4466b3..000000000 Binary files a/docs/homebrew/img/jksv/file_renamed.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/finish.png b/docs/homebrew/img/jksv/finish.png deleted file mode 100644 index 0950146d8..000000000 Binary files a/docs/homebrew/img/jksv/finish.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/finish2.png b/docs/homebrew/img/jksv/finish2.png deleted file mode 100644 index d6b6aa16c..000000000 Binary files a/docs/homebrew/img/jksv/finish2.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/gdrive_api.png b/docs/homebrew/img/jksv/gdrive_api.png deleted file mode 100644 index cd11cf064..000000000 Binary files a/docs/homebrew/img/jksv/gdrive_api.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/navigation_menu.png b/docs/homebrew/img/jksv/navigation_menu.png deleted file mode 100644 index 8b310eb95..000000000 Binary files a/docs/homebrew/img/jksv/navigation_menu.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/oauth_client.png b/docs/homebrew/img/jksv/oauth_client.png deleted file mode 100644 index 9070b4d25..000000000 Binary files a/docs/homebrew/img/jksv/oauth_client.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/oauth_client_created2.png b/docs/homebrew/img/jksv/oauth_client_created2.png deleted file mode 100644 index fb336d0ec..000000000 Binary files a/docs/homebrew/img/jksv/oauth_client_created2.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/oauth_client_id.png b/docs/homebrew/img/jksv/oauth_client_id.png deleted file mode 100644 index 83850ba3a..000000000 Binary files a/docs/homebrew/img/jksv/oauth_client_id.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/oauth_client_id_type1.png b/docs/homebrew/img/jksv/oauth_client_id_type1.png deleted file mode 100644 index d6eea311d..000000000 Binary files a/docs/homebrew/img/jksv/oauth_client_id_type1.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/oauth_client_id_type2.png b/docs/homebrew/img/jksv/oauth_client_id_type2.png deleted file mode 100644 index f0e3f1081..000000000 Binary files a/docs/homebrew/img/jksv/oauth_client_id_type2.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/oauth_client_id_type3.png b/docs/homebrew/img/jksv/oauth_client_id_type3.png deleted file mode 100644 index 441676a41..000000000 Binary files a/docs/homebrew/img/jksv/oauth_client_id_type3.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/project_name.png b/docs/homebrew/img/jksv/project_name.png deleted file mode 100644 index 92e09975c..000000000 Binary files a/docs/homebrew/img/jksv/project_name.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/select_project.png b/docs/homebrew/img/jksv/select_project.png deleted file mode 100644 index 706e0ebd6..000000000 Binary files a/docs/homebrew/img/jksv/select_project.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/select_project2.png b/docs/homebrew/img/jksv/select_project2.png deleted file mode 100644 index a0b684cb5..000000000 Binary files a/docs/homebrew/img/jksv/select_project2.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/test_users.png b/docs/homebrew/img/jksv/test_users.png deleted file mode 100644 index b4e064961..000000000 Binary files a/docs/homebrew/img/jksv/test_users.png and /dev/null differ diff --git a/docs/homebrew/img/jksv/test_users2.png b/docs/homebrew/img/jksv/test_users2.png deleted file mode 100644 index 1089f2084..000000000 Binary files a/docs/homebrew/img/jksv/test_users2.png and /dev/null differ diff --git a/docs/homebrew/img/ldn_mitm.jpg b/docs/homebrew/img/ldn_mitm.jpg deleted file mode 100644 index dfa8c2844..000000000 Binary files a/docs/homebrew/img/ldn_mitm.jpg and /dev/null differ diff --git a/docs/homebrew/img/nx-shell-main.jpg b/docs/homebrew/img/nx-shell-main.jpg deleted file mode 100644 index ab7c5b7f6..000000000 Binary files a/docs/homebrew/img/nx-shell-main.jpg and /dev/null differ diff --git a/docs/homebrew/img/nx-shell-menu.jpg b/docs/homebrew/img/nx-shell-menu.jpg deleted file mode 100644 index a29f6bc7f..000000000 Binary files a/docs/homebrew/img/nx-shell-menu.jpg and /dev/null differ diff --git a/docs/homebrew/img/simplemodmanager1.jpg b/docs/homebrew/img/simplemodmanager1.jpg deleted file mode 100644 index 5e4ed100c..000000000 Binary files a/docs/homebrew/img/simplemodmanager1.jpg and /dev/null differ diff --git a/docs/homebrew/img/simplemodmanager2.jpg b/docs/homebrew/img/simplemodmanager2.jpg deleted file mode 100644 index 8c7669c90..000000000 Binary files a/docs/homebrew/img/simplemodmanager2.jpg and /dev/null differ diff --git a/docs/homebrew/img/sysdvr1.png b/docs/homebrew/img/sysdvr1.png deleted file mode 100644 index 158d05e3b..000000000 Binary files a/docs/homebrew/img/sysdvr1.png and /dev/null differ diff --git a/docs/homebrew/img/sysdvr2.png b/docs/homebrew/img/sysdvr2.png deleted file mode 100644 index e2405c04c..000000000 Binary files a/docs/homebrew/img/sysdvr2.png and /dev/null differ diff --git a/docs/homebrew/img/sysdvr3.png b/docs/homebrew/img/sysdvr3.png deleted file mode 100644 index 09fe59309..000000000 Binary files a/docs/homebrew/img/sysdvr3.png and /dev/null differ diff --git a/docs/homebrew/img/tesla-menu.jpg b/docs/homebrew/img/tesla-menu.jpg deleted file mode 100644 index 90d1117ff..000000000 Binary files a/docs/homebrew/img/tesla-menu.jpg and /dev/null differ diff --git a/docs/homebrew/index.md b/docs/homebrew/index.md deleted file mode 100644 index dcb57ad77..000000000 --- a/docs/homebrew/index.md +++ /dev/null @@ -1,33 +0,0 @@ -# Information - -This page summarizes the included Homebrew apps and additional Homebrew you can check out. - -::: tip - -The guide includes the following Homebrew apps by default: - -* [JKSV](jksv) -* [Goldleaf](goldleaf) -* [FTPD](ftpd) -* [NXTheme Installer](nxtheme-installer) -* [NX-Shell](nx-shell) - -::: - -## Terminology - -Homebrew is a general term, the term can be used for Homebrew apps (`.nro` files) or in the form of background processes, called "sysmodules". The Switch natively has sysmodules built into its firmware but you can run additional Homebrew sysmodules that can add functionality to your Switch. In the section below, you can find additional and commonly used Homebrew apps and sysmodules. - -Homebrew apps are stored in `sd:/switch` by default and Homebrew sysmodules are stored in `sd:/atmosphere/contents` by default. - -### Additional Homebrew apps/sysmodules - -* [EdiZon](edizon) (sysmodule and Homebrew app) -* [SimpleModManager](simplemodmanager) (Homebrew app) -* [Tesla-Menu](tesla-menu) (sysmodule) -* [MissionControl](mission-control) (sysmodule) -* [sys-con](sys-con)(sysmodule) -* [sys-botbase](sys-botbase) (sysmodule) -* [SysDVR](sysdvr) (sysmodule and Homebrew app) -* [sys-clk](sys-clk) (sysmodule and Homebrew app) -* [ldn_mitm](ldn_mitm) (sysmodule and Homebrew app) diff --git a/docs/homebrew/jksv.md b/docs/homebrew/jksv.md deleted file mode 100644 index 683d94e95..000000000 --- a/docs/homebrew/jksv.md +++ /dev/null @@ -1,268 +0,0 @@ ---- -outline: false ---- - -# Save Management - -## JKSV - -For save data management, [JKSV](https://github.com/J-D-K/JKSV) is recommended. It can be used to back up and restore game save data. - -The documentation on this page was made in collaboration with [JK](https://github.com/J-D-K). - -![](img/jksv.jpg) - -## Section I - Backing up save data using JKSV - -1. Launch JKSV from the homebrew menu. -1. Select your Switch user on the left side with the `A` button. - * **Note:** If you wish to back up all save data at once, simply press `Y` while hovering over your user in the sidebar, then proceed by holding `A`. -1. Hover over your desired game and press `A` to select it. -1. Press `A` again to create a new save backup -1. Enter a name for the save data folder containing the save data and press `+` or `OK`. -1. Wait for it to finish backing up your save data. - -## Section II - Restoring save data using JKSV - -1. Launch JKSV from the homebrew menu. -1. Select your Switch user on the left side with the `A` button. -1. Hover over your desired game and press `A` to select it. -1. Hover over the save data folder containing the save data you want to restore and press `Y`. -1. Hold the `A` button to restore the save data, keep holding it until it's finished. - -## Section III - Setting up remote save data backups (Google Drive & WebDAV) - -::::: tabs - -:::: tab default Google Drive - -JKSV features a functionality that allows you to back up your save data from the JKSV homebrew app directly to Google Drive. The setup for this feature is detailed below. - -**Note:** Throughout this guide, clickable items in screenshots will be highlighted in **red**. - ---- - -### Section I - Creating a new project - -1. Go to [Google Cloud Console](https://console.cloud.google.com/welcome/new) and click `Select a project` (top-left corner). - - ![](img/jksv/select_project.png) - -1. Click **New Project** (top-right). Name it `JKSV`. It's fine to leave `Organization` blank. - - ![](img/jksv/create_project.png) - ![](img/jksv/project_name.png) - -1. Wait for the project to be created, then click `Select Project`. - - ![](img/jksv/select_project2.png) - ---- - -### Section II - Enabling the Google Drive API - -1. Click the `Navigation menu` (top-left) → `APIs & Services` → `Enabled APIs & Services`. - - ![](img/jksv/navigation_menu.png) - ![](img/jksv/enabled_services.png) - -1. Click `+ Enable APIs and services`, scroll to `Google Workspace`, select `Google Drive API`, and click `Enable`. - - ![](img/jksv/enable_services.png) - ![](img/jksv/gdrive_api.png) - ![](img/jksv/enable_gdrive.png) - ---- - -### Section III - Creating OAuth credentials - -1. Go to `Credentials` → `+ Create Credentials` → `OAuth client ID`. - - ![](img/jksv/create_credentials.png) - -1. Click `Configure consent screen`. - - ![](img/jksv/consent_screen.png) - -1. Click `Get started` to start configuring Google Auth Platform. - - ![](img/jksv/auth_platform.png) - -1. Fill in `JKSV` for the app name alongside the user support email (the email of the Google account you're currently using) and click `Next`. - - ![](img/jksv/appinfo.png) - -1. Select `External`, click `Next`. - - ![](img/jksv/audience.png) - ![](img/jksv/audience_external.png) - -1. Fill in your own email into the contact information field and click `Next`. - - ![](img/jksv/contactinfo.png) - -1. Click the checkbox to agree to the `Google API Services: User Data Policy` and click on `Continue`. - - ![](img/jksv/finish.png) - -1. Now, click on `Create` and it will take you back to the overview. Click on `Create OAuth client`. - - ![](img/jksv/finish2.png) - ![](img/jksv/oauth_client.png) - -1. Set the `Application Type` to `TVs and limited input devices`, then set the name for the client (can be anything, the name `JKSV` is used in this guide). - - ![](img/jksv/oauth_client_id.png) - ![](img/jksv/oauth_client_id_type3.png) - ![](img/jksv/oauth_client_id_type1.png) - -1. Click on `Create` and you will end up at the final window for this step, download the JSON file containing the client info for JKSV. - - ::: danger - * **Note:** Google will not allow you to download this file again after this point! - ::: - - ![](img/jksv/oauth_client_id_type2.png) - ![](img/jksv/oauth_client_created2.png) - -1. Rename the downloaded file to `client_secret.json` and store it somewhere safe. - - ![](img/jksv/file_renamed.png) - ---- - -### Section IV - Adding yourself as a test user - -1. Go to `Navigation menu` → `APIs & Services` → `OAuth consent screen` → `Audience`. - -1. Click `+ Add users` and add your email. - - ![](img/jksv/test_users.png) - ![](img/jksv/test_users2.png) - ---- - -### Section V - Copying the .JSON file to your microSD card - -Copy the `client_secret.json` file to: `sd:/config/JKSV`. - ---- - -### Section VI - Launching JKSV - -The next time JKSV starts with an internet connection, it will guide you to complete the login process by navigating to `https://google.com/device` and filling in the code mentioned in the middle of your screen in JKSV. - -After the primary setup for Google Drive, you can launch JKSV with an internet connection again and it will give you a notification near the bottom of your screen stating `Successfully signed in to Google Drive!` if your configuration file was set up correctly. You can now back up and store your save data backups on Google Drive by pressing `Zr` on any save data backup! - ---- - -### Section VII - Optional - Backing up Client Secret - -1. Make a secure backup of `client_secret.json` from your microSD card **after logging in with JKSV**. - * This is recommended if you plan to share saves between multiple consoles due to Google’s OAuth scope policies. - -:::: - -:::: tab WebDAV - -JKSV features a functionality that allows you to back up your save data from the JKSV homebrew app directly to a WebDAV server. The setup for this feature is detailed below. - -Please note that this feature requires you to either sign up for a WebDAV server provider or selfhost your own WebDAV server on your local network. - ---- - -### Section I - Creating and applying the WebDAV configuration file - -1. Create a file named `webdav.json` and paste the following contents in it: - - ```json - { - "origin": "https://example.com", - "basepath": "path/to/JKSV", - "username": "optional", - "password": "optional" - } - ``` - -1. Create a folder named `JKSV` on your WebDAV server. - * **Note:** The folder name doesn't *have* to be called `JKSV`. For the sake of this guide, `JKSV` was used for consistency purposes. - -1. Fill in the `origin`, `basepath`, `username` and `password` fields, the base path is case sensitive and beginning/trailing slashes should be left out in the `origin` and `basepath` fields. Keep the information below in mind. - * The `origin` field should **always** contain the host portion of the WebDAV server you're connecting to. - * The `basepath` field should either contain the absolute path to the location of the WebDAV endpoint + folder created in the previous step or you can use an aliased folder. - * The `username` and `password` fields should contain your credentials you use to authenticate with your WebDAV server. These lines can be left out/removed entirely if you do not have authentication set up for your WebDAV server. - -If you need WebDAV configuration examples, unfold the section below. - -::: details WebDAV configuration examples {closed} - -#### Example I - -Your WebDAV endpoint is hosted on a local server with IP address `192.168.1.100` with the WebDAV endpoint running at `192.168.1.100/webdav`, on which you created the `JKSV` folder. In this example you do not use any authentication. - -```json -{ - "origin": "http://192.168.1.100", - "basepath": "webdav/JKSV", -} -``` - ---- - -#### Example II - -Your WebDAV endpoint is hosted on a WebDAV server provider at `https://app.koofr.net/dav/Koofr`, on which you created the `JKSV` folder. In this example you *do* use authentication. - -```json -{ - "origin": "https://app.koofr.net", - "basepath": "dav/Koofr/JKSV", - "username": "", - "password": "" -} -``` - ---- - -#### Example III - -Your WebDAV endpoint is hosted on a local server with IP address `192.168.1.100` with the WebDAV endpoint running at `192.168.1.100/webdav`, but you have an alias for `192.168.1.100/webdav/JKSV` set up so that your endpoint is available on `192.168.1.100/JKSV`. In this example you *do* use authentication. - -```json -{ - "origin": "http://192.168.1.100", - "basepath": "JKSV", - "username": "", - "password": "" -} -``` - -::: - ---- - -### Section II - Copying the JSON file to your microSD card - -Copy the `webdav.json` file to `sd:/config/JKSV`. - ---- - -### Section III - Launching JKSV - -The next time JKSV starts with an internet connection, it will give you a notification near the bottom of your screen stating `WebDav successfully started!` if your configuration file was set up correctly. - -You can now back up and store your save data backups on your WebDAV server by pressing `Zr` on any save data backup! - -:::: - -::::: - -## Checkpoint - -[Checkpoint](https://github.com/FlagBrew/Checkpoint) is also a save manager. It can be used to back up and restore game saves to your microSD card. It also has the ability to share save data over FTP and WiFi. - -### Checkpoint Documentation - -Please read Checkpoint's [homepage](https://github.com/Flagbrew/Checkpoint) for information on how to use it. - -![ExampleSwitchTheme](../extras/img/save_checkpoint.jpg){ width="600" } diff --git a/docs/homebrew/ldn_mitm.md b/docs/homebrew/ldn_mitm.md deleted file mode 100644 index 4b08e9843..000000000 --- a/docs/homebrew/ldn_mitm.md +++ /dev/null @@ -1,44 +0,0 @@ -# Information - -ldn_mitm is a [sysmodule](index#terminologies) that allows you to route the local wireless ad-hoc network traffic of the Switch via the network your Switch is connected to, essentially allowing "LAN" functionality between consoles and emulators using ldn_mitm. More information can be found on the [ldn_mitm GitHub](https://github.com/spacemeowx2/ldn_mitm) repository. - -::: details Common use cases for ldn_mitm - -* It can be used in combination with [lan-play](http://lan-play.com/install-switch) -* It can be used in combination with [XLink Kai](https://www.teamxlink.co.uk/wiki/Nintendo_Switch_XLink_Kai_Setup) -* It can be used in combination with real Switch consoles and emulators - -::: - -## Section I - Requirements - -* An archive manager like [7-Zip](https://www.7-zip.org/) -* The latest release of [ldn_mitm](https://github.com/DefenderOfHyrule/ldn_mitm/releases) (the `ldn_mitm.zip` file) - -## Section II - Installation - -1. Boot into hekate and go to `Tools` > `USB Tools` > `SD Card`, then plug your Switch into your PC via USB. -1. Your microSD card should now be accessible on your PC, open it. -1. Extract the `.zip` file to a location on your computer. - * If your archive manager allows for it, you can also simply open the `.zip` file directly. -1. Copy the *contents* of the (extracted) `.zip` file to the root of your microSD card. - * **Optional:** You can verify if you've installed ldn_mitm correctly, you should have a folder called `4200000000000010` (ldn_mitm) in `sd:/atmosphere/contents` and the `ldnmitm_config.nro` file in `sd:/switch/ldnmitm_config`. -1. Boot into CFW. - -## Section III - Usage - -You can enable/disable ldn_mitm by opening the Homebrew menu, opening ldn_mitm's config app and pressing `Y` to toggle ldn_mitm. - -![ldn_mitm](img/ldn_mitm.jpg) - -## Section IV - Troubleshooting - -### My Switch crashes on boot after I installed ldn_mitm! - -**Cause:** If your Switch crashes with Error `std::abort (0xFFE)` and Title ID `4200000000000010`, you're using a version of ldn_mitm that's incompatible with your Atmosphère version. The expected Atmosphère version is mentioned on each release page of an ldn_mitm release. - -### ldn_mitm isn't working! - -Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via hekate for all files. - -This can be done by booting into hekate and going to `Tools` > `Arch bit • RCM Touch • Pkg1/2` > `Fix Archive Bit`. diff --git a/docs/homebrew/mission-control.md b/docs/homebrew/mission-control.md deleted file mode 100644 index 1d633c524..000000000 --- a/docs/homebrew/mission-control.md +++ /dev/null @@ -1,30 +0,0 @@ -# MissionControl - -MissionControl is a [sysmodule](index#terminologies) that allows you to pair normally-unsupported controllers as if they were natively supported, like PS3, PS4, PS5 and Xbox One S/X controllers via Bluetooth. The full supported controller list can be found on the [MissionControl GitHub](https://github.com/ndeadly/MissionControl) repository, including pairing instructions for the supported controllers. - -## Section I - Requirements - -* An archive manager like [7-Zip](https://www.7-zip.org/) -* The latest release of [MissionControl](https://github.com/ndeadly/MissionControl/releases) (the `MissionControl-(version)-master.zip` file) - -## Section II - Installation - -1. Boot into hekate and go to `Tools` > `USB Tools` > `SD Card`, then plug your Switch into your PC via USB. -1. Your microSD card should now be accessible on your PC, open it. -1. Extract the `.zip` file to a location on your computer. - * If your archive manager allows for it, you can also simply open the `.zip` file directly. -1. Copy the *contents* of the (extracted) `.zip` file to the root of your microSD card. - * **Optional:** You can verify if you've installed MissionControl correctly, you should have a folder called `010000000000BD00` (MissionControl) in `sd:/atmosphere/contents`. -1. Boot into CFW. - -## Section III - Troubleshooting - -### My Switch crashes on boot after I installed MissionControl! - -**Cause:** If your Switch crashes with Error `std::abort (0xFFE)` and Title ID `010000000000BD00`, you're using a version of MissionControl that's incompatible with your Atmosphère version. The expected Atmosphère version is mentioned on each release page of a MissionControl release. - -### MissionControl isn't working! - -Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via hekate for all files. - -This can be done by booting into hekate and going to `Tools` > `Arch bit • RCM Touch • Pkg1/2` > `Fix Archive Bit`. diff --git a/docs/homebrew/nx-shell.md b/docs/homebrew/nx-shell.md deleted file mode 100644 index 1582020cd..000000000 --- a/docs/homebrew/nx-shell.md +++ /dev/null @@ -1,23 +0,0 @@ -# NX-Shell - -NX-Shell is a file manager. - -::: details Common use cases for NX-Shell - -* Copying files -* Moving files -* Deleting files -* View properties of files and folders -* Create new folders -* Create new files -* Set the archive bit on files and folders - -::: - -More information can be found on the [NX-Shell GitHub](https://github.com/DefenderOfHyrule/NX-Shell/) repository. - -## NX-Shell screenshots - -![nx-shell-main](img/nx-shell-main.jpg) - -![nx-shell-menu](img/nx-shell-menu.jpg) diff --git a/docs/homebrew/nxtheme-installer.md b/docs/homebrew/nxtheme-installer.md deleted file mode 100644 index d0719c0db..000000000 --- a/docs/homebrew/nxtheme-installer.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -outline: false ---- - -# Theming with NXTheme Installer - -Using NXTheme Installer, you can install and create unique styles and layouts for your Switch Home Menu. - -::: tip - -See the below for this page's theming guides. - -* Follow the [Installing a Theme](#section-ii---installing-a-theme) section if you want to install a theme. -* Follow the [Installing a Custom Font](#section-iii---installing-a-custom-font) section if you want to install a custom font. -* Follow the [Creating a Theme](#optional---creating-a-theme) section if you would like to create a theme manually. -* If you run into any issues, visit the [Troubleshooting](#section-iv---troubleshooting) section. - -::: - -## Section I - Requirements - -* The latest release of [NXThemes Installer](https://github.com/exelix11/SwitchThemeInjector/releases) - -## Section II - Installing a Theme - -::: tip - -**Community Themes** - -If you want to use community made themes, for example from the [r/NXThemes](https://www.reddit.com/r/NXThemes/) subreddit or [Themezer](https://themezer.net), you can follow the instructions below to install a community provided `.nxtheme` file. - -::: - -1. Download `NXThemesInstaller.nro` and put it in `sd:/switch`. -1. Copy the `.nxtheme` files to the `themes` folder on your microSD card (It is recommended you put them into their own folders, e.g. `sd:/themes/awesome_theme/awesome.nxtheme`). - * Create the `themes` folder on the root of your microSD card if it does not exist. -1. Boot into sysCFW/emuMMC and launch the Homebrew Menu, then launch `NXThemes Installer` *with* an internet connection. - * NXTheme Installer will automatically download the required theme patches if it has a connection to the internet. These theme patches are required for themes to work. - * If you don't want to or don't have the ability connect to a Wi-Fi network, installing the theme patches can be done manually. - * See instructions on the [Theme Patches GitHub](https://github.com/exelix11/theme-patches#if-you-dont-want-to-connect-your-console-to-the-internet) page on how to install them manually. -1. If you get prompted about extracting your home menu data, do so. - * You can always do this manually via the `Extract home menu` tab in `NXTheme Installer`. -1. You should now see the main menu of `NXTheme Installer`, the `Themes` tab is where you will find your themes. To install them, press the folder name of your theme and go through each home menu section to install the desired theme for that section (e.g. going to `/awesome_theme` and selecting your theme for the specific menu you want to change, do the same for the other menus). -1. Reboot into CFW via the `Reboot` tab to see the changes. - -::: tip - -**An example of a Home Menu theme being installed** - -![ExampleSwitchTheme](../extras/img/switch_theming.jpg) - -::: - -## Section III - Installing a Custom Font - -1. Put a font with the `.ttf` file type into the `themes` folder (It is recommended you put them into their own folders, e.g. `sd:/themes/cool_font/font.ttf`). -1. Boot into sysCFW/emuMMC, launch the Homebrew Menu and launch `NXThemes Installer`. -1. You should now see the main menu of `NXTheme Installer`, the `Themes` tab is where you will find your font(s). -1. Install your desired font by selecting the `.ttf` file in the font folder you created. -1. Reboot into CFW via the `Reboot` tab to see the changes. - -## Section IV - Troubleshooting - -### My Switch crashes on boot after I installed a theme! - -**Cause 1:** You didn't install the required theme patches for your firmware version. You can remove your installed custom theme data by navigating to `sd:/atmosphere/contents` and deleting the `01000000000001000` folder. - -**Cause 2:** You didn't extract your home menu data when prompted. You can remove your installed custom theme data by navigating to `sd:/atmosphere/contents` and deleting the `01000000000001000` folder. - -**Cause 3:** You installed a bad theme. You can remove them by navigating to `sd:/atmosphere/contents` and deleting the `01000000000001000` folder. - -* **Note:** `contents` is called `titles` on Atmosphère versions 0.9.4 and below. - -### My Switch crashes on boot after I installed a font! - -**Cause 1:** You installed a font that was too large in file size (maximum file size being 1.9MB). You can remove your installed custom font data by navigating to `sd:/atmosphere/contents` and deleting the `0100000000000811` folder. - -**Cause 2:** You installed a font that wasn't the right file type (e.g. `.otf`). You can remove your installed custom font data by navigating to `sd:/atmosphere/contents` and deleting the `0100000000000811` folder. - -* **Note:** `contents` is called `titles` on Atmosphère versions 0.9.4 and below. - -### The NXTheme installer crashes when I launch it! - -This is probably due to the archive bit being set on either the app or the `.nxtheme` files. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via hekate for all files. - -This can be done by booting into hekate and going to `Tools` > `Arch bit • RCM Touch • Pkg1/2` > `Fix Archive Bit`. - -## Optional - Creating a Theme - -::::: tabs - -:::: tab default All operating systems - -### Creating the Theme - -1. Navigate to [**Themezer's NXTheme creation tool**](https://themezer.net/create/switch/theme). -1. Select a menu, a layout and/or a background (make sure it is at least `1280x720` and a JPG), and any other assets you want in your theme. -1. Enter details like the name and tags, then click `Download .nxtheme`. -1. Your browser will prompt you to download a file. Save this file to a temporary folder. -1. Repeat step 2 to 4 for every menu of the Switch you want to modify. -1. If you've tried them out and are happy, click `Upload`! - -:::: - -:::: tab Windows - -### Section I - Requirements - -The latest release of [**Switch Theme Injector**](https://github.com/exelix11/SwitchThemeInjector/releases) - -* You need to download the `ReleaseVx.x.zip` on the download page. - -### Section II - Creating the Theme - -1. Unzip `ReleaseVx.x.zip` to somewhere on your PC's drive. -1. Open up the `SwitchThemes.exe` app. Navigate to `NXTheme Builder`. -1. Select a Home menu part, A 720p image and a Layout patch. Click on `Build NXTheme` after selecting your home menu part, image and layout patch. -1. Fill out the details in the window that pops up. After filling out this window and clicking ok, you will get asked where to save the NXTheme file. Save this file to a temporary folder. -1. Repeat step 3 and 4 for every Home Menu part of the Switch you want to modify. - -:::: - -::::: diff --git a/docs/homebrew/simplemodmanager.md b/docs/homebrew/simplemodmanager.md deleted file mode 100644 index 313de694d..000000000 --- a/docs/homebrew/simplemodmanager.md +++ /dev/null @@ -1,39 +0,0 @@ -# SimpleModManager - -SimpleModManager is a [homebrew app](index#terminologies) that allows easily adding and removing mods to the layeredFS directory from another directory on the SD card. More information can be found on the [SimpleModManager GitHub](https://github.com/nadrino/SimpleModManager) repository. - -::: details 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. - -::: - -## Section I - Requirements - -* The latest release of [SimpleModManager](https://github.com/DefenderOfHyrule/SimpleModManager/releases/tag/v2.1.4) (the `SimpleModManager.nro` file) - -## Section II - Installation - -1. Boot into hekate and go to `Tools` > `USB Tools` > `SD Card`, then plug your Switch into your PC via USB. -1. Your microSD card should now be accessible on your PC, open it. -1. Copy the `SimpleModManager.nro` file the `/switch/` folder on your microSD card. -1. Boot into CFW. - -## Section III - Usage - -1. Create a directory named `mods///` on the root of the microSD card. - * What you put for the mod name does not have to align with anything, put whatever you like! -1. Create the layeredFS directory for your mod that can be found on the [Game Modding](../extras/game_modding) page, skipping the `atmosphere` folder inside the `` folder. -1. 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" } diff --git a/docs/homebrew/sys-botbase.md b/docs/homebrew/sys-botbase.md deleted file mode 100644 index 6508ebbd0..000000000 --- a/docs/homebrew/sys-botbase.md +++ /dev/null @@ -1,40 +0,0 @@ -# sys-botbase - -sys-botbase is an advanced [sysmodule](index#terminologies) that allows users to interact with their Switch remotely, to "remote control" their Switch. This remote control allows users to create automated tasks, simulate button presses, simulate touchscreen input and read/write to the memory of the Switch while in-game. - -::: details Common use cases for sys-botbase: - -* Use ACNHPokerCore in combination with ACNH -* Controlling a game remotely -* Automation - -::: - -## Section I - Requirements - -* An archive manager like [7-Zip](https://www.7-zip.org/) -* The latest release of [sys-botbase](https://github.com/olliz0r/sys-botbase/releases) (the `sys-botbase(version).zip` file) - -## Section II - Installation - -1. Boot into hekate and go to `Tools` > `USB Tools` > `SD Card`, then plug your Switch into your PC via USB. -1. Your microSD card should now be accessible on your PC, open it. -1. Extract the `.zip` file to a location on your computer. - * If your archive manager allows for it, you can also simply open the `.zip` file directly. -1. Copy the *contents* of each (extracted) `.zip` file to the root of your microSD card. - * **Optional:** You can verify if you've installed sys-botbase correctly, you should have a folder called `430000000000000B` (sys-botbase) in `sd:/atmosphere/contents`. -1. Boot into CFW. - -## Section III - Troubleshooting - -### My Switch crashes on boot after I installed sys-botbase! - -**Cause:** While it's almost impossible for this to happen, if your Switch crashes with Error `2001-0123 (0xf601)` and Title ID `430000000000000B`, you're using a version of sys-botbase that's incompatible with your Atmosphère version. - -* **Note:** sys-botbase will almost never crash unless something is fundamentally wrong with the contents of your microSD card. If it does crash and need an update, an updated release will be mentioned here. - -### sys-botbase isn't working! - -Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via hekate for all files. - -This can be done by booting into hekate and going to `Tools` > `Arch bit • RCM Touch • Pkg1/2` > `Fix Archive Bit`. diff --git a/docs/homebrew/sys-clk.md b/docs/homebrew/sys-clk.md deleted file mode 100644 index 76ef3a415..000000000 --- a/docs/homebrew/sys-clk.md +++ /dev/null @@ -1,46 +0,0 @@ -# sys-clk - -sys-clk is a [sysmodule](index#terminologies) that allows you to overclock the hardware of your Switch. The usage, configuration and clock speed information can be found on the [sys-clk Github](https://github.com/retronx-team/sys-clk) repository. - -::: danger - -**Limits of sys-clk** - -sys-clk has limits for a reason, which is to not damage the hardware of your Switch. Using ***any*** modified version of sys-clk puts your Switch at risk of hardware failure. We do not support any modified version of sys-clk nor should you ever touch them. Overclocking is not something you should be doing 24/7 as overclocking in general will always degrade/wear out the hardware of your Switch faster and you should know what you're doing if you *do* decide to do so. - -::: - -## Section I - Requirements - -* An archive manager like [7-Zip](https://www.7-zip.org/) -* The latest release of [sys-clk](https://github.com/retronx-team/sys-clk/releases) (the `sys-clk-(version).zip` file) - -## Section II - Installation - -1. Boot into hekate and go to `Tools` > `USB Tools` > `SD Card`, then plug your Switch into your PC via USB. -1. Your microSD card should now be accessible on your PC, open it. -1. Extract the `.zip` file to a location on your computer. - * If your archive manager allows for it, you can also simply open the `.zip` file directly. -1. Copy the *contents* of the (extracted) `.zip` file to the root of your microSD card. - * **Optional:** You can verify if you've installed sys-clk correctly, you should have a folder called `00FF0000636C6BFF` (sys-clk) in `sd:/atmosphere/contents`. -1. Boot into CFW. - -## Section III - Usage - -Open the Homebrew menu and open sys-clk's manager app. This app allows you to change the global clock speeds or clock speeds based on title. - -## Section IV - Troubleshooting - -### My Switch crashes on boot after I installed sys-clk! - -**Cause:** If your Switch crashes on boot, make sure you're using the latest release of sys-clk. If it continues to crash afterwards, see the troubleshooting step at the bottom of this page. - -### My Switch crashes while using sys-clk! - -**Cause:** You're either using a modified version of sys-clk and pushing the hardware of your Switch too far or your console is overheating. The cooling system of the Switch is *not* the best and overheating can be a cause of dried up thermal paste/lack of thermal paste. Overclock with caution and be careful, monitor the temperatures of your Switch using a Tesla-Menu overlay like [Status-Monitor-Overlay](https://github.com/masagrator/Status-Monitor-Overlay) (requires Tesla-Menu). - -### sys-clk isn't working! - -Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via hekate for all files. - -This can be done by booting into hekate and going to `Tools` > `Arch bit • RCM Touch • Pkg1/2` > `Fix Archive Bit`. diff --git a/docs/homebrew/sys-con.md b/docs/homebrew/sys-con.md deleted file mode 100644 index f2ee5d1c3..000000000 --- a/docs/homebrew/sys-con.md +++ /dev/null @@ -1,32 +0,0 @@ -# sys-con - -sys-con is a [sysmodule](index#terminologies) that allows you to use normally-unsupported controllers as if they were natively supported, like PS3, PS4, PS5 and Xbox One S/X controllers via USB. The full supported feature and controller list can be found on the [sys-con Github](https://github.com/o0Zz/sys-con) repository, including usage instructions and configuration options. - -## Section I - Requirements - -* An archive manager like [7-Zip](https://www.7-zip.org/) -* The latest release of [sys-con](https://github.com/o0Zz/sys-con/releases) (the `sys-con-(version).zip` file) - -## Section II - Installation - -1. Boot into hekate and go to `Tools` > `USB Tools` > `SD Card`, then plug your Switch into your PC via USB. -1. Your microSD card should now be accessible on your PC, open it. -1. Extract the `.zip` file to a location on your computer. - * If your archive manager allows for it, you can also simply open the `.zip` file directly. -1. Copy the *contents* of the (extracted) `.zip` file to the root of your microSD card. - * **Optional:** You can verify if you've installed sys-con correctly, you should have a folder called `690000000000000D` (sys-con) in `sd:/atmosphere/contents`. -1. Boot into CFW. - -## Section III - Troubleshooting - -### My Switch crashes on boot after I installed sys-con! - -**Cause:** While it's almost impossible for this to happen, if your Switch crashes with Error code `2162-0002 (0x4a2)` and Title ID `690000000000000D`, you're using a version of sys-con that's incompatible with your Switch firmware version. The expected firmware version is mentioned on each release page of a sys-con release. - -* **Note:** sys-con hasn't needed an update for years as of the moment of writing this. If it does need an update, an updated release will be mentioned here. - -### sys-con isn't working! - -Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via hekate for all files. - -This can be done by booting into hekate and going to `Tools` > `Arch bit • RCM Touch • Pkg1/2` > `Fix Archive Bit`. diff --git a/docs/homebrew/sysdvr.md b/docs/homebrew/sysdvr.md deleted file mode 100644 index 233efa23f..000000000 --- a/docs/homebrew/sysdvr.md +++ /dev/null @@ -1,15 +0,0 @@ -# SysDVR - -SysDVR is a [sysmodule](index#terminologies) that allows you to stream the screen of your Switch (while in-game/in an application) to your PC via the network or USB. - -## Usage - -Installation, usage, configuration and extensive troubleshooting information can be found on the [SysDVR GitHub wiki](https://github.com/exelix11/SysDVR/wiki). - -## SysDVR screenshots - -![sysdvr](img/sysdvr1.png) - -![sysdvr](img/sysdvr2.png) - -![sysdvr](img/sysdvr3.png) diff --git a/docs/homebrew/tesla-menu.md b/docs/homebrew/tesla-menu.md deleted file mode 100644 index d36ea8cab..000000000 --- a/docs/homebrew/tesla-menu.md +++ /dev/null @@ -1,93 +0,0 @@ -# Tesla-Menu - -Tesla-Menu is an overlay menu developed by [WerWolv](https://github.com/WerWolv), Tesla-Menu is comparable to Rosalina menu on the 3DS and its purpose is to be able to load community made overlays for Homebrew apps and sysmodules that can be accessed at any time. Below you can find common use cases for Tesla-Menu. More information can be found on the [Tesla-Menu GitHub](https://github.com/WerWolv/Tesla-Menu) repository. - -::: tip - -**Dependencies** - -Tesla-Menu is dependent on a [sysmodule](index#terminologies) called `nx-ovlloader`, this sysmodule is responsible for loading `ovlmenu.ovl` from `sd:/switch/.overlays`. - -::: - -::: details Common use cases for Tesla-Menu - -* Load community made Tesla-Menu overlays -* Viewing the temperatures/clock speeds of your hardware -* Editing sysmodule configs on the fly (if applicable) -* Editing Homebrew app configs on the fly (if applicable) -* Toggling cheats easily -* Toggling sysmodules - -::: - -## Section I - Requirements - -* An archive manager like [7-Zip](https://www.7-zip.org/) -* The latest release of [Tesla-Menu](https://github.com/DefenderOfHyrule/Tesla-Menu/releases/tag/v1.2.0) (the `ovlmenu.ovl` file) -* The latest release of [nx-ovlloader](https://github.com/DefenderOfHyrule/nx-ovlloader/releases/tag/v1.2.0) (the `nx-ovlloader.zip` file) - -## Section II - Installation - -1. Boot into hekate and go to `Tools` > `USB Tools` > `SD Card`, then plug your Switch into your PC via USB. -1. Your microSD card should now be accessible on your PC, open it. -1. Extract the nx-ovlloader `.zip` file to a location on your computer. - * If your archive manager allows for it, you can also simply open the `.zip` file directly. -1. Copy the *contents* of the (extracted) `.zip` file to the root of your microSD card, then copy `ovlmenu.ovl` to `sd:/switch/.overlays`. - * **Optional:** You can verify if you've installed Tesla-Menu and nx-ovlloader correctly, you should have a folder called `420000000007E51A` (nx-ovlloader) in `sd:/atmosphere/contents` and the `ovlmenu.ovl` (Tesla-Menu) file in `sd:/switch/.overlays`. -1. Boot into CFW. - -## Section III - Usage - -Tesla-Menu can be opened by pressing `L` + `R Stick press (R3)` + `DPAD down`, assuming you use the default configuration. - -![tesla](img/tesla-menu.jpg) - -### Changing the button combination - -If you wish to change the default button configuration, see the instructions below: - -1. Navigate to `sd:/config` on your microSD card. -1. Create a folder named `tesla` if it doesn't exist already. -1. Create a file named `config.ini` in `sd:/config/tesla`. -1. Paste the following text inside of `config.ini`: - - ```ini - [tesla] - key_combo=L+R+RS - # A, B, X, Y, LS, RS, L, R, ZL, ZR, PLUS, MINUS, DLEFT, DUP, DRIGHT, DDOWN, SL, SR - ``` - -1. Change the `key_combo` value to anything you desire and save the file. The accepted inputs are mentioned on the third line. - -### Commonly used Tesla-Menu overlays - -* [Status-Monitor-Overlay](https://github.com/masagrator/Status-Monitor-Overlay) -* [EdiZon overlay](https://github.com/proferabg/EdiZon-Overlay) -* [QuickNTP](https://github.com/nedex/QuickNTP) -* [Emuiibo](https://github.com/XorTroll/emuiibo) (this requires you to also install the Emuiibo sysmodule) -* [TriPlayer](https://github.com/DefenderOfHyrule/TriPlayer) (this requires you to also install the TriPlayer sysmodule) -* [ldn_mitm](https://github.com/DefenderOfHyrule/ldn_mitm) (this requires you to also install the ldn_mitm sysmodule) -* [Fizeau](https://github.com/averne/Fizeau) (this requires you to also install the Fizeau sysmodule) - -## Section IV - Troubleshooting - -### My Switch crashes on boot after I installed Tesla-Menu/nx-ovlloader! - -**Cause:** If your Switch crashes with Error code `2001-0123 (0xf601)` and Title ID `420000000007E51A`, you didn't successfully install Tesla-Menu or you aren't using the latest release of Tesla-Menu, re-follow the installation instructions above. - -### My Switch crashes when I open an overlay via Tesla-Menu! - -**Cause:** If your Switch crashes with Error code `2001-0123 (0xf601)` and Title ID `420000000007E51A`, the overlay you're trying to open/use isn't up to date. Check its source repository for updates. - -* If this overlay doesn't have an updated release, you may have to look for a forked (updated) release or compile it yourself using the latest `libtesla` library. The latter is for developers (or advanced users). - -### Tesla-Menu is only showing while on the main menu and not in-game! - -**Cause:** This issue will only happen when the Switch is docked, ensure that you've set the "Screen size" in `System Settings` > `TV Output` to 100%. Adjust your TV/monitor to fit the entirety of the screen of your Switch using its OSD (On Screen Display) or remote. - -### Tesla-Menu isn't opening when I press the correct button combination! - -Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via hekate for all files. - -This can be done by booting into hekate and going to `Tools` > `Arch bit • RCM Touch • Pkg1/2` > `Fix Archive Bit`.