From 61992c411fa229fa2b60f13b4600d1975d2f516f Mon Sep 17 00:00:00 2001 From: Ash Logan Date: Sat, 8 Apr 2023 23:59:41 +1000 Subject: [PATCH] chore(docs): Add Martini error codes and update Juxt docs for new Inkay build --- docs/common/errorList.json | 15 ++++ docs/en_US/errors/JXT-598-0069.md | 34 ++++++++++ docs/en_US/errors/MRTI-678-1001.md | 12 ++++ docs/en_US/errors/MRTI-678-1002.md | 10 +++ docs/en_US/errors/MRTI-678-1003.md | 12 ++++ docs/en_US/errors/MRTI-678-1004.md | 13 ++++ docs/en_US/errors/MRTI-678-1005.md | 24 +++++++ docs/en_US/errors/MRTI-678-1006.md | 26 +++++++ docs/en_US/errors/MRTI-678-1007.md | 14 ++++ docs/en_US/errors/MRTI-678-1008.md | 11 +++ docs/en_US/errors/MRTI-678-1009.md | 11 +++ docs/en_US/errors/MRTI-678-1010.md | 23 +++++++ docs/en_US/errors/MRTI-678-1011.md | 24 +++++++ docs/en_US/errors/MRTI-678-1013.md | 12 ++++ docs/en_US/install/juxt.md | 18 ++--- docs/en_US/install/wiiu.md | 94 ++++++++++++++------------ views/partials/docs-sidebar.handlebars | 1 + 17 files changed, 303 insertions(+), 51 deletions(-) create mode 100644 docs/en_US/errors/JXT-598-0069.md create mode 100644 docs/en_US/errors/MRTI-678-1001.md create mode 100644 docs/en_US/errors/MRTI-678-1002.md create mode 100644 docs/en_US/errors/MRTI-678-1003.md create mode 100644 docs/en_US/errors/MRTI-678-1004.md create mode 100644 docs/en_US/errors/MRTI-678-1005.md create mode 100644 docs/en_US/errors/MRTI-678-1006.md create mode 100644 docs/en_US/errors/MRTI-678-1007.md create mode 100644 docs/en_US/errors/MRTI-678-1008.md create mode 100644 docs/en_US/errors/MRTI-678-1009.md create mode 100644 docs/en_US/errors/MRTI-678-1010.md create mode 100644 docs/en_US/errors/MRTI-678-1011.md create mode 100644 docs/en_US/errors/MRTI-678-1013.md diff --git a/docs/common/errorList.json b/docs/common/errorList.json index 3aaf3c9..6afc545 100644 --- a/docs/common/errorList.json +++ b/docs/common/errorList.json @@ -4,6 +4,7 @@ "JXT-598-0010", "JXT-598-0011", "JXT-598-0020", + "JXT-598-0069", "SYS-015-2004", "SYS-015-5001", "SYS-015-5002", @@ -22,5 +23,19 @@ "SYS-115-5006", "SYS-115-5007", "SYS-115-5015" + ], + "martini": [ + "MRTI-678-1001", + "MRTI-678-1002", + "MRTI-678-1003", + "MRTI-678-1004", + "MRTI-678-1005", + "MRTI-678-1006", + "MRTI-678-1007", + "MRTI-678-1008", + "MRTI-678-1009", + "MRTI-678-1010", + "MRTI-678-1011", + "MRTI-678-1013" ] } diff --git a/docs/en_US/errors/JXT-598-0069.md b/docs/en_US/errors/JXT-598-0069.md new file mode 100644 index 0000000..42fc040 --- /dev/null +++ b/docs/en_US/errors/JXT-598-0069.md @@ -0,0 +1,34 @@ +# Error Code: 598-0069 +**Applies to:** Wii U + +--- + +You have the legacy Martini patches installed into your Miiverse applet. The current version of the Pretendo patchers have a safer version of these patches, so the older ones must be uninstalled. + +Navigate to the [releases](https://github.com/PretendoNetwork/Martini/releases) page on the Martini GitHub repository + + + +Select the `martini-juxt-patcher.rpx` to download it + + + +Copy `martini-juxt-patcher.rpx` and place it on your SD card at `sd:/wiiu/apps/` + + + +Place your SD card back into your console and boot like normal. + +Open the Homebrew Launcher and launch `martini-juxt-patcher.rpx` or select it from the Wii U Menu (Aroma) + + + +After confirming the state of the Miiverse applet, press X to remove the patches. + + + +Once the patcher is done running and your console has rebooted, you're done! Have fun in Juxt! + + + +If you encountered any errors, try [searching](/docs/search) for the error code. If that doesn't work, get in touch with a developer in our [Discord](https://discord.gg/pretendo). diff --git a/docs/en_US/errors/MRTI-678-1001.md b/docs/en_US/errors/MRTI-678-1001.md new file mode 100644 index 0000000..6068f05 --- /dev/null +++ b/docs/en_US/errors/MRTI-678-1001.md @@ -0,0 +1,12 @@ +# Error Code: 678-1001 +**Applies to:** Wii U + +--- + +***Note:*** This error relates to the Martini patches, which are now deprecated. + +The console's CFW is not compatible with Pretendo's patcher. If you are using Haxchi, Coldboot Haxchi, Indexiine, +Browserhax or similar, please [upgrade to Tiramisu or Aroma](https://wiiu.hacks.guide) and try again. + +If you're sure you're using Tiramisu or Aroma, reboot the console and try again. If the same error occurs, get in touch +with a developer in our [Discord](https://discord.gg/pretendo). diff --git a/docs/en_US/errors/MRTI-678-1002.md b/docs/en_US/errors/MRTI-678-1002.md new file mode 100644 index 0000000..a27c495 --- /dev/null +++ b/docs/en_US/errors/MRTI-678-1002.md @@ -0,0 +1,10 @@ +# Error Code: 678-1002 +**Applies to:** Wii U + +--- + +***Note:*** This error relates to the Martini patches, which are now deprecated. + +The patcher could not find a Miiverse applet installed on your console, or you have several Miiverses installed. If this +is the case, get in touch with a developer in our [Discord](https://discord.gg/pretendo) - we'd love to know what kind +of devkit you have! diff --git a/docs/en_US/errors/MRTI-678-1003.md b/docs/en_US/errors/MRTI-678-1003.md new file mode 100644 index 0000000..73b4853 --- /dev/null +++ b/docs/en_US/errors/MRTI-678-1003.md @@ -0,0 +1,12 @@ +# Error Code: 678-1003 +**Applies to:** Wii U + +--- + +***Note:*** This error relates to the Martini patches, which are now deprecated. + +The console's CFW is not compatible with Pretendo's patcher. If you are using Haxchi, Coldboot Haxchi, Indexiine, +Browserhax or similar, please [upgrade to Tiramisu or Aroma](https://wiiu.hacks.guide) and try again. + +If you're sure you're using Tiramisu or Aroma, reboot the console and try again. If the same error occurs, get in touch +with a developer in our [Discord](https://discord.gg/pretendo). diff --git a/docs/en_US/errors/MRTI-678-1004.md b/docs/en_US/errors/MRTI-678-1004.md new file mode 100644 index 0000000..f73a3e2 --- /dev/null +++ b/docs/en_US/errors/MRTI-678-1004.md @@ -0,0 +1,13 @@ +# Error Code: 678-1004 +**Applies to:** Wii U + +--- + +***Note:*** This error relates to the Martini patches, which are now deprecated. + +The console's CFW is not compatible with Pretendo's patcher. Try rebooting the console. If you are using Haxchi, +Coldboot Haxchi, Indexiine, Browserhax or similar, please [upgrade to Tiramisu or Aroma](https://wiiu.hacks.guide) and +try again. + +If you're sure you're using Tiramisu or Aroma and rebooting didn't fix it, get in touch with a developer in our +[Discord](https://discord.gg/pretendo). diff --git a/docs/en_US/errors/MRTI-678-1005.md b/docs/en_US/errors/MRTI-678-1005.md new file mode 100644 index 0000000..c7bf161 --- /dev/null +++ b/docs/en_US/errors/MRTI-678-1005.md @@ -0,0 +1,24 @@ +# Error Code: 678-1005 +**Applies to:** Wii U + +--- + +***Note:*** This error relates to the Martini patches, which are now deprecated. + +The patcher could not find an unmodified copy of the Miiverse applet. Either you have manually modified it, it has +become corrupted, or you have a version too old or too new for the patcher to recognise. + +- If you are on a system version older than 5.1.0, perform a system update, install + [Tiramisu or Aroma](https://wiiu.hacks.guide), and try again. +- Try disabling any content replacement plugins (SDCafiine etc.) that can change which files are read by the patcher. +- If you have manually modified your Miiverse applet, reinstall a clean copy from a backup. Instructions for this + cannot be provided by Pretendo. + +If all of these failed, get in touch on our [Discord](https://discord.gg/pretendo). + +--- + +Compatible Miiverse applet versions: + - `000500301001600A v113` (JPN 5.1.0 - 5.5.6) + - `000500301001610A v113` (USA 5.1.0 - 5.5.6) + - `000500301001620A v113` (EUR 5.1.0 - 5.5.6) diff --git a/docs/en_US/errors/MRTI-678-1006.md b/docs/en_US/errors/MRTI-678-1006.md new file mode 100644 index 0000000..047a68d --- /dev/null +++ b/docs/en_US/errors/MRTI-678-1006.md @@ -0,0 +1,26 @@ +# Error Code: 678-1006 +**Applies to:** Wii U + +--- + +***Note:*** This error relates to the Martini patches, which are now deprecated. + +The patcher could not find an unmodified copy of the Thwate Premium SSL certificate. Either you have manually replaced +your SSL certificates, they have become corrupted, or your system version is too old or too new for the patcher to +recognise. + +- If you are on a system version older than 5.5.3, perform a system update, install + [Tiramisu or Aroma](https://wiiu.hacks.guide), and try again. +- Try disabling any content replacement plugins (SDCafiine etc.) that can change which files are read by the patcher. +- If you have manually modified your SSL certificates - such as when using a proxy - reinstall a clean copy from a + backup. Instructions for this cannot be provided by Pretendo. + +If all of these failed, get in touch on our [Discord](https://discord.gg/pretendo). + +--- + +Compatible SSL certificate versions: +- `0005001B10054000 v32` (ALL 5.5.3 - 5.5.6) + +`v20` (ALL 5.0.0 - 5.5.2) may also be compatible, but this is unconfirmed. Let us know on +[Discord](https://discord.gg/pretendo) if it works for you. diff --git a/docs/en_US/errors/MRTI-678-1007.md b/docs/en_US/errors/MRTI-678-1007.md new file mode 100644 index 0000000..0cb70db --- /dev/null +++ b/docs/en_US/errors/MRTI-678-1007.md @@ -0,0 +1,14 @@ +# Error Code: 678-1007 +**Applies to:** Wii U + +--- + +***Note:*** This error relates to the Martini patches, which are now deprecated. + +The patcher failed to write out a backup of your Miiverse applet to NAND. This can be caused by an incompatible CFW or +corrupted NAND. + +Try updating to the [latest Tiramisu](https://tiramisu.foryour.cafe) or +[latest Aroma](https://aroma.foryour.cafe) build, as these often contain fixes to the CFW. + +If the issue persists, get in touch in our [Discord](https://discord.gg/pretendo). diff --git a/docs/en_US/errors/MRTI-678-1008.md b/docs/en_US/errors/MRTI-678-1008.md new file mode 100644 index 0000000..9dffb8c --- /dev/null +++ b/docs/en_US/errors/MRTI-678-1008.md @@ -0,0 +1,11 @@ +# Error Code: 678-1008 +**Applies to:** Wii U + +--- + +***Note:*** This error relates to the Martini patches, which are now deprecated. + +The patcher failed to create a patched version of a file. The original file has not been modified. + +Reboot your console and try again. If the issue persists, this is most likely a bug in the Martini patcher - please get +in touch with a developer on our [Discord](https://discord.gg/pretendo). diff --git a/docs/en_US/errors/MRTI-678-1009.md b/docs/en_US/errors/MRTI-678-1009.md new file mode 100644 index 0000000..2c8337a --- /dev/null +++ b/docs/en_US/errors/MRTI-678-1009.md @@ -0,0 +1,11 @@ +# Error Code: 678-1009 +**Applies to:** Wii U + +--- + +***Note:*** This error relates to the Martini patches, which are now deprecated. + +The patcher failed to create a patched version of a file. The original file has not been modified. + +Reboot your console and try again. If the issue persists, this is most likely a bug in the Martini patcher - please get +in touch with a developer on our [Discord](https://discord.gg/pretendo). diff --git a/docs/en_US/errors/MRTI-678-1010.md b/docs/en_US/errors/MRTI-678-1010.md new file mode 100644 index 0000000..9533d77 --- /dev/null +++ b/docs/en_US/errors/MRTI-678-1010.md @@ -0,0 +1,23 @@ +# Error Code: 678-1010 +**Applies to:** Wii U + +--- + +***Note:*** This error relates to the Martini patches, which are now deprecated. + + + +The patcher encountered an error when applying the patched files to your system. Files on your NAND have been modified +and your system is in an unknown state, though there should be no risk of bricking. + +
+⚠️ Do not reboot your console, return to the Wii U Menu or open the Miiverse applet. If you're uncomfortable +diagnosing the issue yourself, reach out on our Discord. +
+ +If you know what `udplogserver` is, start it now and save the output. Press HOME to exit the Martini patcher, then +immediately open it again. If you see an error code, view its [documentation page](/docs/search), but remember not to +reboot your console until the system is in a known state again. If, instead, you progress to the confirmation page, and +you have the option to uninstall patches by pressing X, you may do so. If you are not given the option to uninstall any +patches, reach out on our [Discord](https://discord.gg/pretendo), and include a photo of the confirmation screen. diff --git a/docs/en_US/errors/MRTI-678-1011.md b/docs/en_US/errors/MRTI-678-1011.md new file mode 100644 index 0000000..8b93c8c --- /dev/null +++ b/docs/en_US/errors/MRTI-678-1011.md @@ -0,0 +1,24 @@ +# Error Code: 678-1011 +**Applies to:** Wii U + +--- + +***Note:*** This error relates to the Martini patches, which are now deprecated. + +
+⚠️ Do not reboot your console or exit Martini! +
+ +The patcher encountered an error when applying the patched certificate to your system. Files essential to your Wii U's +functionality have been modified and the system may be unbootable. **Immediate action is required to avoid a brick.** + +Reach out on our [Discord](https://discord.gg/pretendo). State your error code and that you have a cert brick. Be +loud and ping mods - this is the only time you're allowed ;) + +--- + +Precise instructions are not provided here to ensure that you get helpers involved. For helpers and experienced users, +however, your best bet from here is to use wupclient (Tiramisu/Aroma) or FTP (Aroma) to download whatever Thwate cert is +on the console and inspect it, then upload a clean one. Users who have EnvironmentLoader in H&S can install Tiramisu and +should be able to use the boot selector to get to HBL and FTPiiU Everywhere without triggering the brick. Users without +a working coldboot setup are SOL if they reboot, though UDPIH might be able to save it. diff --git a/docs/en_US/errors/MRTI-678-1013.md b/docs/en_US/errors/MRTI-678-1013.md new file mode 100644 index 0000000..af9668e --- /dev/null +++ b/docs/en_US/errors/MRTI-678-1013.md @@ -0,0 +1,12 @@ +# Error Code: 678-1013 +**Applies to:** Wii U + +--- + +***Note:*** This error relates to the Martini patches, which are now deprecated. + +The patcher failed to restore a file from its backup. The patched file remains in place. + +Reboot your console and try again. If the issue persists, this is most likely a bug in the Martini patcher - please get +in touch with a developer on our [Discord](https://discord.gg/pretendo). + diff --git a/docs/en_US/install/juxt.md b/docs/en_US/install/juxt.md index 06757af..14c7a03 100644 --- a/docs/en_US/install/juxt.md +++ b/docs/en_US/install/juxt.md @@ -6,18 +6,20 @@ ## Select your console -- ### [Wii U](#wii-u-1) +- ### [Wii U (Tiramisu)](#wii-u-tiramisu-1) - ### [3DS](#3ds-1) -# Wii U +# Wii U (Tiramisu) -### In Game Patches +
+ ℹ️ Aroma users: The Aroma patcher already handles ingame patches and redirects the Miiverse applet to Juxtaposition - no further setup is needed. + The below instructions are only for Tiramisu users.
+
+
+ ⚠️ Note that Tiramisu is no longer supported by Pretendo and cannot receive the latest network and security patches. These instructions + are kept for legacy users only. +
-Nimble and Inkay already take care of in game patches for miiverse, so you're already good to go! - -
- -### Applet Patch Navigate to the [releases](https://github.com/PretendoNetwork/Martini/releases) page on the Martini GitHub repository diff --git a/docs/en_US/install/wiiu.md b/docs/en_US/install/wiiu.md index 17d45e9..7798a3e 100644 --- a/docs/en_US/install/wiiu.md +++ b/docs/en_US/install/wiiu.md @@ -1,22 +1,68 @@ # Wii U
- ℹ️ This guide assumes that you have a Homebrewed System, if you don't please follow this guide on how to homebrew your system first. + ℹ️ This guide assumes that you have a Homebrewed System using Aroma. + You can follow this guide on how to homebrew your system first, then install + Aroma using this guide.
## Select your homebrew environment -- ### [Tiramisu](#tiramisu-1) - ### [Aroma](#aroma-1) +- ### [Tiramisu](#tiramisu-1) - ### [Legacy](#legacy-1) -## Already have Pretendo installed? Setup a PNID then +## Already have Pretendo installed? - ### [PNID Setup](#pnid-setup-1) +# Aroma + +To connect to Pretendo Network using Aroma you must use the [Inkay](https://github.com/PretendoNetwork/Inkay) plugin. +The stable version is recommended for most users, however betatesters and others may be interested in the bleeding edge version. + +### Aroma - Stable +Navigate to the [releases](https://github.com/PretendoNetwork/Inkay/releases) page on the Inkay GitHub repository. + + + +Now download the `Inkay-pretendo.wps` file from the latest release. + + + +Place the downloaded `Inkay-pretendo.wps` file on your SD card at `sd:/wiiu/environments/aroma/plugins`. + + + +Place your SD card back into your console and boot like normal. You should now be connected to Pretendo Network. + +### Aroma - Bleeding Edge +Navigate to the [actions](https://github.com/PretendoNetwork/Inkay/actions) page on the Aroma GitHub repository. + + + +Select the `Inkay-CI` workflow and select the latest workflow run. _**Note:** At this stage you may also use the provided filters to only grab builds from specific branches, events, etc. By default the latest build, regardless of branch, is always shown._ + + + +Select the `inkay` artifact. This will download a `inkay.zip` zip file. + + + +Extract `inkay.zip` and place the extracted `Inkay-pretendo.wps` file on your SD card at `sd:/wiiu/environments/aroma/plugins`. + + + +Place your SD card back into your console and boot like normal. You should now be connected to Pretendo Network. + # Tiramisu +
+ ⚠ Note that Tiramisu is no longer supported by Pretendo and cannot receive the latest network and security patches. These instructions + are kept for legacy users only. +
+ To connect to Pretendo Network using Tiramisu you must use the [Nimble](https://github.com/PretendoNetwork/Nimble) set up module. There are 2 ways of obtaining the patch, either the stable release version or the bleeding edge version. ### Tiramisu - Stable @@ -53,48 +99,10 @@ Extract `nimble.zip` and place the extracted `30_nimble.rpx` file on your SD car Place your SD card back into your console and boot like normal. You should now be connected to Pretendo Network -# Aroma - -To connect to Pretendo Network using Aroma you must use the [Inkay](https://github.com/PretendoNetwork/Inkay) plugin. There are 2 ways of obtaining the patch, either the stable release version or the bleeding edge version. - -### Aroma - Stable -Navigate to the [releases](https://github.com/PretendoNetwork/Inkay/releases) page on the Aroma GitHub repository - - - -Now download the `Inkay-pretendo.wps` file from the latest release - - - -Place the downloaded `Inkay-pretendo.wps` file on your SD card at `sd:/wiiu/environments/aroma/plugins` - - - -Place your SD card back into your console and boot like normal. You should now be connected to Pretendo Network - -### Aroma - Bleeding Edge -Navigate to the [actions](https://github.com/PretendoNetwork/Inkay/actions) page on the Aroma GitHub repository - - - -Select the `Inkay-CI` workflow and select the latest workflow run. _**Note:** At this stage you may also use the provided filters to only grab builds from specific branches, events, etc. By default the latest build, regardless of branch, is always shown._ - - - -Select the `inkay` artifact. This will download a `inkay.zip` zip file - - - -Extract `inkay.zip` and place the extracted `Inkay-pretendo.wps` file on your SD card at `sd:/wiiu/environments/aroma/plugins` - - - -Place your SD card back into your console and boot like normal. You should now be connected to Pretendo Network - # Legacy -Pretendo does not officially support legacy homebrew environments (Haxchi/CBHC) anymore. Legacy releases of the patcher may be found in old [releases](https://github.com/PretendoNetwork/Nimble/releases), and the source code may be found in the [old_hbl](https://github.com/PretendoNetwork/Nimble/tree/old_hbl) and [old_hbl_inkay](https://github.com/PretendoNetwork/Nimble/tree/old_hbl_inkay) branches on GitHub. However you will need to build these patches from source, and they will _**not**_ be receiving any updates or technical support. Please consider upgrading to Tiramisu/Aroma +Pretendo does not officially support legacy homebrew environments (Haxchi/CBHC) anymore. Legacy releases of the patcher may be found in old [releases](https://github.com/PretendoNetwork/Nimble/releases), and the source code may be found in the [old_hbl](https://github.com/PretendoNetwork/Nimble/tree/old_hbl) and [old_hbl_inkay](https://github.com/PretendoNetwork/Nimble/tree/old_hbl_inkay) branches on GitHub. However you will need to build these patches from source, and they will _**not**_ be receiving any updates or technical support. Please consider upgrading to Aroma. # PNID Setup @@ -113,4 +121,4 @@ Right before registering a PNID, please make sure to save your password on some -Finally, set up your pnid, email and password. Once all of this is done you will be able to use Pretendo Server \ No newline at end of file +Finally, set up your pnid, email and password. Once all of this is done you will be able to use Pretendo Server diff --git a/views/partials/docs-sidebar.handlebars b/views/partials/docs-sidebar.handlebars index 714fb5a..3a3a1f9 100644 --- a/views/partials/docs-sidebar.handlebars +++ b/views/partials/docs-sidebar.handlebars @@ -21,6 +21,7 @@ JXT-598-0010 JXT-598-0011 JXT-598-0020 + JXT-598-0069