mirror of
https://github.com/PretendoNetwork/website.git
synced 2026-09-07 16:36:55 -05:00
chore: port assets, set up basic seo
This commit is contained in:
25
content/docs/error-page-template.md
Normal file
25
content/docs/error-page-template.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# Error Code: {module}-{code}
|
||||
|
||||
**Applies to:** {system}
|
||||
|
||||
**Module:** {module_name} - {module_description}
|
||||
|
||||
---
|
||||
|
||||
## Message
|
||||
|
||||
> {message}
|
||||
|
||||
## Cause
|
||||
|
||||
{description}
|
||||
|
||||
## Solution
|
||||
|
||||
{solution}
|
||||
|
||||
---
|
||||
|
||||
If you have not yet connected to Pretendo, please follow the instructions [here](/docs/install) to get started.
|
||||
|
||||
If you are still unable to connect, please request to speak to a moderator in the [Discord server](https://discord.gg/pretendo).
|
||||
151
content/docs/install/3ds.md
Normal file
151
content/docs/install/3ds.md
Normal file
@@ -0,0 +1,151 @@
|
||||
---
|
||||
description: "Instructions on how to set up Pretendo on the 3DS/2DS family of consoles."
|
||||
---
|
||||
|
||||
# 3DS/2DS Family
|
||||
|
||||
<div class="tip red">
|
||||
<strong>CAUTION:</strong>
|
||||
DON'T REMOVE YOUR NNID TO SET UP PRETENDO NETWORK, IT'S NOT NECESSARY AND BY DOING SO YOU WILL LOSE BADGES, REDOWNLOADABLE GAMES, THEMES AND POKÉMON BANK DATA!
|
||||
</div>
|
||||
|
||||
<div class="tip red">
|
||||
<strong>CAUTION:</strong>
|
||||
SYSTEM TRANSFERS ARE NOT CURRENTLY SUPPORTED BY OUR SERVERS. ATTEMPTING TO PERFORM A SYSTEM TRANSFER MAY PREVENT YOU FROM BEING ABLE TO GO ONLINE IN THE FUTURE. SUPPORT FOR SYSTEM TRANSFERS IS IN DEVELOPMENT.
|
||||
</div>
|
||||
|
||||
<div class="tip red">
|
||||
<strong>CAUTION:</strong>
|
||||
Collecting badges in Nintendo Badge Arcade while connected to one network and then launching the game on a different network will result in your badges disappearing. This occurs because the locally saved data does not match the data stored on the server.
|
||||
</div>
|
||||
|
||||
<div class="tip">
|
||||
ℹ️ This guide assumes that you have a <b>Homebrewed System running the latest version of Luma3DS (13+)</b>, if you don't please follow this <a href="https://3ds.hacks.guide/" target="_blank">guide</a> on how to homebrew your system first.
|
||||
</div>
|
||||
|
||||
The following steps are required for you to connect to the Pretendo Network:
|
||||
|
||||
1. [Downloading Nimbus](#downloading-nimbus)
|
||||
2. [Enabling Luma patches](#luma-patches)
|
||||
3. [Nimbus](#using-nimbus)
|
||||
|
||||
## Downloading Nimbus
|
||||
|
||||
<div class="tip">
|
||||
ℹ️ Nimbus is also available on <a href="https://db.universal-team.net/3ds/nimbus" target="_blank">Universal-Updater</a>. If you do not have Universal-Updater, you may follow this <a href="https://universal-team.net/projects/universal-updater.html" target="_blank">guide</a>. You may download the required files from there, rather than GitHub, or install/update the app directly from your console.
|
||||
<br>
|
||||
<br>
|
||||
ℹ️ If installed directly from your console for the first time, you will still be required to install the associated IPS patches from GitHub. Once installed, updates may be managed purely from Universal-Updater
|
||||
</div>
|
||||
|
||||
Before starting, power off your console and insert its SD card into your computer.
|
||||
|
||||
Once inserted, download the latest [Nimbus release](https://github.com/PretendoNetwork/Nimbus/releases/latest).
|
||||
|
||||
Nimbus is available as both a 3DSX app and an installable CIA. The releases page offers downloads for both. Select the version you would like to use, or select the `combined.[version].zip` archive to use both.
|
||||
|
||||
<img src="/assets/images/docs/install/3ds/zip-highlight.webp" alt="Screenshot of a GitHub release page with the file combined.[version].zip highlighted" width=100% height=auto/>
|
||||
|
||||
Extract the contents of the zip archive to the root of your SD card. If you are asked to merge or overwrite files, accept the changes.
|
||||
|
||||
Ensure your SD card has all the following files
|
||||
|
||||
- `SD:/3ds/nimbus/update/000400300000BC02.ips` (Miiverse, JPN)
|
||||
- `SD:/3ds/nimbus/update/000400300000BD02.ips` (Miiverse, USA)
|
||||
- `SD:/3ds/nimbus/update/000400300000BE02.ips` (Miiverse, EUR)
|
||||
- `SD:/3ds/nimbus/update/0004013000002902.ips` (HTTP)
|
||||
- `SD:/3ds/nimbus/update/0004013000002E02.ips` (Sockets)
|
||||
- `SD:/3ds/nimbus/update/0004013000002F02.ips` (SSL)
|
||||
- `SD:/3ds/nimbus/update/0004013000003202.ips` (FRD/Friends)
|
||||
- `SD:/3ds/nimbus/update/0004013000003802.ips` (ACT/NNID)
|
||||
- `SD:/3ds/nimbus/update/juxt-prod.pem` (Juxtaposition certificate)
|
||||
- `SD:/3ds/nimbus/update/nimbus.3gx` (Nimbus plugin for Luma)
|
||||
|
||||
If not installed through Universal-Updater, ensure at least one of the following also exists
|
||||
|
||||
- `SD:/cias/nimbus.cia`
|
||||
- `SD:/3ds/nimbus.3dsx`
|
||||
|
||||
Insert your SD card back into your console.
|
||||
|
||||
## Luma patches
|
||||
|
||||
<div class="tip">
|
||||
ℹ️ <b>Skip this step if you've already enabled the required patches on your console for Pretendo Network.</b>
|
||||
</div>
|
||||
|
||||
In order to make use of the Pretendo Network service, you will need to enable Luma patches on your console. Hold the `SELECT` button on your 3DS and power it on.
|
||||
|
||||
On the screen that is displayed, make sure that these following options are enabled:
|
||||
|
||||
- `Enable loading external FIRMS and modules`
|
||||
- `Enable game patching`
|
||||
|
||||
Press `START` to save and continue with these changes.
|
||||
|
||||
## Installing Nimbus to HOME Menu
|
||||
|
||||
<div class="tip">
|
||||
ℹ️ <b>Skip this step if you downloaded the 3DSX only zip file.</b>
|
||||
</div>
|
||||
|
||||
If you downloaded the combined or cia archives, you can install Nimbus to the HOME Menu for quick and easy access.
|
||||
|
||||
Open FBI. If you do not have FBI, download the latest release from [GitHub](https://github.com/lifehackerhansol/FBI/releases/latest). Select `SD`, then `cias`. Find and select `nimbus.cia`. Select either `Install CIA` or `Install and delete CIA`.
|
||||
|
||||
Once it has finished installing, press the HOME button and exit FBI. You should see a message that a new application has been added to the HOME Menu. Click OK and you'll now have Nimbus on your HOME Menu.
|
||||
|
||||
## Using Nimbus
|
||||
|
||||
Depending on how you installed Nimbus, launch it either through the Homebrew Launcher or the 3DS HOME Menu. Select either `Pretendo` or `Nintendo` to swap between services.
|
||||
|
||||
Your selection persists between reboots.
|
||||
|
||||
## Signing into your PNID
|
||||
|
||||
The 3DS does not rely on NNIDs for the vast majority of it's game servers. Because of this, using a PNID is also not required for most games<sup><a>[[1]](#footnote-1)</a></sup>.
|
||||
|
||||
Setting up a PNID on the 3DS is the same as setting up a NNID. You may either create the PNID on your console, or register from an account [on our website](/account/register) and link it to your console once you're ready.
|
||||
|
||||
It is recommended to register the PNID on your device at this time, as registering on the website does not currently allow you to change your user data.
|
||||
|
||||
<div class="tip red">
|
||||
<strong>CAUTION:</strong>
|
||||
A Pretendo Network ID may not use the same username as the account already linked to your 3DS! Ensure that you have chosen a different name for your PNID than the name on your NNID.
|
||||
</div>
|
||||
|
||||
## Other information
|
||||
|
||||
### How does Nimbus work?
|
||||
|
||||
Nimbus will create a 2nd local account set to the `test` NASC environment. The IPS patches will set the `test` NASC environment URLs to point to Pretendo. You may freely switch between Pretendo and Nintendo. Your selected mode will persist between reboots.
|
||||
|
||||
### 2nd local account?
|
||||
|
||||
You may have thought to yourself; _"2nd local account? What's that? I thought the 3DS only had one account?"_ And you'd be half right. The 3DS only _normally_ supports one account, and you may only have one account active at a time. However Nintendo implemented support for multiple local accounts on the 3DS/2DS which remains unused on all retail units. On a normal retail unit only one local account is ever made, which is set to the `prod` NASC environment. Local accounts may be set to `prod`, `test` or `dev`. Nimbus makes use of this unused feature to create sandboxed local accounts with different environments
|
||||
|
||||
<ul id="footnotes">
|
||||
<li id="footnote-1"><sup>[1]</sup> Some games may require a PNID for certain actions, such as eShop purchases. The only known game which requires a PNID for general use is Nintendo Badge Arcade, which is not yet supported</li>
|
||||
</ul>
|
||||
|
||||
### Restoring Nintendo Badge Arcade Badges
|
||||
|
||||
1. Insert your SD Card into your PC.
|
||||
2. Back up your badges at the folder on your SD Card `SD:Nintendo 3DS/ID0/ID1/extdata/00000000/000014d1`.
|
||||
3. Download [Simple Badge Injector](https://github.com/AntiMach/simple-badge-injector/releases/latest).
|
||||
4. Insert your SD Card into your console.
|
||||
5. Use Nimbus to switch to Pretendo.
|
||||
6. Open Simple Badge Injector and make a note of the "Nintendo Network ID" value.
|
||||
7. Still inside SBI, choose the option to dump your badge data files.
|
||||
8. Turn off your 3DS and remove the SD card. Insert your SD card into your PC.
|
||||
9. Download and open [Advanced Badge Editor](https://github.com/AntiMach/advanced-badge-editor/releases/latest).
|
||||
10. Go to `File > Open Data`, then choose the folder where BadgeData.dat and BadgeMngFile.dat are. (Located at `sd:/3ds/SimpleBadgeInjector/Dumped`)
|
||||
11. Replace the NNID value with the one you made a note of in SBI earlier.
|
||||
12. Select `Save As` to save the modified file separately from the backup.
|
||||
13. Put your modified badge data filed into `sd:/3ds/SimpleBadgeInjector`
|
||||
14. Put your SD card back into your 3DS and go back into SBI
|
||||
15. Inject your modified badge data files.
|
||||
|
||||
All badges _placed_ on the home menu will be deleted, and you have to re-add them in the order you have had them before.
|
||||
|
||||
If you encounter any errors, restore your backed up badge data through SBI. Injecting badges while using Pretendo Network will make them disappear when swapping back to Nintendo Network, and vice versa.
|
||||
117
content/docs/install/azahar.md
Normal file
117
content/docs/install/azahar.md
Normal file
@@ -0,0 +1,117 @@
|
||||
---
|
||||
description: "Instructions on how to set up Pretendo on Azahar, the 3DS/2DS emulator."
|
||||
---
|
||||
|
||||
# Azahar
|
||||
|
||||
<div class="tip red">
|
||||
<strong>CAUTION:</strong>
|
||||
This guide only supports official builds provided by the Azahar Emulator team. Any unofficial/third-party emulator builds are not supported, and we do not provide technical support for issues caused by using said unofficial builds.
|
||||
</div>
|
||||
|
||||
<div class="tip">
|
||||
ℹ️ Azahar <b>requires</b> connecting to a real 3DS/2DS system using an app called Artic Setup Tool before you can play online. This guide assumes that you have a <b>Homebrewed System running the latest version of Luma3DS (v13.3.1 or higher)</b>. If you don't, please follow this <a href="https://3ds.hacks.guide/" target="_blank">guide</a> on how to install homebrew to your system first.
|
||||
</div>
|
||||
|
||||
The following steps are required for you to connect to Pretendo Network:
|
||||
|
||||
1. [Downloading Artic Setup Tool](#downloading-artic-setup-tool)
|
||||
2. [Using Artic Setup Tool](#using-artic-setup-tool)
|
||||
3. [LLE module setup in Azahar](#lle-module-setup-in-azahar)
|
||||
4. [Downloading Nimbus](#downloading-nimbus)
|
||||
5. [Using Nimbus](#using-nimbus)
|
||||
6. [Link a Pretendo Network ID (optional)](#link-a-pretendo-network-id-optional)
|
||||
|
||||
## Downloading Artic Setup Tool
|
||||
|
||||
### Using Universal Updater
|
||||
|
||||
The easiest way to get Artic Setup Tool is by using Universal Updater. Universal Updater is also great for updating all of your other homebrew apps, so installing it is highly recommended. To install Universal Updater, get it from <a href="https://universal-team.net/projects/universal-updater.html" target="_blank">here</a>.
|
||||
|
||||
Once you have Universal Updater, simply open it and search for "Artic Setup Tool". Select `AzaharArticSetup.3dsx` if you want to launch the setup tool from the Homebrew Launcher, or select `AzaharArticSetup.cia` if you want to launch it from your HOME Menu.
|
||||
|
||||
### Without using Universal Updater
|
||||
|
||||
If you'd prefer not to use Universal Updater, Artic Setup Tool can be installed manually using the FBI title manager.
|
||||
|
||||
Before starting, power off your console and insert its SD card into your computer.
|
||||
|
||||
If you want to launch Artic Setup Tool from your HOME Menu, download `AzaharArticSetup.cia` from the [latest Artic Setup Tool release](https://github.com/azahar-emu/ArticSetupTool/releases/latest) and put it on your SD card. Then, open FBI and install it.
|
||||
|
||||
If you want to launch Artic Setup Tool from the Homebrew Launcher, download `AzaharArticSetup.3dsx` from the [latest Artic Setup Tool release](https://github.com/azahar-emu/ArticSetupTool/releases/latest) and put it inside the `3ds` folder on your SD card.
|
||||
|
||||
## Using Artic Setup Tool
|
||||
|
||||
<div class="tip">
|
||||
ℹ️ Before opening Artic Setup Tool, ensure that your 3DS/2DS is on the same Wi-Fi network as the computer running Azahar.
|
||||
</div>
|
||||
|
||||
Open Artic Setup Tool on your 3DS/2DS. Once it's open, press A to run the tool. An IP address will be displayed on the top screen.
|
||||
|
||||
<img src="/assets/images/docs/install/azahar/artic_setup_tool.png" width=100% height=auto/>
|
||||
|
||||
If your system's top screen is broken, hold L + D-Pad Down + SELECT to open the Rosalina menu, then go to `Debugger options...` and enable the debugger, then press B. Your IP address will be displayed in the top-right corner of the bottom screen. Write down this IP address somewhere, then disable the debugger and exit the Rosalina menu.
|
||||
|
||||
Open Azahar on your computer. Click `File`, then `Set Up System Files...`. A window will pop up containing some information and a text box. `Old 3DS Setup` will be selected regardless of what system you have. <b>This is normal.</b> Enter your 3DS/2DS IP address into the text box in Azahar and click OK.
|
||||
|
||||
<img src="/assets/images/docs/install/azahar/azahar_set_up_enterIP.png" width=100% height=auto/>
|
||||
|
||||
<div class="tip yellow">
|
||||
⚠️ If you see an error that says "Missing OTP backup on SD card", you need to run a program to recreate the backup. Put <a href="https://github.com/MisterSheeple/GodMode9/releases/download/otp_1.0.0/otp_dump.firm" target="_blank">otp_dump.firm</a> inside /luma/payloads/ on your SD card, then hold START + Power on your system with the SD card inserted. If you are not immediately booted into the dumper program, select "otp_dump" on the top screen and press A to load it. The program should tell you that your OTP has been successfully dumped. Press A to power off your system.
|
||||
</div>
|
||||
|
||||
<div class="tip yellow">
|
||||
⚠️ If you see an error that says "The country configuration does not match the console region", you need to change the country set in Azahar to match the region of your system. To do this, click "Emulation", then "Configure", then click "System". Find the country drop-down box and select your system's country from the list, then click OK to save your configuration settings. <b>Please note that "Country" and "Region" are two separate drop-down boxes in Azahar.</b> "Country" is the one that needs to be changed to fix this issue.
|
||||
</div>
|
||||
|
||||
On Azahar, a screen will appear telling you to "update your system". This is actually a process that downloads some required system files from the 3DS update servers so that Azahar can connect online. This won't modify anything on your 3DS/2DS system. Click OK to allow it to proceed.
|
||||
|
||||
<img src="/assets/images/docs/install/azahar/azahar_set_up_sysupdate.png" width=100% height=auto/>
|
||||
|
||||
After a few minutes, Azahar will notify you that the update is complete. Click OK to continue. <b>You are not finished with Artic Setup Tool.</b>
|
||||
|
||||
In Azahar, click `File` and `Set Up System Files...` again. Enter the IP address again, but this time, click `New 3DS Setup`. <b>This is required and will work regardless of whether or not your system is a New 3DS/2DS.</b> Click OK.
|
||||
|
||||
<img src="/assets/images/docs/install/azahar/azahar_set_up_enterIP_N3DS.png" width=100% height=auto/>
|
||||
|
||||
Once again, a screen will appear on Azahar telling you to "update your system". Click OK to allow it to proceed.
|
||||
|
||||
<img src="/assets/images/docs/install/azahar/azahar_set_up_sysupdate_N3DS.png" width=100% height=auto/>
|
||||
|
||||
Another screen will appear telling you some important information about system updates. Review this information and click "I Accept" to proceed to the update.
|
||||
|
||||
Once the update is complete, click OK.
|
||||
|
||||
On your 3DS/2DS system, press START to exit Artic Setup Tool. Your 3DS/2DS system is no longer needed for the rest of this guide.
|
||||
|
||||
## LLE module setup in Azahar
|
||||
|
||||
In Azahar, click `Emulation`, then `Configure`.
|
||||
|
||||
Select the `System` menu and click `Enable required LLE modules for online features`. Make sure this box is checked, then click OK. Please note that you will not be able to use savestates while this option is enabled, but you will not be able to connect online when it is disabled.
|
||||
|
||||
<img src="/assets/images/docs/install/azahar/azahar_emulation_configure_LLE_module.png" width=100% height=auto/>
|
||||
|
||||
## Downloading Nimbus
|
||||
|
||||
Download the [latest Nimbus release](https://github.com/PretendoNetwork/Nimbus/releases/latest). Be sure to select a zip file labeled either `cia` or `combined`. Once downloaded, extract this zip file.
|
||||
|
||||
Open your emulator's SDMC folder. By default, this will be located in the main Azahar folder. To get there, click `File` and `Open Azahar Folder`. A file explorer window will open. Enter the `sdmc` folder and paste the `3ds` folder from the zip file into there. If everything goes correct, inside the `sdmc` folder you should have two folders named `3ds` and `Nintendo 3DS` (with the `Nintendo 3DS` folder already being present).
|
||||
|
||||
Close Azahar and re-open it. Click `File` and `Install CIA`. Navigate into the `cias` folder from the zip file and select `nimbus.cia`, then click OK. This will install Nimbus to your emulator.
|
||||
|
||||
## Using Nimbus
|
||||
|
||||
Open Nimbus within Azahar. Upon opening it, it will notify you that it's been updated. Click `Emulation` and then `Stop` to exit it.
|
||||
|
||||
<img src="/assets/images/docs/install/azahar/azahar_nimbus_update.png" width=100% height=auto/>
|
||||
|
||||
Reopen Nimbus and click the Pretendo button. Once you have switched to Pretendo, click `Emulation` and then `Stop` to exit Nimbus again.
|
||||
|
||||
<img src="/assets/images/docs/install/azahar/azahar_nimbus_pretendo_select.png" width=100% height=auto/>
|
||||
|
||||
Once you're connected to Pretendo Network, you may want to open the HOME Menu and check the Friend List to confirm that you've been assigned a friend code. Please note that Artic Setup Tool does not copy your account or save data from your system.
|
||||
|
||||
## Link a Pretendo Network ID (optional)
|
||||
|
||||
Some games and apps require a Pretendo Network ID (PNID) to be linked before you can use them online. To link a PNID, open the System Settings app in Azahar and click on `Nintendo Network ID Settings`. From here, you can either create a new PNID or link an existing one. Follow the directions on your screen to create or link a PNID. Please note that even though it says "Nintendo Network ID" throughout, you are still creating/linking a Pretendo Network ID.
|
||||
34
content/docs/install/cemu.md
Normal file
34
content/docs/install/cemu.md
Normal file
@@ -0,0 +1,34 @@
|
||||
---
|
||||
description: "Instructions on how to set up Pretendo on Cemu, the Wii U emulator."
|
||||
---
|
||||
|
||||
<div class="tip green">This Guide may be missing some info or incomplete.</div>
|
||||
|
||||
# Cemu
|
||||
|
||||
<div class='tip'>
|
||||
In Order to use Pretendo on Cemu, you need to have Pretendo already installed on your Wii U. For Wii U please follow the <a href='/docs/install/wiiu'>Wii U Guide</a>
|
||||
</div>
|
||||
|
||||
## Download
|
||||
|
||||
<div class="tip red">
|
||||
<strong>Note:</strong>
|
||||
Only experimental builds of Cemu 2.0 are supported. At this time Cemu does not have a stable release of Cemu 2.0 which supports Pretendo
|
||||
</div>
|
||||
|
||||
Cemu 2.0 has official built-in support for Pretendo as of October 10, 2022. Head to the Cemu GitHub [releases](https://github.com/cemu-project/Cemu/releases) page and download the latest Cemu experimental release (tagged as `Pre-release`). Only `Cemu 2.0-5 (Experimental)` and above is supported at the moment. Additionally you may build Cemu from source using the provided [build instructions](https://github.com/cemu-project/Cemu/blob/main/BUILD.md)
|
||||
|
||||
## Dumping your pretendo account
|
||||
|
||||
Ensure you have followed [Cemu's guide](https://cemu.cfw.guide/online-play.html) to set up the emulator for online play. When dumping your user account files, ensure you select your PNID.
|
||||
|
||||
## Connecting to Pretendo
|
||||
|
||||
Once you have Cemu setup for online play navigate to `Options > General settings > Account`. You should now see a section titled `Network Service`. Select your PNID from the `Active account` menu and select the `Pretendo` Network Service option. Cemu should now be connected to Pretendo's servers
|
||||
|
||||
<center><img src="/assets/images/docs/install/cemu/network-services-settings.webp" alt="Screenshot of Cemu's Account Settings with different Network Service Options."/></center>
|
||||
|
||||
## Miiverse
|
||||
|
||||
Cemu has limited to no Miiverse support as of now. Some in game features may work, but this is not guaranteed. The Miiverse applet does not work in official builds.
|
||||
7
content/docs/install/citra.md
Normal file
7
content/docs/install/citra.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
description: "Citra is not supported. Please use Azahar instead."
|
||||
---
|
||||
|
||||
# Citra
|
||||
|
||||
Citra is not supported. Please use <a href="/docs/install/azahar" target="_blank">Azahar</a> instead.
|
||||
33
content/docs/install/juxt.md
Normal file
33
content/docs/install/juxt.md
Normal file
@@ -0,0 +1,33 @@
|
||||
---
|
||||
description: "Instructions on how to install Juxtaposition."
|
||||
---
|
||||
|
||||
# Installing Juxtaposition
|
||||
|
||||
<div class="tip">
|
||||
ℹ️ This guide assumes that you have a <b>Homebrewed System</b>, and have already connected to Pretendo. If you have not yet set up your Pretendo Network ID, follow this <a href="/docs/install" target="_blank">guide</a> to get started.
|
||||
</div>
|
||||
|
||||
Juxtaposition is the Pretendo Network replacement for the now defunct Miiverse service
|
||||
|
||||
## Select your console
|
||||
|
||||
- ### [Wii U](#wii-u)
|
||||
- ### [3DS](#3ds-1)
|
||||
|
||||
# Wii U
|
||||
|
||||
<div class="tip">
|
||||
ℹ️ Inkay already handles all the required patches for Miiverse. If you do not have Inkay installed, follow this <a href="/docs/install/wiiu" target="_blank">guide</a> to get started.
|
||||
</div>
|
||||
|
||||
|
||||
# 3DS
|
||||
|
||||
<div class="tip">
|
||||
ℹ️ Nimbus already handles all the required patches for the Miiverse applet. If you do not have Nimbus installed, follow this <a href="/docs/install/3ds" target="_blank">guide</a> to get started.
|
||||
</div>
|
||||
|
||||
### In Game Patches
|
||||
|
||||
Miiverse content inside of games is not supported on the 3DS at this time.
|
||||
282
content/docs/install/wiiu.md
Normal file
282
content/docs/install/wiiu.md
Normal file
@@ -0,0 +1,282 @@
|
||||
---
|
||||
description: "Instructions on how to set up Pretendo on the Wii U console."
|
||||
---
|
||||
|
||||
# Wii U
|
||||
|
||||
<div class="tip red">
|
||||
<strong>CAUTION:</strong>
|
||||
DON'T REMOVE YOUR NNID TO SET UP PRETENDO NETWORK, IT'S NOT NECESSARY AND BY DOING SO YOU WILL LOSE ALL YOUR PREVIOUSLY PURCHASED GAMES AND WILL BE UNABLE TO UPDATE THEM!</strong>
|
||||
</div>
|
||||
|
||||
You can connect your Wii U to Pretendo using one of 2 methods. Inkay is recommended unless you have some reason to avoid modding your console (e.g. you live in Japan where is is legally gray).
|
||||
|
||||
- [Inkay (homebrew - recommended)](#inkay)
|
||||
- [SSSL (hackless)](#sssl)
|
||||
|
||||
# Inkay
|
||||
|
||||
**Pros:**
|
||||
|
||||
- All services supported
|
||||
- Contains additional features and patches
|
||||
- Works regardless of ISP
|
||||
- Easy toggle on and off
|
||||
|
||||
**Cons:**
|
||||
|
||||
- Requires homebrew
|
||||
|
||||
## Installation
|
||||
|
||||
<div class="tip">
|
||||
ℹ️ This part of the guide assumes that you have a <b>Homebrewed System</b> using <b>Aroma</b>.
|
||||
If you don't yet, you can follow this <a href="https://wiiu.hacks.guide/" target="_blank">guide to set up homebrew on your Wii U</a>.
|
||||
</div>
|
||||
|
||||
Locate the `Aroma Updater` icon on your Wii U Menu and open it.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/aroma/aroma-updater-icon.webp" alt="Screenshot of Wii U Menu with the Aroma Updater icon highlighted" width="100%">
|
||||
|
||||
On the welcome screen, press A to check for updates.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/aroma/aroma-updater-welcome.png" alt="Screenshot of white text. 'Welcome to the Aroma updater' - 'A - Check for updates'" width="100%">
|
||||
|
||||
Wait for the update check to complete. Your screen may look slightly different to this image if newer updates have been released when you're reading this - that's okay.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/aroma/aroma-updater-p1.png" alt="Aroma updater application displaying a list of payloads." width="100%">
|
||||
|
||||
Press R to move to Page 2.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/aroma/aroma-updater-p2.png" alt="Aroma updater application displaying a list of additional plugins." width="100%">
|
||||
|
||||
Use the D-Pad to move the cursor down to Inkay, then press A to select it.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/aroma/aroma-updater-inkay.png" alt="Aroma updater application displaying a list of additional plugins with Inkay highlighted and selected." width="100%">
|
||||
|
||||
Press + to begin the installation, then press A to confirm the changes. You may have additional updates listed in addition to Inkay - that's okay.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/aroma/aroma-updater-confirm.png" alt="A confirmation dialog. Inkay will be updated or changed." width="100%">
|
||||
|
||||
<div class="tip">
|
||||
ℹ️ You may get a message stating "This version of this file is unknown!" in relation to Inkay - this means you have an old or beta version installed.
|
||||
You should press A to confirm replacing it with the correct version.
|
||||
</div>
|
||||
|
||||
Wait for the installation to complete, then press A to restart your console.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/aroma/aroma-updater-done.png" alt="A confirmation dialog. The console will now restart." width="100%">
|
||||
|
||||
Once the console restarts, you'll see a notification in the top-left informing you that Pretendo will be used. The notification disappears after a few moments.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/aroma/pretendo-notification.webp" alt="The Wii U user selection screen, with 'Using Pretendo Network' overlaid in the top-left" width="100%">
|
||||
|
||||
Inkay is now installed and working. You can proceed to [PNID Setup](#pnid-setup) to create an account.
|
||||
|
||||
# SSSL
|
||||
|
||||
**Pros:**
|
||||
|
||||
- Does not require homebrew
|
||||
- Very easy to setup
|
||||
|
||||
**Cons:**
|
||||
|
||||
- Only a subset of services are supported
|
||||
- Lacks additional features and patches
|
||||
- Does not work on some ISPs
|
||||
- Hard to switch on or off
|
||||
|
||||
SSSL is a (limited) hackless method of accessing most services by exploiting a bug in the Wii U's SSL module. All Nintendo Network games produced by Nintendo are supported by SSSL, as are the **_in-game_** Miiverse features. The main Miiverse app, in-game **_posting_** app, and any game which uses its own SSL stack (YouTube, WATCH*DOGS, etc.), are \*\*\_NOT*\*\* supported by this method, as they are unaffected by the SSL exploit.
|
||||
|
||||
## Installation
|
||||
|
||||
<div class="tip">
|
||||
ℹ️ System Settings, and therefore SSSL, requires a Wii U GamePad to use on unmodified systems.
|
||||
</div>
|
||||
|
||||
Locate the `System Settings` icon on your Wii U Menu and open it.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/sssl/system-settings.webp" alt="The Wii U Menu, with the System Settings icon highlighted" width="100%">
|
||||
|
||||
Open the Internet category.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/sssl/internet-settings.webp" alt="The System Settings app, with the Internet category highlighted" width="100%">
|
||||
|
||||
Select `Connect to the Internet`.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/sssl/internet-settings-connect.webp" alt="The System Settings app, with the Connect to the Internet button highlighted" width="100%">
|
||||
|
||||
Select `Connection List` in the top-right.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/sssl/internet-settings-scan.webp" alt="The Internet Connection Setup panel. In the top-right is a Connection List button (X)" width="100%">
|
||||
|
||||
Locate the connection with a "Wii U" logo. This is the one your system will use by default. Press A to edit it.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/sssl/internet-connection-list.webp" alt="A list of internet connections. 'Wired Connection' is marked with a Wii U and Wii logo, and is highlighted." width="100%">
|
||||
|
||||
Select `Change Settings`.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/sssl/internet-connection-change.webp" alt="A list of options. 'Change Settings' is highlighted." width="100%">
|
||||
|
||||
Navigate to the right and down to the `DNS` button, and press A to edit.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/sssl/internet-connection-dns-button.webp" alt="The second page of the Wii U connection editor. DNS is highlighted." width="100%">
|
||||
|
||||
Select `Do not auto-obtain`. We will provide our own DNS for SSSL to work.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/sssl/internet-connection-dns-obtain.webp" alt="Two options for 'Automatically obtain DNS?' 'Do not auto-obtain' is highlighted." width="100%">
|
||||
|
||||
This brings up the DNS input. We will change both the Primary and Secondary DNS settings.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/sssl/internet-connection-dns-editor.webp" alt="Two input fields for Primary and Secondary DNS." width="100%">
|
||||
|
||||
For the Primary DNS, enter `88.198.140.154`. This is the SSSL server.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/sssl/internet-connection-dns-primary.webp" alt="'Enter the primary DNS' field, with 88.198.140.154 - the SSSL server - input." width="100%">
|
||||
|
||||
For the Secondary DNS, enter `9.9.9.9` (or another public DNS of your choice). This will serve as a fallback if Pretendo's SSSL server should go offline, allowing your console to still access the Internet. If Pretendo is offline and the fallback is used, however, the console will access Nintendo Network rather than Pretendo Network. If this is undesirable to you, leave this field blank.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/sssl/internet-connection-dns-secondary.webp" alt="'Enter the secondary DNS' field, with 9.9.9.9 - a public DNS server - input." width="100%">
|
||||
|
||||
Review the final settings and ensure you typed them correctly. The Wii U will add leading zeroes to each number - this is okay. If they are correct, press Confirm.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/sssl/internet-connection-dns-done.webp" width="100%">
|
||||
|
||||
Press B to save the connection. You may perform a connection test and set the connection as default. Then, press B until System Settings exits.
|
||||
|
||||
SSSL is now installed and working. You can proceed to [PNID Setup](#pnid-setup) to create an account.
|
||||
|
||||
To disconnect from Pretendo Network (e.g. to access the Nintendo eShop) repeat this process, but select `Auto-obtain` for the DNS.
|
||||
|
||||
# PNID Setup
|
||||
|
||||
After installing Pretendo, you must register a Pretendo Network ID (PNID). There is currently two ways of creating a PNID: Creating an account with the website and linking it, or creating it on your Wii U.
|
||||
|
||||
<div class="tip red">
|
||||
<strong>CAUTION:</strong>
|
||||
A Pretendo Network ID may not use the same username as an account already linked to your Wii U! Ensure that you have chosen a different name for your PNID than the name on your NNID.
|
||||
</div>
|
||||
|
||||
### Website
|
||||
|
||||
You will want to register an account from [here](/account) and click `Don't have an account?` to register.
|
||||
|
||||
<div class="tip yellow">
|
||||
<strong>NOTE:</strong>
|
||||
Account settings cannot be modified at this time. Feature updates to the website have been paused as we migrate the codebase, and the account settings app on the Wii U requires additional patches.
|
||||
</div>
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/pnid/register-account-web.webp" alt="Screenshot of a web form to register an account" width="100%">
|
||||
|
||||
Once your account is registered, link it to your console as you would a Nintendo Network ID.
|
||||
|
||||
Your PNID is now set up and ready to use. You may continue reading to learn about optional extras, like Inkay's features and transferring save data, or you can stop here.
|
||||
|
||||
### Wii U
|
||||
|
||||
Create the Pretendo Network ID as you would a Nintendo Network ID.
|
||||
|
||||
# Using Inkay
|
||||
|
||||
If you're using Inkay rather than SSSL, there are some additional features you may find helpful.
|
||||
|
||||
<details>
|
||||
<summary>Using Nintendo Network</summary>
|
||||
You might need to switch back to Nintendo Network to access the Nintendo eShop or other services.
|
||||
|
||||
Press `L + Down + SELECT` on the Wii U GamePad to open the Aroma plugin menu. Use the D-pad to highlight Inkay then press A to select.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/inkay-tips/aroma-plugin-menu.png" alt="Screenshot of Aroma plugin menu with Inkay entry highlighted" width="100%">
|
||||
|
||||
Press A to enter the `Network Selection` area.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/inkay-tips/inkay-network-selection.png" alt="Screenshot of Inkay menu with Network Selection highlighted" width="100%">
|
||||
|
||||
Press A on `Connect to Pretendo network` to toggle it to `false`.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/inkay-tips/inkay-network-false.png" alt="Screenshot of Inkay menu with Connect to Pretendo Network set to false" width="100%">
|
||||
|
||||
Press `B` three times to exit the Aroma plugin menu. Your console will restart. Once it does, a notification will appear showing that you are now using Nintendo Network.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/inkay-tips/nintendo-notification.webp" alt="The Wii U user selection screen, with 'Using Nintendo Network' overlaid in the top-left" width="100%">
|
||||
|
||||
You may now use your NNID to access the eShop or other Nintendo services. To return to Pretendo Network, repeat the process and set `Connect to Pretendo network` to `true`.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Resetting WaraWara Plaza</summary>
|
||||
If you're having issues with WaraWara Plaza (where the Miis run around on the TV), resetting it can help.
|
||||
|
||||
Exit any games or software such that you're on the Wii U Menu, then press `L + Down + SELECT` on the Wii U GamePad to open the Aroma plugin menu. Use the D-pad to highlight Inkay then press A to select.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/inkay-tips/aroma-plugin-menu.png" alt="Screenshot of Aroma plugin menu with Inkay entry highlighted" width="100%">
|
||||
|
||||
Use the D-pad to select `Other Settings` and press A to enter it.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/inkay-tips/inkay-other-settings.png" alt="Screenshot of Inkay menu with Other Settings highlighted" width="100%">
|
||||
|
||||
Press A on `Reset Wara Wara Plaza` to perform the reset.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/inkay-tips/inkay-wwp-reset.png" alt="Screenshot of Inkay menu with Reset Wara Wara Plaza highlighted" width="100%">
|
||||
|
||||
The button will change to indicate the console must be restarted.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/inkay-tips/inkay-wwp-apply.png" alt="Screenshot of Inkay menu with Reset Wara Wara Plaza highlighted. The entry now says 'Restart to apply'" width="100%">
|
||||
|
||||
Press `B` three times to exit the Aroma plugin menu. Your console will restart. Once it does, the process is complete.
|
||||
|
||||
</details>
|
||||
|
||||
# Transferring save data to your Pretendo Network account
|
||||
|
||||
Pretendo Network is not compatible with existing Nintendo Network IDs. This means you must create a new account. Because of this, you may want to move existing game save data to your new account. This is optional.
|
||||
|
||||
<div class="tip red">
|
||||
<strong>Note:</strong>
|
||||
This only works with local save data. Any user data stored on Nintendo's servers cannot be transferred to any other accounts.
|
||||
</div>
|
||||
|
||||
To move your save data, you will need a save data backup homebrew application. This guide will use the WUT port of SaveMii for Aroma. To begin, download the latest [GitHub release](https://github.com/Xpl0itU/savemii/releases) of SaveMii or download it from the [Homebrew App Store](https://hb-app.store).
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/savedatabackup/savemii-appstore.webp" alt="Screenshot of Homebrew App Store page of SaveMii Mod" width="100%">
|
||||
|
||||
Once installed, open the application from the HOME Menu. You should see a menu for Wii U and vWii saves.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/savedatabackup/savemii-mainmenu.webp" alt="SaveMii menu" width="100%">
|
||||
|
||||
Select `Wii U Save Management`. You should now see a list of installed games. Find and select the game you would like to transfer the save data of.
|
||||
|
||||
Select `Backup savedata`.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/savedatabackup/savemii-backup.webp" alt="SaveMii backup save data menu" width="100%">
|
||||
|
||||
Select a new slot to backup the save data to. If you select a non-empty slot, the backup data in that slot will be overwritten.
|
||||
|
||||
Select the profile to backup the save data from. This should be your **_Nintendo_** Network ID.
|
||||
|
||||
Optionally you may select to backup "common" save data. This save data should be shared by all users, and is not required to be backed up. Though you may still do so if you choose.
|
||||
|
||||
Press the `A` button when ready to backup your save data.
|
||||
|
||||
Once the backup has completed, press the `B` button to return to the games menu. Select `Restore savedata`.
|
||||
|
||||
<div class="tip red">
|
||||
<strong>CAUTION:</strong>
|
||||
Restoring a save backup will overwrite the existing save data for the game for the selected user(s). Proceed with caution.
|
||||
</div>
|
||||
|
||||
Select the backup slot you just backed the save data up to.
|
||||
|
||||
Select the profile to restore the save data to. This should be your **_Pretendo_** Network ID.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/savedatabackup/savemii-transfer.webp" alt="SaveMii restore save data menu" width="100%">
|
||||
|
||||
When ready, press the `A` button to transfer your data. Press `A` again to confirm your actions. If you get a message about backing up your data on your Pretendo profile, ignore. Your screen may briefly flash as the data is copied over.
|
||||
|
||||
Once completed, exit SaveMii and ensure the game you transferred works properly on your Pretendo profile.
|
||||
|
||||
<img src="/assets/images/docs/install/wiiu/savedatabackup/savemii-saveworkingonpretendo.webp" alt="Screenshot of a game that loaded successfully" width="100%">
|
||||
|
||||
Repeat this process for any other save data you'd like to transfer to your Pretendo profile.
|
||||
191
content/docs/network-dumps.md
Normal file
191
content/docs/network-dumps.md
Normal file
@@ -0,0 +1,191 @@
|
||||
---
|
||||
description: "Instructions on how to gather network dumps of games."
|
||||
---
|
||||
|
||||
# Network Dumps
|
||||
One of the best ways to support the project is to help in gathering network dumps of games. These network dumps can be used by developers to help understand how the servers operate in a live environment. This kind of data greatly simplifies development of the servers, as it removes a large amount of guesswork and reverse engineering.
|
||||
|
||||
In order to make this easier, we have developed a suite of internal tools to capture and read network traffic, as well as make use of several "off the shelf" tools. This document will go into detail about how to capture these packets yourself, and how you can submit them to us for use in research and development. This document will be fairly long, please read it completely before submitting any dumps.
|
||||
|
||||
## Table of Contents
|
||||
1. [Submissions](#submissions)
|
||||
2. [Game Packets](#game-packets)
|
||||
- [Wii U (HokakuCafe)](#wii-u-hokakucafe)
|
||||
- [3DS (HokakuCTR)](#3ds-hokakuctr)
|
||||
- [All (WireShark)](#all-wireshark)
|
||||
3. [HTTP Packets](#http-packets)
|
||||
4. [SpotPass](#spotpass)
|
||||
5. [High Priority Games](#high-priority-games)
|
||||
|
||||
<div class="tip red">
|
||||
<h2>Security Warning</h2>
|
||||
<strong>Network dumps will oftentimes have sensitive information, including emails, passwords, usernames, IP addresses, etc. Because of this, ensure you only provide network dumps to trusted individuals. When submitting network dumps to Pretendo Network developers your dumps are uploaded and stored in a private channel. This channel can only be accessed by a small number of people, not even all developers have access.</strong>
|
||||
</div>
|
||||
|
||||
# Submissions
|
||||
There are two ways to submit network dumps. You may either contact a developer directly, or use the `/upload-network-dump` command on our Discord server.
|
||||
|
||||
When submitting we ask that you do the following:
|
||||
|
||||
1. Perform as few actions as possible per session. Each session should be focussed on as few aspects of the game as possible to minimize "noise" (unrelated packets) which makes it difficult to decipher what is actually going on. For example, rather than uploading a session of playing random courses on Super Mario Maker it would be more helpful if the session was focussed on one part of the game, such as 100 Mario Challenge, starring a course, etc. That way it's clear exactly what the packets are doing in game.
|
||||
2. When submitting, please provide a detailed description of what was done in the session. For example "Loaded course world and played a random course, starred the course and played a recommended course". This will add further context as to what the packets are doing in the dumps.
|
||||
3. When submitting, please rename the dumps to something meaningful. Such as `played-and-starred-course-smm-jpn.pcap` rather than `did-something.pcap` or `12-20-23.pcap`. This does not apply to HokakuCafe BIN files, as they must remain named as they are. The file name of HokakuCafe BIN gives us important information regarding your session not found in the BIN data itself.
|
||||
|
||||
# Game Packets
|
||||
Game packet dumps are the packets sent during a session to a game server. These packets are typically encrypted, so additional data will need to be submitted in order for us to decrypt them. There are several ways to dump these packets and the data needed to decrypt them.
|
||||
|
||||
### Wii U (HokakuCafe)
|
||||
The easiest way to dump game server packets from a Wii U is to use [HokakuCafe](https://github.com/PretendoNetwork/HokakuCafe). This is an Aroma setup module which patches IOSU to write all network frames to a `.pcap` file on the SD card.
|
||||
|
||||
To use HokakuCafe download the [latest release](https://github.com/PretendoNetwork/HokakuCafe/releases/latest) setup module (`30_hokaku_cafe.rpx`). Place this file on the SD card at `wiiu/environments/[ENVIRONMENT]/modules/setup` and insert it back into the Wii U. Start your Wii U once, turn it off, and open the newly created `HokakuCafe/config.ini` file on the SD card. Set `Mode` to either `UDP` or `ALL`. At the time of writing, HokakuCafe has a bug where it will not dump all game packets when `Mode` is set to `PRUDP`. Insert the SD card back into the Wii U and all network traffic flowing through your console should be written to a PCAP.
|
||||
|
||||
The PCAP files are written to the `HokakuCafe` folder on the SD card, named as the date and time the session was started. HokakuCafe will also dump a BIN file, named `nexServiceToken-AAAAAAAAAA-BBBBBBBB.bin`. This file contains the data needed to decrypt the session packets, and MUST also be submitted. Otherwise the PCAP packets cannot be decrypted, and are of no use.
|
||||
|
||||
### 3DS (HokakuCTR)
|
||||
The easiest way to dump game server packets from a 3DS is to use [HokakuCTR](https://github.com/PretendoNetwork/HokakuCTR). Like HokakuCafe this homebrew attempts to dump game traffic directly from the console. However unlike HokakuCafe, it does not dump all system traffic and may not work in all games. If HokakuCTR does not work in your game, see the last solution.
|
||||
|
||||
To use HokakuCTR, ensure you are updated to the latest Luma release. The latest Luma release now supports 3GX plugins. Download the [latest release](https://github.com/PretendoNetwork/HokakuCTR/releases/latest). Place this file on the SD card at `luma/plugins` and rename it `default.3gx`.
|
||||
|
||||
When launching a game you will see 1 of 2 notifications on screen. You will either see `Not Ready` or `Ready`. If you see `Not Ready`, your game is not compatible. If you see `Ready`, your game is compatible but has not necessarily started sending data. If you see nothing, either your game is not compatible, the plugin loader is disabled or the plugin is not installed. You can check if the plugin loader is disabled by opening the Rosalina menu (L + D-Pad down + Select) and ensure the "Plugin Loader" option is enabled. If your game is compatible, it will start dumping game traffic to a PCAP file once the game has connected to the server and begun sending data. You will know the game has connected to the server when you see either `Detected NEX buffer type: V0` or `Detected NEX buffer type: V1` on screen. These notifications indicate that the game has begun sending data. If you do not see one of these notifications, no data will be in your dump.
|
||||
|
||||
The PCAP is written to the SD card located at `HokakuCTR/[GAME NAME]`. HokakuCTR dumps are already decrypted, no additional data is required to decrypt them. They may be submitted as-is.
|
||||
|
||||
### All (WireShark)
|
||||
If neither solution above works, the only option you have is to capture the traffic manually off the console. This is easiest done with WireShark and a hosted Wi-Fi access point. Create a hosted wifi access point on your PC which has WireShark installed and select that access point's interface in WireShark. Connect the console to this hosted access point, and you should begin to see all the network traffic from your console in WireShark. In order to both create a hosted access point and keep your PC online, you must have 2 ways of connecting to the internet on the PC. This is easiest done by using a USB Wi-Fi adapter to host the access point, and using ethernet to remain online. Not all USB Wi-Fi adapters support hosting access points. Ensure the one you use does. [This adapter](https://www.amazon.com/dp/B07C9TYDR4) is relatively cheap and supports hosting access points.
|
||||
|
||||
Just like with HokakuCafe, traffic dumped with WireShark will be encrypted. In order to decrypt the traffic, your NEX account username and password must also be submitted. Your NEX account has no relation to any other account, such as your NNID, and cannot be used to gain any information about you. It can, however, allow someone to log into game servers as you. Ensure you only provide these details to trusted individuals.
|
||||
|
||||
- 3DS - To dump your NEX username and password from a 3DS download and run [this homebrew application](https://9net.org/~stary/get_3ds_pid_password.3dsx). This will create a file on your SD card named `nex-keys.txt` with your NEX username and password. Copy and paste the contents of this file into the message of your submission.
|
||||
- Wii U - To dump your NEX username and password from a Wii U connect to your Wii U with an FTP client. Navigate to `/storage_mlc/usr/save/system/act` and download all the folders inside this folder. Check the `account.dat` file in each folder and look for your NNID username in the `AccountId` field. Once found, in the same `account.dat` file locate both the `PrincipalId` and `NfsPassword` fields. `PrincipalId` is your NEX username (PID), and `NfsPassword` is your NEX password.
|
||||
|
||||
# HTTP Packets
|
||||
Some games use HTTP requests for some features. Additionally, non-game titles will often use HTTP requests for their services. SpotPass data is also downloaded via HTTP requests. The above methods will not always capture HTTP requests in a way that is usable, if at all. For this, an HTTP proxy server is required. There are several options for HTTP proxy servers, however the simplest way is using our [mitmproxy Docker container](https://github.com/PretendoNetwork/mitmproxy-nintendo).
|
||||
|
||||
Full credit to the upkeep of the repository, and creation of the original Docker container, goes to GitHub user [MatthewL246](https://github.com/MatthewL246).
|
||||
|
||||
<div class="tip">
|
||||
<h2>Using a Raspberry Pi?</h2>
|
||||
<strong>Only 64 bit operating systems are supported. If using a Raspberry Pi, ensure you are using a 64 bit variant of your OS.</strong>
|
||||
</div>
|
||||
|
||||
Install Docker for your operating system using the official [setup guide](https://docs.docker.com/get-docker/). If installing on Windows, you ***MUST*** use the WSL backend option. Then follow the steps for your console type.
|
||||
|
||||
## 3DS
|
||||
1. Download [this IPS patch](https://github.com/PretendoNetwork/mitmproxy-nintendo/raw/master/ssl-patches/0004013000002F02.ips). This IPS patch patches the SSL sysmodule to disable SSL verification, allowing the console to connect to the proxy server with TLS connections.
|
||||
2. Place the patch on your SD card at `SD:/luma/sysmodules/0004013000002F02.ips`.
|
||||
3. Place the SD card back into your 3DS.
|
||||
4. Launch into the Luma settings by holding `SELECT` while powering on.
|
||||
5. Ensure both `Enable loading external FIRMS and modules` and `Enable game patching` are enabled before booting.
|
||||
6. Launch Nimbus and connect to Nintendo Network.
|
||||
7. On your computer, open a command prompt and run the following commands:
|
||||
8. `mkdir 3ds-dumps`
|
||||
9. `docker run -it --rm -p 8083:8083 -v ./3ds-dumps:/home/mitmproxy/dumps ghcr.io/pretendonetwork/mitmproxy-nintendo:3ds mitmdump`
|
||||
- If using Windows, run `wsl docker run -it --rm -p 8083:8083 -v ./3ds-dumps:/home/mitmproxy/dumps ghcr.io/pretendonetwork/mitmproxy-nintendo:3ds mitmdump`
|
||||
10. These commands create a directory to store the sessions dumps, and starts the proxy server using Docker, exposing the servers port 8083 on your computers port also on 8083, and links the `/home/mitmproxy/dumps` directory in the container to the `3ds-dumps` directory you just created.
|
||||
11. On your 3DS, launch into Internet Settings and select your connection.
|
||||
12. Select `Change Settings > Proxy Settings`.
|
||||
13. Select `Yes` and then `Detailed Setup`.
|
||||
14. Enter your computers local IP address into `Proxy Server` and 8083 into `Port`.
|
||||
15. Select `Ok` then `Save` and run the connection test. Your 3DS should connect to the internet and you should see connections being made in the proxy server
|
||||
16. See the end of this section for final steps.
|
||||
|
||||
## Wii U
|
||||
1. Download [this Aroma setup module](https://github.com/PretendoNetwork/mitmproxy-nintendo/raw/master/ssl-patches/30_nossl.rpx). This patches the SSL sysmodule to disable SSL verification, allowing the console to connect to the proxy server with TLS connections.
|
||||
2. Place the patch on your SD card at `SD:/wiiu/environments/aroma/modules/setup/30_nossl.rpx`. If there are other patches with the same ID `30`, this is fine.
|
||||
3. Place the SD card back into your Wii U and turn on the console.
|
||||
4. Launch into the Aroma settings by pressing `L + DPAD-DOWN + SELECT`.
|
||||
5. Enter `Inkay > Patching` and toggle `Connect to the Pretendo Network` to ***FALSE***.
|
||||
6. On your computer, open a command prompt and run the following commands:
|
||||
7. `mkdir wiiu-dumps`
|
||||
8. `docker run -it --rm -p 8082:8082 -v ./wiiu-dumps:/home/mitmproxy/dumps ghcr.io/pretendonetwork/mitmproxy-nintendo:wiiu mitmdump`
|
||||
- If using Windows, run `wsl docker run -it --rm -p 8082:8082 -v ./wiiu-dumps:/home/mitmproxy/dumps ghcr.io/pretendonetwork/mitmproxy-nintendo:wiiu mitmdump`
|
||||
9. These commands create a directory to store the sessions dumps, and starts the proxy server using Docker, exposing the servers port 8082 on your computers port also on 8082, and links the `/home/mitmproxy/dumps` directory in the container to the `wiiu-dumps` directory you just created.
|
||||
10. On your Wii U, launch into `System Settings > Internet > Connect to the Internet > Connections` and select your connection.
|
||||
11. Select `Change Settings > Proxy Settings`.
|
||||
12. Select `Set` and `OK`.
|
||||
13. Enter your computers local IP address into `Proxy Server` and 8082 into `Port`.
|
||||
14. Select `Confirm`, `Don't Use`, then `Save` and run the connection test. Your Wii U should connect to the internet and you should see connections being made in the proxy server
|
||||
15. See the end of this section for final steps.
|
||||
|
||||
## Final Steps
|
||||
Once you have the proxy server running and your console connected to it, use the console as normal. When you are finished capturing a session, press `CTRL` and `C` in the command prompt running the proxy server to end the session. Ending a session will create a `wiiu-dumps/wiiu-latest.har` file or `3ds-dumps/3ds-latest.har` file depending on which console was used for the session. These files will be overwritten at the start of each new session, so they must be backed up or renamed to avoid losing their data.
|
||||
|
||||
For advanced usage of the proxy server, see https://github.com/PretendoNetwork/mitmproxy-nintendo
|
||||
|
||||
# SpotPass
|
||||
SpotPass data, also called BOSS content, is sent using HTTP. The easiest way to submit SpotPass information to us is by dumping your consoles BOSS database. These databases contain SpotPass information for all games which you have enabled SpotPass for. This will give us the data needed to archive SpotPass content ourselves. Alternatively, you may submit [HTTP network dumps](#http-packets). Submitting HTTP network dumps gives us the SpotPass content as well, but requires more work on users.
|
||||
|
||||
For a list of games which use SpotPass content and still need to be archived, see [this spreadsheet](https://docs.google.com/spreadsheets/d/1qU0o7zxILAZcI83nOidr1QSrM0maVp6OGdBqg0xwul0/edit?usp=sharing).
|
||||
|
||||
<div class="tip">
|
||||
<strong>This spreadsheet was generated automatically. It may be incomplete and missing games or regions. Even if your game is not on this list we encourage you to upload HTTP dumps of it.</strong>
|
||||
</div>
|
||||
|
||||
SpotPass content is region specific, so dumps of one games region may not work for a games other regions. All of a games regions must be checked and archived.
|
||||
|
||||
If you are uploading HTTP network dumps, please include the name of the game and it's region in your description.
|
||||
|
||||
If you are uploading your BOSS database, ensure your game has registered your BOSS tasks. Typically a game will register all of it's tasks once SpotPass is enabled for the game. A game may require you to be online before asking to enable SpotPass, but this depends on the game.
|
||||
|
||||
We encourage everyone to upload their task databases, even if you have not been online in a long time. These databases may contain SpotPass information from games you have played in the past.
|
||||
|
||||
## Wii U
|
||||
The Wii U stores a separate database of BOSS tasks per user. Each one must be dumped and submitted individually.
|
||||
|
||||
1. Connect to the Wii U using [FTP](https://wiki.hacks.guide/wiki/Wii_U:FTP#Aroma-0).
|
||||
2. Navigate to `/storage_mlc/usr/save/system/boss`.
|
||||
3. Copy all the folders in this directory to your PC.
|
||||
4. Submit the `task.db` file in each folder using Bandwidth.
|
||||
|
||||
## 3DS
|
||||
The 3DS stores BOSS tasks in a single partition in the BOSS sysmodule.
|
||||
|
||||
1. Launch [GodMode9](https://github.com/d0k3/GodMode9).
|
||||
2. Navigate to `SYSNAND CTRNAND > data > longstring > sysdata > 00010034`.
|
||||
3. Select `00000000`. If your file is not named `00000000` you may still continue, though we cannot guarantee this is the correct file. If you have more than one file, repeat the following steps for each.
|
||||
4. Select `Mount as DISA image`.
|
||||
5. Press `A` to mount and enter the image.
|
||||
6. Select `partitionA.bin`. If your file is not named `partitionA.bin` you may still continue, though we cannot guarantee this is the correct file. If you have more than one file, repeat the following steps for each.
|
||||
7. Select `Copy to 0:/gm9/out`.
|
||||
8. Turn off your console and eject the SD card.
|
||||
9. Open your SD card on your computer.
|
||||
10. Submit the partition BIN file using Bandwidth.
|
||||
|
||||
# High Priority Games
|
||||
While all games are important to capture dumps for, this is a list of games we have identified as being high priority. All games on Nintendo Network share a common set of protocols used to implement the games online features, making it easy to use work from one game on many others. However these games have game-specific patches to their protocols, or even entirely custom ones, making this much harder to work with, especially after the official servers go down. Dumps for these games are considered high priority, but they should not be the only games dumped for. All games are important.
|
||||
|
||||
## 3DS
|
||||
- `Animal Crossing - Happy Home Designer`
|
||||
- `Daigassou! Band Brothers P (Japan)`
|
||||
- `Kid Icarus: Uprising`
|
||||
- `Miitopia`
|
||||
- `Monster Hunter Generations`
|
||||
- `Nintendo Badge Arcade`
|
||||
- `Pokemon Omega Ruby / Alpha Sapphire`
|
||||
- `Pokemon Rumble World`
|
||||
- `Pokemon Sun / Moon`
|
||||
- `Pokemon Ultra Sun / Ultra Moon`
|
||||
- `Pokemon X / Y`
|
||||
- `Real Dasshutsu Game x Nintendo 3DS - Chou Hakai Keikaku kara no Dasshutsu (Japan)`
|
||||
- `Super Mario Maker for Nintendo 3DS`
|
||||
- `Super Smash Bros for Nintendo 3DS`
|
||||
- `Yakuman Houou Mahjong (Japan)`
|
||||
|
||||
## Wii U
|
||||
- `MARIO KART 8`
|
||||
- `MONSTER HUNTER 3 ULTIMATE Packet Relay...for Nintendo 3DS`
|
||||
- `MONSTER HUNTER 3(tri-)G HD Ver.`
|
||||
- `SUPER MARIO 3D WORLD`
|
||||
- `Splatoon` (All Splatoon games likely have the same patches)
|
||||
- `Splatoon (Demo)`
|
||||
- `Splatoon Global Testfire`
|
||||
- `Splatoon Pre-Launch Review`
|
||||
- `Splatoon Testfire`
|
||||
- `Super Mario Maker`
|
||||
- `Super Smash Bros. for Wii U`
|
||||
- `Wii KARAOKE U by JOYSOUND`
|
||||
- `Wii Sports Club`
|
||||
- `Wii Sports Club Lite`
|
||||
- `Nintendo×JOYSOUND Wii カラオケ U`
|
||||
- `Xenoblade Chronicles X`
|
||||
- `役満 鳳凰`
|
||||
Reference in New Issue
Block a user