diff --git a/docs/en_US/install/azahar.md b/docs/en_US/install/azahar.md new file mode 100644 index 0000000..e6ccedd --- /dev/null +++ b/docs/en_US/install/azahar.md @@ -0,0 +1,113 @@ +# Azahar + +
+ CAUTION: + 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. +
+ +
+ ℹ️ Azahar requires 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 Homebrewed System running the latest version of Luma3DS (v13.3.1 or higher). If you don't, please follow this guide on how to install homebrew to your system first. +
+ +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 here. + +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 + +
+ ℹ️ Before opening Artic Setup Tool, ensure that your 3DS/2DS is on the same Wi-Fi network as the computer running Azahar. +
+ +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. + + + +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. This is normal. Enter your 3DS/2DS IP address into the text box in Azahar and click OK. + + + +
+ ⚠️ If you see an error that says "Missing OTP backup on SD card", you need to run a program to recreate the backup. Put otp_dump.firm 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. +
+ +
+ ⚠️ 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. Please note that "Country" and "Region" are two separate drop-down boxes in Azahar. "Country" is the one that needs to be changed to fix this issue. +
+ +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. + + + +After a few minutes, Azahar will notify you that the update is complete. Click OK to continue. You are not finished with Artic Setup Tool. + +In Azahar, click `File` and `Set Up System Files...` again. Enter the IP address again, but this time, click `New 3DS Setup`. This is required and will work regardless of whether or not your system is a New 3DS/2DS. Click OK. + + + +Once again, a screen will appear on Azahar telling you to "update your system". Click OK to allow it to proceed. + + + +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. + + + +## 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. + + + +Reopen Nimbus and click the Pretendo button. Once you have switched to Pretendo, click `Emulation` and then `Stop` to exit Nimbus again. + + + +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. diff --git a/docs/en_US/install/citra.md b/docs/en_US/install/citra.md index 092db32..76ab099 100644 --- a/docs/en_US/install/citra.md +++ b/docs/en_US/install/citra.md @@ -1,5 +1,3 @@ # Citra -At the moment Citra does not support true online play, so it doesn't work with Pretendo. Moreover, it shows no sign of supporting true play in the future. - -Mikage, a 3DS emulator for mobile devices, may provide support in the future, though this is far from certain. +Citra is not supported. Please use Azahar instead. diff --git a/public/assets/images/docs/install/azahar/artic_setup_tool.png b/public/assets/images/docs/install/azahar/artic_setup_tool.png new file mode 100644 index 0000000..bcafa26 Binary files /dev/null and b/public/assets/images/docs/install/azahar/artic_setup_tool.png differ diff --git a/public/assets/images/docs/install/azahar/azahar_emulation_configure_LLE_module.png b/public/assets/images/docs/install/azahar/azahar_emulation_configure_LLE_module.png new file mode 100644 index 0000000..ff0772f Binary files /dev/null and b/public/assets/images/docs/install/azahar/azahar_emulation_configure_LLE_module.png differ diff --git a/public/assets/images/docs/install/azahar/azahar_nimbus_pretendo_select.png b/public/assets/images/docs/install/azahar/azahar_nimbus_pretendo_select.png new file mode 100644 index 0000000..09d761d Binary files /dev/null and b/public/assets/images/docs/install/azahar/azahar_nimbus_pretendo_select.png differ diff --git a/public/assets/images/docs/install/azahar/azahar_nimbus_update.png b/public/assets/images/docs/install/azahar/azahar_nimbus_update.png new file mode 100644 index 0000000..8503e50 Binary files /dev/null and b/public/assets/images/docs/install/azahar/azahar_nimbus_update.png differ diff --git a/public/assets/images/docs/install/azahar/azahar_set_up_enterIP.png b/public/assets/images/docs/install/azahar/azahar_set_up_enterIP.png new file mode 100644 index 0000000..af902ce Binary files /dev/null and b/public/assets/images/docs/install/azahar/azahar_set_up_enterIP.png differ diff --git a/public/assets/images/docs/install/azahar/azahar_set_up_enterIP_N3DS.png b/public/assets/images/docs/install/azahar/azahar_set_up_enterIP_N3DS.png new file mode 100644 index 0000000..7785e1c Binary files /dev/null and b/public/assets/images/docs/install/azahar/azahar_set_up_enterIP_N3DS.png differ diff --git a/public/assets/images/docs/install/azahar/azahar_set_up_sysupdate.png b/public/assets/images/docs/install/azahar/azahar_set_up_sysupdate.png new file mode 100644 index 0000000..8abdb87 Binary files /dev/null and b/public/assets/images/docs/install/azahar/azahar_set_up_sysupdate.png differ diff --git a/public/assets/images/docs/install/azahar/azahar_set_up_sysupdate_N3DS.png b/public/assets/images/docs/install/azahar/azahar_set_up_sysupdate_N3DS.png new file mode 100644 index 0000000..c9d95fa Binary files /dev/null and b/public/assets/images/docs/install/azahar/azahar_set_up_sysupdate_N3DS.png differ diff --git a/public/assets/images/docs/install/icons/azahar.svg b/public/assets/images/docs/install/icons/azahar.svg new file mode 100644 index 0000000..60758eb --- /dev/null +++ b/public/assets/images/docs/install/icons/azahar.svg @@ -0,0 +1,41 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/views/docs/install.handlebars b/views/docs/install.handlebars index 837ae47..ed59a04 100644 --- a/views/docs/install.handlebars +++ b/views/docs/install.handlebars @@ -57,6 +57,10 @@ Cemu logo Cemu + + Azahar logo + Azahar + Citra logo Citra diff --git a/views/partials/docs-sidebar.handlebars b/views/partials/docs-sidebar.handlebars index 30fe685..d5a5b03 100644 --- a/views/partials/docs-sidebar.handlebars +++ b/views/partials/docs-sidebar.handlebars @@ -11,6 +11,7 @@ Wii U 3DS Cemu + Azahar Citra Miiverse Submit network dumps