Merge pull request #225 from PretendoNetwork/docs-update

Documentation update
This commit is contained in:
Jonathan Barrow
2023-10-14 11:51:22 -04:00
committed by GitHub
11 changed files with 60 additions and 79 deletions

View File

@@ -1,16 +1,23 @@
# 3DS/2DS Family
<div class="tip">
This guide assumes that you have a <b>Homebrewed System running the latest version of Luma3DS</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.
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. [Using Nimbus](#using-nimbus)
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 you start, 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).
@@ -21,12 +28,22 @@ Nimbus is available as both a 3DSX app and an installable CIA. The releases page
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.
You should now have the `0004013000002F02`, `0004013000003202`, and `0004013000003802` Luma patches along with the `nimbus.3dsx` and `nimbus.cia` homebrew.
Ensure your SD card has all the following files
<img src="/assets/images/docs/install/3ds/sd-card-luma.png" width=100% height=auto/>
<img src="/assets/images/docs/install/3ds/sd-card-3ds.png" width=100% height=auto/>
- `SD:/luma/titles/000400300000BC02/code.ips` (Miiverse, JPN)
- `SD:/luma/titles/000400300000BD02/code.ips` (Miiverse, USA)
- `SD:/luma/titles/000400300000BE02/code.ips` (Miiverse, EUR)
- `SD:/luma/sysmodules/0004013000002F02.ips` (SSL)
- `SD:/luma/sysmodules/0004013000003202.ips` (FRD/Friends)
- `SD:/luma/sysmodules/0004013000003802.ips` (ACT/NNID)
- `SD:/3ds/juxt-prod.pem` (Juxtaposition certificate)
Place your SD card back into your console.
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
@@ -38,15 +55,15 @@ In order to make use of the Pretendo Network service, you will need to enable Lu
On the screen that is displayed, make sure that these following options are enabled:
* `Enable loading external FIRMS and modules`
* `Enable game patching`
- `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>
<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.
@@ -63,11 +80,11 @@ Your selection persists between reboots.
## Signing into your PNID
To fully enjoy Pretendo Network, you'll need to sign into your PNID. It's not required for most things, but it's worth doing in case you need it in the future. If you haven't already, please [create a Pretendo account](/account) on your computer or phone before following the rest of the guide.
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>.
On your 3DS, open up System Settings and tap on Nintendo Network ID Settings. It'll take a while to load, but once you do, follow along until the part where you get asked whether you want to link your account. Select `Yes` and use the credentials you used to create your Pretendo account. Once you've done that, continue normally and you should be all set up.
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 at a later date
Congratulations! You can now use Pretendo Network and enjoy 3DS games online even after April 2024.
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
## Other information
@@ -76,3 +93,7 @@ Nimbus will create a 2nd local account set to the `test` NASC environment. The I
### 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>

View File

@@ -4,66 +4,34 @@
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>
<div class="tip yellow">
<b>Pretendo Network is currently in a closed beta. Not all features, including game servers and Miiverse, are open to the public</b>.
</div>
Juxtaposition is the Pretendo Network replacement for the now defunct Miiverse service
## Select your console
- ### [Wii U (Tiramisu)](#wii-u-tiramisu-1)
- ### [Wii U](#wii-u)
- ### [3DS](#3ds-1)
# Wii U (Tiramisu)
# Wii U
<div class="tip">
<b>Aroma users</b>: The Aroma patcher already handles ingame patches and redirects the Miiverse applet to Juxtaposition - no further setup is needed.
The below instructions are <b>only for Tiramisu users</b>.<br/>
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>
<div class="tip">
⚠️ Note that Tiramisu is no longer supported by Pretendo and cannot receive the latest network and <b>security patches</b>. These instructions
are kept for legacy users only.
</div>
Navigate to the [releases](https://github.com/PretendoNetwork/Martini/releases) page on the Martini GitHub repository
<img src="/assets/images/docs/install/juxt/martini-highlight.png" width=100% height=auto/>
Select the `martini-juxt-patcher.rpx` to download it
<img src="/assets/images/docs/install/juxt/martini-download.png" width=100% height=auto/>
Copy `martini-juxt-patcher.rpx` and place it on your SD card at `sd:/wiiu/apps/`
<img src="/assets/images/docs/install/juxt/martini-sd-card.png" width=100% height=auto/>
Place your SD card back into your console and boot like normal.
Open the Homebrew Launcher and launch `martini-juxt-patcher.rpx`
<img src="/assets/images/docs/install/juxt/martini-hbl.png" width=100% height=auto/>
After confirming the state of the Miiverse applet, press A to apply the patches.
<img src="/assets/images/docs/install/juxt/martini-install.png" width=100% height=auto/>
Once the patcher is done running and your console has rebooted, you're done! Have fun in Juxt!
<img src="/assets/images/docs/install/juxt/martini-success.png" width=100% height=auto/>
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://invite.gg/pretendo).
# 3DS
<div class="tip yellow">
⚠️ Nimbus will overwrite existing patches for services such as Rverse. As such, use with caution
</div>
<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
Nimbus already takes care of most in game patches for miiverse, so you're already good to go!
### Applet Patch
First, download `Juxt.zip` from [here](https://cdn.discordapp.com/attachments/911878047895023637/937516295069515866/Juxt.zip).
Extract `Juxt.zip` and copy the `3ds` and `luma` folders to the root of your SD card. You should now have the `000400300000BC02`, `000400300000BD02`, and `000400300000BE02` Luma patches along with the `juxt.pem` cert
<img src="/assets/images/docs/install/juxt/3ds-sd-card.png" width=100% height=auto/>
Place your SD card back into your console. Boot your console and ensure Luma patches are enabled.
That's it! Have fun in Juxt!
Miiverse content inside of games is not supported on the 3DS at this time.

View File

@@ -40,11 +40,11 @@ Place your SD card back into your console and boot like normal.
Already have Pretendo installed? Skip ahead to <a href="#pnid-setup">PNID Setup</a>!
</div>
To connect to Pretendo Network you must use the [Inkay](https://github.com/PretendoNetwork/Inkay) plugin with Aroma.
To connect to Pretendo Network you must use the [Inkay](https://github.com/PretendoNetwork/Inkay) plugin with Aroma.
The stable version is recommended for most users, however betatesters and others may be interested in the bleeding edge version.
## Stable
Navigate to [Inkay's latest release](https://github.com/PretendoNetwork/Inkay/releases/latest) on GitHub and download the `Inkay-pretendo.wps` file from the latest release.
The stable builds have been widely tested to ensure everything works as intended. Navigate to [Inkay's latest release](https://github.com/PretendoNetwork/Inkay/releases/latest) on GitHub and download the `Inkay-pretendo.wps` file from the latest release.
<img src="/assets/images/docs/install/wiiu/aroma/wps-highlight.png" width="100%">
@@ -59,19 +59,7 @@ Place your SD card back into your console and boot like normal. If it worked, yo
You are now connected to Pretendo Network and can continue with [PNID Setup](#pnid-setup).
## Bleeding Edge
Navigate to the [actions](https://github.com/PretendoNetwork/Inkay/actions) page on the Aroma GitHub repository.
<img src="/assets/images/docs/install/wiiu/aroma/actions-highlight.png" width="100%">
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._
<img src="/assets/images/docs/install/wiiu/aroma/workflow-highlight.png" width="100%">
Select the `inkay` artifact. This will download a `inkay.zip` zip file.
<img src="/assets/images/docs/install/wiiu/aroma/artifact-highlight.png" width="100%">
Extract `inkay.zip` and place the extracted `Inkay-pretendo.wps` file on your SD card at `sd:/wiiu/environments/aroma/plugins`.
Bleeding edge builds have not been widely tested, and do not guarantee any stability. Download the latest build from <a href="https://nightly.link/PretendoNetwork/Inkay/workflows/ci/main/inkay" target="_blank">nightly</a>. Extract `inkay.zip` and place the extracted `Inkay-pretendo.wps` file on your SD card at `sd:/wiiu/environments/aroma/plugins`.
<img src="/assets/images/docs/install/wiiu/aroma/sd-card.png" width="100%">
@@ -90,7 +78,7 @@ You will want to register an account from [here](/account) and click `Don't have
<img src="/assets/images/docs/install/wiiu/pnid/register-account-web.png" width="100%">
Right before registering a PNID, please make sure to save your password on some sort of note. This isn't necessary, but it prevents having to reset your password if you forget it. After registering just simply change your birth date, gender, timezone, country/region, etc to what you see fit. Once you have it set up we can switch back to the Wii U. Within your Wii U you will want to reconnect to Pretendo.
Right before registering a PNID, please make sure to save your password on some sort of note. This isn't necessary, but it prevents having to reset your password if you forget it. After registering just simply change your birth date, gender, timezone, country/region, etc to what you see fit. Once you have it set up we can switch back to the Wii U. Within your Wii U you will want to reconnect to Pretendo.
_**Note:** How you reconnect to Pretendo depends on how you installed it on your Wii U!_

View File

@@ -166,6 +166,9 @@ button#openSidebar {
background: var(--accent-shade-2);
opacity: 1;
}
.docs-wrapper .content-inner div.tip.yellow::after {
background: var(--yellow-shade-1);
}
.docs-wrapper .content-inner div.tip.red::after {
background: var(--red-shade-1);
}

View File

@@ -23,6 +23,7 @@
--green-shade-1: #59c9a5;
--red-shade-1: #a9375b;
--yellow-shade-1: #ffd966;
--border: rgba(255, 255, 255, 0.1);
}

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

View File

@@ -12,7 +12,7 @@
<a href="/docs/install/3ds">3DS</a>
<a href="/docs/install/cemu">Cemu</a>
<a href="/docs/install/citra">Citra</a>
<a href="/docs/install/juxt">Juxt</a>
<a href="/docs/install/juxt">Miiverse</a>
</div>
<div class="section">