diff --git a/site/content/downloads.md b/site/content/downloads.md index fed0376..813b527 100644 --- a/site/content/downloads.md +++ b/site/content/downloads.md @@ -18,7 +18,7 @@ Please download and install the dependency from below.

The installer will allow you to download your preferred release channel. -If you are a Patreon subscriber, the "Early Access" channel will be available to you, and will provide early access to exciting experimental changes on top of what is available in the main channel. Please follow our [Early Access guide](https://yuzu-mirror.github.io/help/early-access/) for assistance linking your Patreon account. +If you are a Patreon subscriber, the "Early Access" channel will be available to you, and will provide early access to exciting experimental changes on top of what is available in the main channel. Please follow our [Early Access guide](https://yuzu-emu.org/help/early-access/) for assistance linking your Patreon account. Intel and AMD users are strongly recommended to switch to Vulkan by going to `Emulation > Configure > Graphics > API`. Latest GPU drivers are recommended. diff --git a/site/content/help/_index.md b/site/content/help/_index.md new file mode 100644 index 0000000..ac4f37d --- /dev/null +++ b/site/content/help/_index.md @@ -0,0 +1,7 @@ ++++ +title = "Help" ++++ + +User documentation on how to use yuzu and frequently asked questions can be found here. + +If you would like more information on a subject, please contact our moderation team on Discord. diff --git a/site/content/help/early-access/1.png b/site/content/help/early-access/1.png new file mode 100644 index 0000000..6933551 Binary files /dev/null and b/site/content/help/early-access/1.png differ diff --git a/site/content/help/early-access/2.png b/site/content/help/early-access/2.png new file mode 100644 index 0000000..c503750 Binary files /dev/null and b/site/content/help/early-access/2.png differ diff --git a/site/content/help/early-access/3.png b/site/content/help/early-access/3.png new file mode 100644 index 0000000..a8e4204 Binary files /dev/null and b/site/content/help/early-access/3.png differ diff --git a/site/content/help/early-access/4.png b/site/content/help/early-access/4.png new file mode 100644 index 0000000..e82a00a Binary files /dev/null and b/site/content/help/early-access/4.png differ diff --git a/site/content/help/early-access/5.png b/site/content/help/early-access/5.png new file mode 100644 index 0000000..4ec4b5c Binary files /dev/null and b/site/content/help/early-access/5.png differ diff --git a/site/content/help/early-access/6.png b/site/content/help/early-access/6.png new file mode 100644 index 0000000..8f6edf2 Binary files /dev/null and b/site/content/help/early-access/6.png differ diff --git a/site/content/help/early-access/7.png b/site/content/help/early-access/7.png new file mode 100644 index 0000000..723ca10 Binary files /dev/null and b/site/content/help/early-access/7.png differ diff --git a/site/content/help/early-access/8.png b/site/content/help/early-access/8.png new file mode 100644 index 0000000..b47238d Binary files /dev/null and b/site/content/help/early-access/8.png differ diff --git a/site/content/help/early-access/index.md b/site/content/help/early-access/index.md new file mode 100644 index 0000000..c67a577 --- /dev/null +++ b/site/content/help/early-access/index.md @@ -0,0 +1,92 @@ +--- +title: yuzu Early Access +description: A guide designed to help you with installing yuzu Early Access. +--- + +## What is yuzu Early Access? +yuzu `Early Access` is a release channel that includes all the same daily yuzu updates that you are accustomed to, plus the early releases of features that you have typically seen in special Patreon releases! +Instead of downloading manual builds from patreon, you'll get these new `Early Access` builds directly via the Installer (future updates included). + +  + +
+ +
+ +  + +## How do I install yuzu Early Access? + +#### Step 1 +If you already are a Patron at $5/month or more, move on to `Step 2.` +Otherwise, you need to become a Patron at the `Early Access tier.` [**Click here to subscribe**](https://www.patreon.com/join/yuzuteam/checkout?rid=2822069) + +{{< imgs + "./1.png|yuzu Patreon" +>}} + +#### Step 2 +Next, you need to login to your yuzu profile page. +Click on the link given below to proceed.
+yuzu profile page
+ +>

By clicking on the link, a new tab will open, redirecting you to the Citra Community forum. +As both Citra and yuzu share a common Discourse forum, you'll have to either log in with those credentials or create a new account there. +Users also have the option of signing in using their existing Google or GitHub account.

+ +{{< imgs + "./2.png|yuzu Profile Login" +>}} + +#### Step 3 +When logged in, you should see your yuzu profile details. Click `Link Patreon Account` and login with your Patreon credentials. + +{{< imgs + "./3.png|yuzu Profile Information" +>}} + +#### Step 4 +You should now find that you have `early-access` as one of your Active release channels, and your Patreon account should indicate that it is `Linked` and `Subscribed`. + +{{< imgs + "./4.png|Profile Link Status" +>}} + +#### Step 5 +Now that your account is linked, copy your login token by highlighting the text and pressing `CTRL + C` on your keyboard. + +{{< imgs + "./5.png|yuzu Profile token" +>}} + +#### Step 6 +Next, download and run the latest version of the Installer: [**Click here to download.**](https://yuzu-emu.org/downloads/) +You should see an option to select the `Early Access` release channel. + +**Note:** `Early Access` includes all the same features and updates as the regular yuzu, so you don’t need to install both! + +{{< imgs + "./6.png|yuzu Installer (Updated)" +>}} + +#### Step 7 +On the next page of the installer, paste the token you previously copied in `Step 4` by selecting the `Token Entry Box` and pressing `CTRL + V` on your keyboard, and then click `Verify Token` to authenticate. + +{{< imgs + "./7.png|Verify token" +>}} + +#### Step 8 +If all of the above steps were completed successfully, verification should succeed and you should be able to complete the installation of `Early Access.` + +{{< imgs + "./8.png|yuzu Start Menu Icons" +>}} + +As long as you keep your Patreon subscription valid, you will continue to receive Patreon-specific updates, as well as regular yuzu updates, automatically by just running `yuzu Early Access` from your Start menu. + +## Additional Step +All Patreon subscribers with a pledge of 5$ or above, are eligible for Discord rewards. +Patrons need to link their Discord account with their Patreon account to gain access to exclusive support channels on our [Discord server](https://discord.gg/u77vRWY). + +For instructions on how to link your Discord account with your Patreon account, click here!
diff --git a/site/content/help/early-access/yuzu-banner-early-access-white.svg b/site/content/help/early-access/yuzu-banner-early-access-white.svg new file mode 100644 index 0000000..1d2bb15 --- /dev/null +++ b/site/content/help/early-access/yuzu-banner-early-access-white.svg @@ -0,0 +1 @@ +newAsset 3 \ No newline at end of file diff --git a/site/content/help/feature/boxcat/botw-steak.png b/site/content/help/feature/boxcat/botw-steak.png new file mode 100644 index 0000000..ce3aea9 Binary files /dev/null and b/site/content/help/feature/boxcat/botw-steak.png differ diff --git a/site/content/help/feature/boxcat/hint-1-1.png b/site/content/help/feature/boxcat/hint-1-1.png new file mode 100644 index 0000000..94574bf Binary files /dev/null and b/site/content/help/feature/boxcat/hint-1-1.png differ diff --git a/site/content/help/feature/boxcat/hint-2-1.png b/site/content/help/feature/boxcat/hint-2-1.png new file mode 100644 index 0000000..32b3005 Binary files /dev/null and b/site/content/help/feature/boxcat/hint-2-1.png differ diff --git a/site/content/help/feature/boxcat/hint-4-1.png b/site/content/help/feature/boxcat/hint-4-1.png new file mode 100644 index 0000000..b6c35ab Binary files /dev/null and b/site/content/help/feature/boxcat/hint-4-1.png differ diff --git a/site/content/help/feature/boxcat/hint-5-1.png b/site/content/help/feature/boxcat/hint-5-1.png new file mode 100644 index 0000000..0772233 Binary files /dev/null and b/site/content/help/feature/boxcat/hint-5-1.png differ diff --git a/site/content/help/feature/boxcat/hint-6-1.png b/site/content/help/feature/boxcat/hint-6-1.png new file mode 100644 index 0000000..a44ad7d Binary files /dev/null and b/site/content/help/feature/boxcat/hint-6-1.png differ diff --git a/site/content/help/feature/boxcat/index.md b/site/content/help/feature/boxcat/index.md new file mode 100644 index 0000000..66bcaf9 --- /dev/null +++ b/site/content/help/feature/boxcat/index.md @@ -0,0 +1,60 @@ ++++ +title = "Boxcat" +description = "Boxcat features" ++++ + +Boxcat is an open-source replacement for Nintendo's BCAT service. BCAT is a network service that games can leverage to add dynamic content to games. Some examples of features games make use of this for are Splatoon 2 Splatfests, Splatoon 2 course rotations, Super Mario Odyssey costumes, Super Smash Bros. Ultimate news, and even the news feed on the home menu. By emulating the BCAT service at a high-level, yuzu is able to intercept the game's calls to Nintendo's servers and reroute them to yuzu's servers. + +## Current Boxcat Events + +### Super Mario Odyssey + +The satellaview and baseball costumes are available for purchase in the shop if you haven't already bought them and the filter, tile, and kaleidoscope screenshot filters are now available. + +*Please remember not to spoil exact locations of hints on discord -- Leave the fun for others to discover on their own.* + +**Hint Art #1 -- By Jon S.** + +{{< imgs + "./hint-1-1.png|Located under the hot desert sun." +>}} + +**Hint Art #2 -- By DarkLordZach** + +{{< imgs + "./hint-2-1.png|Located in the big city." +>}} + +**Hint Art #3 -- By MysticExile** + +{{< imgs + "./hint-4-1.png|Located where the beast slumbers." +>}} + +**Hint Art #4 -- By Tobi** + +{{< imgs + "./hint-5-1.png|Located above the big forest." +>}} + +**Hint Art #5 -- By Flamboyant Ham** + +{{< imgs + "./hint-6-1.png|Running around in circles." +>}} + +### Breath of the Wild + +By opening the game and a save file, you will receive 3 raw prime steaks that you can use for cooking, food, or whatever else you desire. + +{{< imgs + "./botw-steak.png|Yummy!" +>}} + +### Splatoon 2 + +By opening the game you will receive five main ability up ability chunks, which can be used with Murch ingame to improve your gear. + +{{< imgs + "./splatoon2-mainability.png|This looks useful!" +>}} diff --git a/site/content/help/feature/boxcat/splatoon2-mainability.png b/site/content/help/feature/boxcat/splatoon2-mainability.png new file mode 100644 index 0000000..6e2dc57 Binary files /dev/null and b/site/content/help/feature/boxcat/splatoon2-mainability.png differ diff --git a/site/content/help/feature/game-modding.md b/site/content/help/feature/game-modding.md new file mode 100644 index 0000000..403f1f4 --- /dev/null +++ b/site/content/help/feature/game-modding.md @@ -0,0 +1,66 @@ ++++ +title = "Game Modding" +description = "Game modding features" ++++ + +# Game Modding + +Yuzu has a powerful modding framework allowing for multiple formats of patches, flexibility in distribution, and easy organization and change. + +### Directory Structure + +The following is an example of a mod in yuzu.
+Each one is its own directory within the Mod Data dir that can be opened by right-clicking on the game in yuzu (alternatively `%YUZU_DIR%/load/`) +``` +mod_directory + - exefs + - romfs + - romfs_ext +``` + +#### ExeFS +The ExeFS dir contains patches for the game's executable(s). +These types of mods typically alter game behavior or logic. +Currently this translates to two types of patches: `IPS` and `IPSwitch`. + +To use an `IPS` patch, create a file with the NSO build ID as the name and `.ips` as the extension and put it in the ExeFS dir. +More details on the `IPS` format can be found on [ZeroSoft](https://zerosoft.zophar.net/ips.php). + +For `IPSwitch`, the filename can be whatever you want as long as the extension is `.pchtxt` and it contains a NSO build ID. +More details on the `IPSwitch` format can be found on it's [GitHub repo](https://github.com/3096/ipswitch). + +#### RomFS +The RomFS dir contains replacements for the game's assets and general files. +These types of mods typically alter a game's textures, text, fonts, sounds, or other graphical assets. +If this directory is not empty, yuzu will combine the contents of it with the base game with files from this directory taking precedence over the base. +This technique is called LayeredFS. +``` +It is important to note that for this to work properly, +the directory structure of the game has to be mirrored in this dir. +``` + +It is much easier to get started with a RomFS mod than an ExeFS mod. +To dump the game's RomFS, right-click on the game and select `Dump RomFS`. +Selecting full will extract everything while skeleton will only create the directories. +The output of this will be opened after the dump and can be found at `%YUZU_DIR%/dump/`. + +#### RomFS Extension (romfs_ext) +The RomFS Extension dir contains patches and stubs for romfs files. +This allows modders to delete files within the romfs if a file of the same name but the extension `.stub` is found at the same directory within `romfs_ext`. +Similarly, if a file with the same name but with extension `.ips` is found at the same directory within `romfs_ext`, the base game file will be patched with it. + +### Example +For example, let's examine Splatoon 2, a popular game for modding. + +Since Splatoon 2's title id is `01003BC0000A0000`, all of our mods for this game will go in `%YUZU_DIR%/load/01003BC0000A0000`. + +Say we have two mods to play with, Mod X and Mod Y. +Therefore, we would make two directories in the `01003BC0000A0000` folder, one called "Mod X" and one called "Mod Y". + +Within the "Mod X" folder, there are the `exefs`, `romfs`, and `romfs_ext` directories provided by the author. +It is okay to omit one (or more) of them if it is empty. Additionally, if the mod folder is empty yuzu will ignore it. + +### Conclusion +If you are a modder looking to distribute mods for yuzu and have another question or found part of this guide confusing, feel free to come ask in out discord. + +If you are a user trying to install a mod for yuzu and it seems like a critical piece of the puzzle is missing, try asking the mod author for help. Otherwise, feel free to come ask in the discord. diff --git a/site/content/help/feature/multiplayer/index.md b/site/content/help/feature/multiplayer/index.md new file mode 100644 index 0000000..522e1bf --- /dev/null +++ b/site/content/help/feature/multiplayer/index.md @@ -0,0 +1,120 @@ ++++ +title = "Multiplayer" +description = "yuzu's multiplayer feature has the ability to emulate local wireless multiplayer over the Internet." ++++ + +## Multiplayer Features +*yuzu*'s multiplayer feature has the ability to emulate *local wireless* multiplayer over the Internet. While on a real Switch you’d be limited to the people in your immediate vicinity, *yuzu* boasts a complex server/client infrastructure that forwards a game’s wireless communication across the internet. + +Unlike single console netplay used in most emulators, users won’t have to worry about desyncs, synchronizing saves, or any other issues typical of netplay. Each user is using their instance of *yuzu* as a unique emulated Switch that is communicating with everyone else through a *multiplayer room*, a server that can be hosted by anyone for connected clients to exchange data with each other. + +You can learn more about *yuzu*'s multiplayer features in [this article](https://yuzu-emu.org/entry/ldn-is-here/). + +## Hosting Rooms +If you just want to play with your friends, **you do not need to create your own room**. You can just pick a room from our Public Room Browser, where plenty of public rooms hosted by us and the community are already available for use. + +If you just want to temporarily host a room for you and your friends to play, the easiest way is to host a room from the UI (`Multiplayer > Host Room`). The room will be deleted once the host exits yuzu. You will still need to configure `Port forwarding` if you and your friends are not on the same network. + +However, if you really want to host your own dedicated room, there are a few points you should keep in mind: + +* As a room is actually a server, the computer hosting it has to be running 24x7. Therefore, it is usually not feasible to use your home or work PC to host a room. +* To ensure the best experience while playing, rooms should have a good Internet connection as well as a high bandwidth. *This is especially important if you are hosting a public room - no one would want random disconnections while playing!* +* yuzu rooms can be quite costly in terms of data transfer. Please be aware that hosting a popular public room can cause a lot of traffic for your server. + +Therefore, the best option to host a room is usually to use a VPS provider, such as [Linode](https://linode.com) or [DigitalOcean](https://www.digitalocean.com), to name a few. + +### Port Forwarding +Typically, routers have a unified public IP for all its network members, and by default external users cannot access any of the ports (as the router won't know which member to send it to!). Therefore, if you use a router for your Internet connection, you will need to configure `Port forwarding` for your router. Detailed configuration process varies by router brand and model. Obviously we cannot provide instructions for every model, and you can refer to your router's manual or website. + +<b>Forward port 24872 via UDP, or both TCP and UDP. Don't forward only TCP.</b> + +For VPSes, a similar restriction (often called `Security Groups`) exists to help keep your server safe from attacks using certain ports. You may need to manually enable the ports you want to use in your VPS's dashboard. + +## Hosting on Linux (Recommended) +If you are using a Linux VPS (which is the recommended option), the officially supported way of hosting dedicated rooms is using our *Docker* image. + +First of all, you should install *Docker* on your system. Refer to its [documents](https://docs.docker.com/#run-docker-anywhere) regarding installation. + +Once you get a *Docker* installation ready, hosting dedicated rooms is as easy as **filling in the arguments** (they will be explained later) and running the following command in terminal: +```bash +sudo docker run -d \ + --publish 5000:5000/udp \ + yuzuemu/yuzu-multiplayer-dedicated \ + --room-name "<INSERT ROOM NAME HERE>" \ + --room-description "<INSERT ROOM NAME HERE>" \ + --preferred-game "<INSERT GAME TITLE HERE>" \ + --preferred-game-id "<INSERT TITLE ID HERE>" \ + --port 5000 \ + --max_members 4 \ + --token "<INSERT YUZU ACCOUNT TOKEN HERE>" \ + --enable-yuzu-mods \ + --web-api-url https://api.yuzu-emu.org +``` +Make sure the ports specified in `--publish` matches the port specified in `--port`, so that *Docker* can correctly forward your server's ports to the container. + +You can also save this command (with arguments filled in) as a script for easier usage. + +## Hosting on Windows +If you are on Windows, it is also possible to host rooms using a standalone executable. As you may already know, every *yuzu* release comes with three executables - `yuzu-cmd` (The command line emulator frontend), `yuzu` (The GUI emulator frontend) and `yuzu-room`, the dedicated room server which we'll use. + +Steps: + +1. If you do not have a *yuzu* installation yet, install it with the installer from our [official website](https://yuzu-emu.org). +1. Navigate to the folder you installed *yuzu* to, and go into `yuzu-windows-msvc` or `yuzu-windows-msvc-early-access`. + * If you cannot recall the installation folder, right clicking on a shortcut and clicking `Open File Location` will directly bring you into the `yuzu-windows-msvc` or `yuzu-windows-msvc-early-access` folder. + * Make sure the folder you are in contains the `yuzu-room` executable. +1. Create a new text file and copy the following script inside, **fill in the arguments** (they will be explained later) and then use `File > Save As...` to save it to `host.bat`. You can delete the original text file after that. +1. You can now double click on the batch script named `host` to start hosting. + +``` +yuzu-room ^ + --room-name "<INSERT ROOM NAME HERE>" ^ + --room-description "<INSERT ROOM DESCRIPTION HERE>" ^ + --preferred-game "<INSERT GAME TITLE HERE>" ^ + --preferred-game-id "<INSERT TITLE ID HERE>" ^ + --port 5000 ^ + --max_members 4 ^ + --token "<INSERT YUZU ACCOUNT TOKEN HERE>" ^ + --enable-yuzu-mods ^ + --web-api-url https://api.yuzu-emu.org ^ + --ban-list-file "<INSERT BAN LIST FILE PATH HERE>" +pause +``` + +![example](windows_hosting_1.png) + +## Command Line Arguments +Both the *Docker* image and the `yuzu-room` executable takes a number of command line arguments. +Command line arguments should be specified in the format of `--<name> <value>`, for example `--port 5000`. + +By default, rooms will be hosted Public. If you'd like to host a private one instead, just omit one of the fields required only for public rooms. + +|Name|Required|Description +|----|--------|----------- +|`--room-name`|Yes|Name of your room. +|`--room-description`|No|An optional long description of your room. +|`--preferred-game`|Yes|The name of the preferred game of your room. +|`--preferred-game-id`|No|The Title ID of the preferred game of your room, in hex. You can find the `Title ID` with the game list of yuzu. +|`--port`|Yes|Port number to host your room on (0-65535). You should use a port that is not already used by other applications (typically a high enough port will work). Though unrecommended due to bandwidth reasons, it is possible to host multiple rooms on a single server provided the ports are distinct. **Remember to configure `Port Forwarding` for the ports!** +|`--max-members`|Yes|Maximum number of members for your room (2-16). *Note that rooms that are too large may result in slowdowns or even disconnections in certain games.* +|`--password`|No|An optional password to limit access to your room. +|`--token`|Public Rooms|Your *yuzu* Community user token. Do not know your token yet? Get it [here](https://yuzu-emu.org/wiki/yuzu-web-service/). +|`--web-api-url`|Public Rooms|URL to the *yuzu* Web API. You should not change this. +|`--ban-list-file`|No|This is a file which yuzu will store ban records in. Banning would still work even if you do not specify this, but the bans will be lost once you shut down the room. +|`--log-file`|No|File path to store the logs. + +Additionally, a flag `--enable-yuzu-mods` is available. By enabling this flag, you will grant *yuzu* Community Moderators the power to moderate on your room. Do not worry, this is entirely optional and your room will still be listed even if you do not enable this. + +## Authentication and Moderation +*yuzu* multiplayer rooms can authenticate users and grant certain users moderation privileges. Authenticated users get their *yuzu* Community username and avatar shown in the member list, and others can right click on them to view their *yuzu* Community profile. + +Note that this feature requires interacting with the *yuzu* Web API, and therefore is only enabled for *public rooms in the Public Room Browser*. Directly connecting to the rooms (with `Direct Connect`) will leave you unauthenticated. + +Currently, *yuzu* rooms grant the following members moderation privileges by default: + +* Room host (i.e. members authenticated with the same user name used when hosting the room) +* *yuzu* Community Moderators, when rooms are hosted with the `--enable-yuzu-mods` flag. + +Due to complexity, it is not possible to grant other users moderation privileges. + +Users with moderation privileges will notice a `Moderation...` button on the right top of the Room dialog. With this you can view the current ban list and unban when needed. You can also right click on a member in the member list and click on `Kick` or `Ban` to impose moderation actions on them. Note that `Block Player` is different from a ban and is available to all users to block messages from certain members only locally. diff --git a/site/content/help/feature/multiplayer/windows_hosting_1.png b/site/content/help/feature/multiplayer/windows_hosting_1.png new file mode 100644 index 0000000..cbe7188 Binary files /dev/null and b/site/content/help/feature/multiplayer/windows_hosting_1.png differ diff --git a/site/content/help/feature/resolution-rescaler/gameUI.png b/site/content/help/feature/resolution-rescaler/gameUI.png new file mode 100644 index 0000000..93fdc57 Binary files /dev/null and b/site/content/help/feature/resolution-rescaler/gameUI.png differ diff --git a/site/content/help/feature/resolution-rescaler/index.md b/site/content/help/feature/resolution-rescaler/index.md new file mode 100644 index 0000000..861be71 --- /dev/null +++ b/site/content/help/feature/resolution-rescaler/index.md @@ -0,0 +1,47 @@ ++++ +title = "Resolution Rescaler" +description = "How to use the resolution rescaler feature." ++++ + +<article class="message has-text-weight-semibold"> +<div class="message-body"> +<p>PSA: Due to some stability issues and not working on other GPU vendors (Intel/AMD), the feature has been removed and is currently absent in the latest Mainline/Early Access builds. Resolution scaling will return at a later date once the aforementioned issues are fixed by the development team.</p> +</div> +</article> + +yuzu has a powerful resolution rescaler allowing for the upscaling of the game's docked and undocked render resolution. + +### Accessing the feature + +The options for the resolution rescaler can be accessed via the yuzu Configuration menu `(Emulation > Configure...)`, +in the `Graphics` tab, under `Internal Resolution`: + +{{< imgs + "./scanner.png" +>}} + +Clicking on the `Internal Resolution` dropdown list displays options for the upscaling factor, alongside its respective +resolution that it will output for `(Undocked/Docked)`: + +{{< imgs + "./scanner+dropdown.png" +>}} + +### Profile Scanner + +Selecting the `Profile Scanner (Native)` option allows yuzu to continuously analyse the game's rendering methods in order +to create its respective resolution rescaling profile. After the creation of the rescaling profile, the upscaling factor +of choice can then be selected from the `Internal Resolution` dropdown list. + +**NOTE:** For optimal results, it is recommended to completely traverse throughout all of the game while having the Profile +Scanner enabled to complete the analysis of the game's rendering methods. + +### Resolution rescaling profiles + +Resolution rescaling profiles can be found under `%APPDATA%/yuzu/rescaling` on Windows and `~/.local/share/yuzu-emu/rescaling/` +on Linux, or you can right-click the game on the UI and click on `Open Rescaling Profile`. Rescaling profiles are transferable +for use in other computers. + +{{< imgs + "./gameUI.png" +>}} diff --git a/site/content/help/feature/resolution-rescaler/scanner+dropdown.png b/site/content/help/feature/resolution-rescaler/scanner+dropdown.png new file mode 100644 index 0000000..5529568 Binary files /dev/null and b/site/content/help/feature/resolution-rescaler/scanner+dropdown.png differ diff --git a/site/content/help/feature/resolution-rescaler/scanner.png b/site/content/help/feature/resolution-rescaler/scanner.png new file mode 100644 index 0000000..2a24fb1 Binary files /dev/null and b/site/content/help/feature/resolution-rescaler/scanner.png differ diff --git a/site/content/help/feature/tas/control_debugger.png b/site/content/help/feature/tas/control_debugger.png new file mode 100644 index 0000000..fcc7535 Binary files /dev/null and b/site/content/help/feature/tas/control_debugger.png differ diff --git a/site/content/help/feature/tas/control_debugger_pressed.png b/site/content/help/feature/tas/control_debugger_pressed.png new file mode 100644 index 0000000..f6330b6 Binary files /dev/null and b/site/content/help/feature/tas/control_debugger_pressed.png differ diff --git a/site/content/help/feature/tas/index.md b/site/content/help/feature/tas/index.md new file mode 100644 index 0000000..3f99ab0 --- /dev/null +++ b/site/content/help/feature/tas/index.md @@ -0,0 +1,54 @@ ++++ +title = "TAS" +description = "Tool Assisted Speedrun" ++++ +This tool allows you to send perfectly timed, precise controller inputs to a game with what would be a near-impossible degree of accuracy for a human. +You can set and lock the different analog sticks to certain positions, as well as specify what buttons are to be pressed or released. + +# How to use + +To play back TAS scripts in yuzu, first select the folder with scripts in the configuration menu below +`Tools -> Configure TAS`. The file itself has to be in plain text format, and it must be named `script0-1.txt` +for controller 1, `script0-2.txt` for controller 2, and so forth (with max. 8 players). + +After placing the file at the correct location, it can be read into yuzu with the (default) hotkey +`CTRL+F6` (refresh). The amount of frames contained in the the script file will be displayed at the bottom left corner of the window. +Playback can be started or stopped by using `CTRL+F5`. + +However, in order for playback to work, the correct input device must be selected. This is done automatically if `controller profile swapping` is enabled, +if disabled this can be done by going to `Emulation > Configure > Controls` menu and selecting `TAS` from the device list for the controller that the script should be played on. + +If you decide to run the script over and over again, `Loop script` will do just that. The tool will not stop until you specifically send the stop hotkey `CTRL+F5`. + +`Pause execution during loads` is a feature that stops the tool until the loading screen is done. This feature is currently disabled but left as a placeholder until a +proper solution can be implemented. + +## Recording + +Recording a new script file is also simple: Just make sure that the proper controller device (not `TAS`) is +connected on P1, and press `CTRL+F7` to start recording your input. When you're done, press the same keys +again (`CTRL+F7`). The new script will be saved at the folder location previously selected, with +`record.txt` as the filename, optionally an overwrite dialog window will pop up that will replace the contents +of `script0-1.txt` with the script that you just recorded allowing you to play back the script right away. + +{{< imgs + "./control_debugger.png|For debugging purposes, the controller debugger can be used" + "./control_debugger_pressed.png|View -> Debugging -> Controller P1" +>}} + +## Example script + +A script file has the same format that [TAS-nx](https://github.com/hamhub7/tas-script) uses. +<article class="message"><div class="message-header">Example</div><div class="message-body"> +1 KEY_B 0;0 0;0<br> +6 KEY_ZL 0;0 0;0<br> +41 KEY_ZL;KEY_Y 0;0 0;0<br> +43 KEY_X;KEY_A 32767;0 0;0<br> +44 KEY_A 32767;0 0;0<br> +45 NONE 32767;0 0;0<br> +46 NONE 0;0 0;32767<br> +47 KEY_A -32767;0 0;0<br> +</div></article> + +For more advanced scripts you can take a look at this Super Mario Odyssey [TAS script](./script0-1.txt) made by matthewpugs24. +{{< youtube Gh2aCXdnZRk >}} \ No newline at end of file diff --git a/site/content/help/feature/tas/script0-1.txt b/site/content/help/feature/tas/script0-1.txt new file mode 100644 index 0000000..86ed790 --- /dev/null +++ b/site/content/help/feature/tas/script0-1.txt @@ -0,0 +1,773 @@ +0 NONE 1;-32767 0;0 +1 NONE 1;-32767 0;0 +2 NONE 1;-32767 0;0 +3 KEY_ZR 1;-32767 0;0 +4 KEY_Y;KEY_ZR 1;-32767 0;0 +5 NONE 0;0 0;0 +6 NONE 0;0 0;0 +7 NONE 0;0 0;0 +8 NONE 0;0 0;0 +9 NONE 0;0 0;0 +10 NONE 0;0 0;0 +11 NONE 0;0 0;0 +12 NONE 0;0 0;0 +13 NONE 0;0 0;0 +14 NONE 0;0 0;0 +15 NONE 0;0 0;0 +16 KEY_B;KEY_DDOWN 0;0 0;0 +17 KEY_DDOWN 0;0 0;0 +18 KEY_DDOWN 0;0 0;0 +19 KEY_DDOWN 0;0 0;0 +20 KEY_DDOWN 0;0 0;0 +21 KEY_DDOWN 0;0 0;0 +22 KEY_DDOWN 0;0 0;0 +23 KEY_DDOWN 0;0 0;0 +24 KEY_DDOWN 0;0 0;0 +25 KEY_DDOWN 0;0 0;0 +26 KEY_DDOWN 0;0 0;0 +27 KEY_DDOWN 0;0 0;0 +28 KEY_DDOWN 0;0 0;0 +29 KEY_DDOWN 0;0 0;0 +30 KEY_DDOWN 0;0 0;0 +31 KEY_DDOWN 0;0 0;0 +32 NONE 0;0 0;0 +33 NONE 0;0 0;0 +34 NONE 0;0 0;0 +35 NONE 0;0 0;0 +36 KEY_A 0;0 0;0 +37 KEY_B 0;0 0;0 +38 KEY_A 0;0 0;0 +39 KEY_B 0;0 0;0 +40 KEY_A 0;0 0;0 +41 KEY_B 0;0 0;0 +42 KEY_A 0;0 0;0 +43 KEY_B 0;0 0;0 +44 KEY_A 0;0 0;0 +45 KEY_B 0;0 0;0 +46 KEY_A 0;0 0;0 +47 KEY_B 0;0 0;0 +48 KEY_A 0;0 0;0 +49 KEY_B 0;0 0;0 +50 KEY_A 0;0 0;0 +51 KEY_B 0;0 0;0 +52 KEY_A 0;0 0;0 +53 KEY_B 0;0 0;0 +54 KEY_A 0;0 0;0 +55 KEY_B 0;0 0;0 +56 KEY_A 0;0 0;0 +57 KEY_B 0;0 0;0 +58 KEY_A 0;0 0;0 +59 KEY_B 0;0 0;0 +60 KEY_A 0;0 0;0 +61 KEY_B 0;0 0;0 +62 KEY_A 0;0 0;0 +63 KEY_B 0;0 0;0 +64 KEY_A 0;0 0;0 +65 KEY_B 0;0 0;0 +66 KEY_A 0;0 0;0 +67 KEY_B 0;0 0;0 +68 KEY_A 0;0 0;0 +69 KEY_B 0;0 0;0 +70 KEY_A 0;0 0;0 +71 KEY_B 0;0 0;0 +72 KEY_A 0;0 0;0 +73 KEY_B 0;0 0;0 +74 KEY_A 0;0 0;0 +75 KEY_B 0;0 0;0 +76 KEY_A 0;0 0;0 +77 KEY_B 0;0 0;0 +78 KEY_A 0;0 0;0 +79 KEY_B 0;0 0;0 +80 KEY_A 0;0 0;0 +81 KEY_B 0;0 0;0 +82 KEY_A 0;0 0;0 +83 KEY_B 0;0 0;0 +84 KEY_A 0;0 0;0 +85 KEY_B 0;0 0;0 +86 KEY_A 0;0 0;0 +87 KEY_B 0;0 0;0 +88 KEY_A 0;0 0;0 +89 KEY_B 0;0 0;0 +90 KEY_A 0;0 0;0 +91 KEY_B 0;0 0;0 +92 KEY_A 0;0 0;0 +93 KEY_B 0;0 0;0 +94 KEY_A 0;0 0;0 +95 KEY_B 0;0 0;0 +96 KEY_A 0;0 0;0 +97 KEY_B 0;0 0;0 +98 KEY_A 0;0 0;0 +99 KEY_B 0;0 0;0 +100 KEY_A 0;0 0;0 +101 KEY_B 0;0 0;0 +102 KEY_A 0;0 0;0 +103 KEY_B 0;0 0;0 +104 KEY_A 0;0 0;0 +105 KEY_B 0;0 0;0 +106 KEY_A 0;0 0;0 +107 KEY_B 0;0 0;0 +108 KEY_A 0;0 0;0 +109 KEY_B 0;0 0;0 +110 KEY_A 0;0 0;0 +111 KEY_B 0;0 0;0 +112 KEY_A 0;0 0;0 +113 KEY_B 0;0 0;0 +114 KEY_A 0;0 0;0 +115 KEY_B 0;0 0;0 +116 KEY_A 0;0 0;0 +117 KEY_B 0;0 0;0 +118 KEY_A 0;0 0;0 +119 KEY_B 0;0 0;0 +120 KEY_A 0;0 0;0 +121 KEY_B 0;0 0;0 +122 KEY_A 0;0 0;0 +123 KEY_B 0;0 0;0 +124 KEY_A 0;0 0;0 +125 KEY_B 0;0 0;0 +126 KEY_A 0;0 0;0 +127 KEY_B 0;0 0;0 +128 KEY_A 0;0 0;0 +129 KEY_B 0;0 0;0 +130 KEY_A 0;0 0;0 +131 KEY_B 0;0 0;0 +132 KEY_A 0;0 0;0 +133 KEY_B 0;0 0;0 +134 KEY_A 0;0 0;0 +135 KEY_B 0;0 0;0 +136 KEY_A 0;0 0;0 +137 KEY_B 0;0 0;0 +138 KEY_A 0;0 0;0 +139 KEY_B 0;0 0;0 +140 KEY_A 0;0 0;0 +141 KEY_B 0;0 0;0 +142 KEY_A 0;0 0;0 +143 KEY_B 0;0 0;0 +144 KEY_A 0;0 0;0 +145 KEY_B 0;0 0;0 +146 KEY_A 0;0 0;0 +147 KEY_B 0;0 0;0 +148 KEY_A 0;0 0;0 +149 KEY_B 0;0 0;0 +150 KEY_A 0;0 0;0 +151 KEY_B 0;0 0;0 +152 KEY_A 0;0 0;0 +153 KEY_B 0;0 0;0 +154 KEY_A 0;0 0;0 +155 KEY_B 0;0 0;0 +156 KEY_A 0;0 0;0 +157 KEY_B 0;0 0;0 +158 KEY_A 0;0 0;0 +159 KEY_B 0;0 0;0 +160 KEY_A 0;0 0;0 +161 KEY_B 0;0 0;0 +162 KEY_A 0;0 0;0 +163 KEY_B 0;0 0;0 +164 KEY_A 0;0 0;0 +165 KEY_B 0;0 0;0 +166 KEY_A 0;0 0;0 +167 KEY_B 0;0 0;0 +168 KEY_A 0;0 0;0 +169 KEY_B 0;0 0;0 +170 KEY_A 0;0 0;0 +171 KEY_B 0;0 0;0 +172 KEY_A 0;0 0;0 +173 KEY_B 0;0 0;0 +174 KEY_A 0;0 0;0 +175 KEY_B 0;0 0;0 +176 KEY_A 0;0 0;0 +177 KEY_B 0;0 0;0 +178 KEY_A 0;0 0;0 +179 KEY_B 0;0 0;0 +180 KEY_A 0;0 0;0 +181 KEY_B 0;0 0;0 +182 KEY_A 0;0 0;0 +183 KEY_B 0;0 0;0 +184 KEY_A 0;0 0;0 +185 KEY_B 0;0 0;0 +186 KEY_A 0;0 0;0 +187 KEY_B 0;0 0;0 +188 KEY_A 0;0 0;0 +189 KEY_B 0;0 0;0 +190 KEY_A 0;0 0;0 +191 KEY_B 0;0 0;0 +192 KEY_A 0;0 0;0 +193 KEY_B 0;0 0;0 +194 KEY_A 0;0 0;0 +195 KEY_B 0;0 0;0 +196 KEY_A 0;0 0;0 +197 KEY_B 0;0 0;0 +198 KEY_A 0;0 0;0 +199 KEY_B 0;0 0;0 +200 KEY_A 0;0 0;0 +201 KEY_B 0;0 0;0 +202 KEY_A 0;0 0;0 +203 KEY_B 0;0 0;0 +204 KEY_A 0;0 0;0 +205 KEY_B 0;0 0;0 +206 KEY_A 0;0 0;0 +207 KEY_B 0;0 0;0 +208 KEY_A 0;0 0;0 +209 KEY_B 0;0 0;0 +210 KEY_A 0;0 0;0 +211 KEY_B 0;0 0;0 +212 KEY_A 0;0 0;0 +213 KEY_B 0;0 0;0 +214 KEY_A 0;0 0;0 +215 KEY_B 0;0 0;0 +216 KEY_A 0;0 0;0 +217 KEY_B 0;0 0;0 +218 KEY_A 0;0 0;0 +219 KEY_B 0;0 0;0 +220 KEY_A 0;0 0;0 +221 KEY_B 0;0 0;0 +222 KEY_A 0;0 0;0 +223 KEY_B 0;0 0;0 +224 KEY_A 0;0 0;0 +225 KEY_B 0;0 0;0 +226 KEY_A 0;0 0;0 +227 KEY_B 0;0 0;0 +228 KEY_A 0;0 0;0 +229 KEY_B 0;0 0;0 +230 KEY_A 0;0 0;0 +231 KEY_B 0;0 0;0 +232 KEY_A 0;0 0;0 +233 KEY_B 0;0 0;0 +234 KEY_A 0;0 0;0 +235 KEY_B 0;0 0;0 +236 KEY_A 0;0 0;0 +237 KEY_B 0;0 0;0 +238 KEY_A 0;0 0;0 +239 KEY_B 0;0 0;0 +240 KEY_A 0;0 0;0 +241 KEY_B 0;0 0;0 +242 KEY_A 0;0 0;0 +243 KEY_B 0;0 0;0 +244 KEY_A 0;0 0;0 +245 KEY_B 0;0 0;0 +246 KEY_A 0;0 0;0 +247 KEY_B 0;0 0;0 +248 KEY_A 0;0 0;0 +249 KEY_B 0;0 0;0 +250 KEY_A 0;0 0;0 +251 KEY_B 0;0 0;0 +252 KEY_A 0;0 0;0 +253 KEY_B 0;0 0;0 +254 KEY_A 0;0 0;0 +255 NONE 0;0 0;0 +256 NONE 0;0 0;0 +257 NONE 0;0 0;0 +258 NONE 0;32767 0;0 +259 NONE -28377;-16383 0;0 +260 NONE 28377;-16383 0;0 +261 NONE 0;32767 0;0 +262 NONE -28377;-16383 0;0 +263 NONE 28377;-16383 0;0 +264 NONE 0;32767 0;0 +265 NONE -28377;-16383 0;0 +266 NONE 28377;-16383 0;0 +267 NONE 0;32767 0;0 +268 NONE -28377;-16383 0;0 +269 NONE 28377;-16383 0;0 +270 NONE 0;32767 0;0 +271 NONE -28377;-16383 0;0 +272 NONE 28377;-16383 0;0 +273 NONE 0;32767 0;0 +274 NONE -28377;-16383 0;0 +275 NONE 28377;-16383 0;0 +276 NONE 0;32767 0;0 +277 NONE -28377;-16383 0;0 +278 NONE 28377;-16383 0;0 +279 NONE 0;32767 0;0 +280 NONE -28377;-16383 0;0 +281 NONE 28377;-16383 0;0 +282 NONE 0;32767 0;0 +283 NONE -28377;-16383 0;0 +284 NONE 28377;-16383 0;0 +285 NONE 0;32767 0;0 +286 NONE -28377;-16383 0;0 +287 NONE 28377;-16383 0;0 +288 NONE 0;32767 0;0 +289 NONE -28377;-16383 0;0 +290 NONE 28377;-16383 0;0 +291 KEY_B -7946;31788 0;0 +292 KEY_ZR -7946;31788 0;0 +293 KEY_ZR -7946;31788 0;0 +294 KEY_ZR -7946;31788 0;0 +295 KEY_ZR -7946;31788 0;0 +296 KEY_ZR -7946;31788 0;0 +297 KEY_ZR -7946;31788 0;0 +298 KEY_ZR -7946;31788 0;0 +299 KEY_Y;KEY_ZR -7946;31788 0;0 +300 NONE 0;0 0;0 +301 NONE 0;0 0;0 +302 NONE 0;0 0;0 +303 NONE 0;0 0;0 +304 NONE 0;0 0;0 +305 NONE 0;0 0;0 +306 NONE 0;0 0;0 +307 NONE 0;0 0;0 +308 NONE 0;0 0;0 +309 NONE 0;0 0;0 +310 KEY_B 0;0 0;0 +311 KEY_DRIGHT 0;0 0;0 +312 KEY_DRIGHT -3277;0 0;0 +313 KEY_DRIGHT 0;0 0;0 +314 KEY_DRIGHT 0;0 0;0 +315 KEY_DRIGHT 0;0 0;0 +316 KEY_DRIGHT 0;0 0;0 +317 KEY_DRIGHT 0;0 0;0 +318 KEY_DRIGHT 0;0 0;0 +319 KEY_DRIGHT 0;0 0;0 +320 NONE -18398;-27114 0;0 +321 NONE -18398;-27114 0;0 +322 NONE -18398;-27114 0;0 +323 NONE -18398;-27114 0;0 +324 NONE -18398;-27114 0;0 +325 NONE -18398;-27114 0;0 +326 NONE -18398;-27114 0;0 +327 NONE -18398;-27114 0;0 +328 NONE -18398;-27114 0;0 +329 NONE -18398;-27114 0;0 +330 NONE -18398;-27114 0;0 +331 NONE -18398;-27114 0;0 +332 NONE -18398;-27114 0;0 +333 NONE -18398;-27114 0;0 +334 NONE -18398;-27114 0;0 +335 NONE -18398;-27114 0;0 +336 NONE -18398;-27114 0;0 +337 NONE -18398;-27114 0;0 +338 NONE -18398;-27114 0;0 +339 NONE -18398;-27114 0;0 +340 NONE -18398;-27114 0;0 +341 NONE -18398;-27114 0;0 +342 KEY_B -18398;-27114 0;0 +343 NONE -18398;-27114 0;0 +344 NONE -18398;-27114 0;0 +345 NONE -18398;-27114 0;0 +346 NONE -18398;-27114 0;0 +347 KEY_ZR -18398;-27114 0;0 +348 KEY_Y -18398;-27114 0;0 +349 NONE 18398;27114 0;0 +350 NONE 18398;27114 0;0 +351 NONE 18398;27114 0;0 +352 NONE 18398;27114 0;0 +353 NONE 18398;27114 0;0 +354 NONE 18398;27114 0;0 +355 NONE 18398;27114 0;0 +356 NONE 18398;27114 0;0 +357 NONE 18398;27114 0;0 +358 NONE 18398;27114 0;0 +359 NONE 18398;27114 0;0 +360 NONE 18398;27114 0;0 +361 NONE 18398;27114 0;0 +362 NONE 18398;27114 0;0 +363 NONE 18398;27114 0;0 +364 NONE 18398;27114 0;0 +365 NONE 18398;27114 0;0 +366 NONE 18398;27114 0;0 +367 NONE 18398;27114 0;0 +368 NONE 18398;27114 0;0 +369 NONE 0;32767 0;0 +370 NONE 0;32767 0;0 +371 NONE 0;32767 0;0 +372 NONE 0;32767 0;0 +373 NONE 0;32767 0;0 +374 NONE 0;32767 0;0 +375 NONE 0;32767 0;0 +376 NONE 0;32767 0;0 +377 NONE 0;32767 0;0 +378 NONE 0;32767 0;0 +379 NONE 0;32767 0;0 +380 NONE 0;32767 0;0 +381 NONE 0;32767 0;0 +382 NONE 0;32767 0;0 +383 NONE 0;32767 0;0 +384 NONE 0;32767 0;0 +385 NONE 0;32767 0;0 +386 NONE 0;32767 0;0 +387 NONE 0;32767 0;0 +388 NONE 0;32767 0;0 +389 NONE 0;32767 0;0 +390 NONE 0;32767 0;0 +391 NONE 0;32767 0;0 +392 NONE 0;32767 0;0 +393 NONE 0;32767 0;0 +394 NONE 0;32767 0;0 +395 NONE 0;32767 0;0 +396 NONE 0;32767 0;0 +397 NONE 0;32767 0;0 +398 NONE 0;32767 0;0 +399 NONE 0;32767 0;0 +400 NONE 0;32767 0;0 +401 NONE 0;0 0;0 +402 NONE 0;0 0;0 +403 NONE 0;0 0;0 +404 NONE 0;0 0;0 +405 NONE 0;0 0;0 +406 NONE 0;0 0;0 +407 NONE 0;0 0;0 +408 NONE 0;0 0;0 +409 NONE 0;0 0;0 +410 NONE 0;0 0;0 +411 NONE 0;0 0;0 +412 NONE 0;0 0;0 +413 NONE 0;0 0;0 +414 NONE 0;0 0;0 +415 NONE 0;0 0;0 +416 NONE 0;0 0;0 +417 NONE 0;0 0;0 +418 NONE 0;0 0;0 +419 NONE 0;0 0;0 +420 NONE 0;0 0;0 +421 NONE 0;0 0;0 +422 NONE 0;0 0;0 +423 NONE 0;0 0;0 +424 NONE 0;0 0;0 +425 NONE 0;0 0;0 +426 NONE 0;0 0;0 +427 NONE 0;0 0;0 +428 NONE 0;0 0;0 +429 NONE 0;0 0;0 +430 NONE 0;0 0;0 +431 NONE 0;0 0;0 +432 NONE 0;0 0;0 +433 NONE 0;0 0;0 +434 NONE 0;0 0;0 +435 NONE 0;0 0;0 +436 NONE 0;0 0;0 +437 NONE 0;0 0;0 +438 NONE 0;0 0;0 +439 NONE 0;0 0;0 +440 NONE 0;0 0;0 +441 NONE 0;0 0;0 +442 NONE 0;0 0;0 +443 NONE 0;0 0;0 +444 NONE 0;0 0;0 +445 NONE 0;0 0;0 +446 NONE 0;0 0;0 +447 NONE 0;0 0;0 +448 NONE 0;0 0;0 +449 NONE 0;0 0;0 +450 NONE 0;0 0;0 +451 NONE 0;0 0;0 +452 NONE 0;0 0;0 +453 NONE 0;0 0;0 +454 NONE 0;0 0;0 +455 NONE 0;0 0;0 +456 NONE 0;0 0;0 +457 NONE 0;0 0;0 +458 NONE 0;0 0;0 +459 NONE 0;0 0;0 +460 NONE 0;0 0;0 +461 NONE 0;0 0;0 +462 NONE 0;0 0;0 +463 NONE 0;32767 0;0 +464 NONE 28377;-16383 0;0 +465 NONE -28377;-16383 0;0 +466 NONE 0;32767 0;0 +467 NONE 28377;-16383 0;0 +468 NONE -28377;-16383 0;0 +469 NONE 0;32767 0;0 +470 NONE 28377;-16383 0;0 +471 NONE -28377;-16383 0;0 +472 NONE 0;32767 0;0 +473 NONE 28377;-16383 0;0 +474 NONE -28377;-16383 0;0 +475 NONE 0;32767 0;0 +476 NONE 28377;-16383 0;0 +477 NONE -28377;-16383 0;0 +478 NONE 0;32767 0;0 +479 NONE 28377;-16383 0;0 +480 NONE -28377;-16383 0;0 +481 NONE 0;32767 0;0 +482 NONE 28377;-16383 0;0 +483 NONE -28377;-16383 0;0 +484 NONE 0;32767 0;0 +485 NONE 28377;-16383 0;0 +486 NONE -28377;-16383 0;0 +487 NONE 0;32767 0;0 +488 NONE 28377;-16383 0;0 +489 NONE -28377;-16383 0;0 +490 NONE 0;32767 0;0 +491 NONE 28377;-16383 0;0 +492 NONE -28377;-16383 0;0 +493 NONE 0;32767 0;0 +494 NONE 28377;-16383 0;0 +495 NONE -28377;-16383 0;0 +496 KEY_B 0;0 0;0 +497 NONE 0;0 0;0 +498 NONE 0;0 0;0 +499 NONE 0;0 0;0 +500 NONE 0;0 0;0 +501 NONE 0;32767 0;0 +502 NONE 0;0 0;0 +503 NONE 0;0 0;0 +504 NONE 0;0 0;0 +505 NONE 0;32767 0;0 +506 NONE 0;32767 0;0 +507 NONE 0;32767 0;0 +508 NONE 0;32767 0;0 +509 NONE 0;32767 0;0 +510 NONE 0;32767 0;0 +511 NONE 0;32767 0;0 +512 NONE 0;32767 0;0 +513 NONE 0;32767 0;0 +514 NONE 0;26602 0;0 +515 NONE 7044;0 0;0 +516 KEY_ZR 0;0 0;0 +517 KEY_ZR 0;0 0;0 +518 KEY_ZR 0;0 0;0 +519 KEY_ZR 0;0 0;0 +520 KEY_ZR 0;0 0;0 +521 KEY_ZR 0;0 0;0 +522 KEY_ZR 0;0 0;0 +523 KEY_ZR 0;0 0;0 +524 KEY_ZR 0;0 0;0 +525 KEY_ZR 0;0 0;0 +526 KEY_ZR 0;0 0;0 +527 KEY_ZR 0;0 0;0 +528 KEY_ZR 0;0 0;0 +529 KEY_ZR 0;0 0;0 +530 KEY_ZR 0;0 0;0 +531 KEY_ZR 0;0 0;0 +532 KEY_ZR 0;0 0;0 +533 KEY_ZR 0;0 0;0 +534 KEY_ZR 0;0 0;0 +535 KEY_ZR 0;0 0;0 +536 KEY_ZR 0;0 0;0 +537 KEY_ZR 0;0 0;0 +538 KEY_ZR 0;0 0;0 +539 KEY_ZR 0;0 0;0 +540 KEY_ZR 0;0 0;0 +541 KEY_ZR 0;0 0;0 +542 KEY_ZR 0;0 0;0 +543 KEY_ZR 0;0 0;0 +544 KEY_ZR 0;0 0;0 +545 KEY_ZR 0;0 0;0 +546 KEY_ZR 0;0 0;0 +547 KEY_ZR 0;0 0;0 +548 KEY_ZR 0;0 0;0 +549 KEY_ZR 0;0 0;0 +550 KEY_ZR 0;0 0;0 +551 KEY_ZR 0;0 0;0 +552 KEY_ZR 0;0 0;0 +553 KEY_ZR 0;0 0;0 +554 KEY_ZR 0;0 0;0 +555 KEY_ZR 0;0 0;0 +556 KEY_ZR 0;0 0;0 +557 KEY_ZR 0;0 0;0 +558 KEY_ZR 0;0 0;0 +559 KEY_ZR 0;0 0;0 +560 KEY_ZR 0;0 0;0 +561 KEY_ZR 0;0 0;0 +562 KEY_ZR 0;0 0;0 +563 KEY_ZR 0;0 0;0 +564 NONE 0;0 0;0 +565 NONE 0;0 0;0 +566 NONE 0;0 0;0 +567 NONE 0;0 0;0 +568 NONE 0;0 0;0 +569 NONE 0;0 0;0 +570 NONE 0;0 0;0 +571 NONE 0;0 0;0 +572 NONE 0;0 0;0 +573 NONE 0;0 0;0 +574 NONE 0;0 0;0 +575 NONE 0;0 0;0 +576 NONE 0;0 0;0 +577 NONE 0;0 0;0 +578 NONE 0;0 0;0 +579 NONE 0;0 0;0 +580 NONE 0;0 0;0 +581 NONE 0;0 0;0 +582 NONE 0;0 0;0 +583 NONE 0;0 0;0 +584 NONE 0;0 0;0 +585 NONE 0;0 0;0 +586 NONE 0;0 0;0 +587 NONE 0;0 0;0 +588 NONE 0;0 0;0 +589 NONE 0;0 0;0 +590 NONE 0;0 0;0 +591 NONE 0;0 0;0 +592 KEY_ZR 0;-32767 0;0 +593 KEY_ZR 0;-32767 0;0 +594 KEY_ZR 0;-32767 0;0 +595 KEY_ZR 0;-32767 0;0 +596 KEY_ZR 0;-32767 0;0 +597 KEY_ZR 0;-32767 0;0 +598 KEY_ZR 0;-32767 0;0 +599 KEY_ZR 0;-32767 0;0 +600 KEY_ZR 0;-32767 0;0 +601 KEY_ZR 0;-32767 0;0 +602 KEY_ZR 0;-32767 0;0 +603 KEY_ZR 0;-32767 0;0 +604 KEY_ZR 0;-32767 0;0 +605 KEY_ZR 0;-32767 0;0 +606 KEY_ZR 0;-32767 0;0 +607 KEY_ZR 0;-32767 0;0 +608 KEY_ZR 0;-32767 0;0 +609 KEY_ZR 0;-32767 0;0 +610 KEY_ZR 0;-32767 0;0 +611 KEY_ZR 0;-32767 0;0 +612 KEY_ZR 0;-32767 0;0 +613 KEY_ZR 0;-32767 0;0 +614 KEY_ZR 0;-32767 0;0 +615 KEY_ZR 0;-32767 0;0 +616 KEY_ZR 0;-32767 0;0 +617 KEY_ZR 0;-32767 0;0 +618 KEY_ZR 0;-32767 0;0 +619 KEY_ZR 0;-32767 0;0 +620 KEY_ZR 0;-32767 0;0 +621 KEY_ZR 0;-32767 0;0 +622 KEY_ZR 0;-32767 0;0 +623 KEY_ZR 0;-32767 0;0 +624 KEY_ZR 0;-32767 0;0 +625 KEY_ZR 0;-32767 0;0 +626 KEY_ZR 0;-32767 0;0 +627 KEY_ZR 0;-32767 0;0 +628 KEY_ZR 0;-32767 0;0 +629 KEY_ZR 0;-32767 0;0 +630 KEY_ZR 0;-32767 0;0 +631 KEY_ZR 0;-32767 0;0 +632 KEY_ZR 0;-32767 0;0 +633 KEY_ZR 0;-32767 0;0 +634 KEY_ZR 0;-32767 0;0 +635 KEY_ZR 0;-32767 0;0 +636 KEY_ZR 0;-32767 0;0 +637 KEY_ZR 0;-32767 0;0 +638 KEY_ZR 0;-32767 0;0 +639 KEY_ZR 0;-32767 0;0 +640 KEY_ZR 0;-32767 0;0 +641 KEY_ZR 0;-32767 0;0 +642 KEY_ZR 0;-32767 0;0 +643 KEY_ZR 0;-32767 0;0 +644 KEY_ZR 0;-32767 0;0 +645 KEY_ZR 0;-32767 0;0 +646 KEY_ZR 0;-32767 0;0 +647 KEY_ZR 0;-32767 0;0 +648 KEY_ZR 0;-32767 0;0 +649 KEY_ZR 0;-32767 0;0 +650 KEY_ZR 0;-32767 0;0 +651 KEY_ZR 0;-32767 0;0 +652 KEY_ZR 0;-32767 0;0 +653 KEY_ZR 0;-32767 0;0 +654 KEY_ZR 0;-32767 0;0 +655 KEY_ZR 0;-32767 0;0 +656 KEY_ZR 0;-32767 0;0 +657 KEY_ZR 0;-32767 0;0 +658 KEY_ZR 0;-32767 0;0 +659 KEY_ZR 0;-32767 0;0 +660 KEY_ZR 0;-32767 0;0 +661 KEY_ZR 0;-32767 0;0 +662 KEY_ZR 0;-32767 0;0 +663 KEY_ZR 0;-32767 0;0 +664 KEY_ZR 0;-32767 0;0 +665 KEY_ZR 0;-32767 0;0 +666 KEY_ZR 0;-32767 0;0 +667 KEY_ZR 0;-32767 0;0 +668 KEY_ZR 0;-32767 0;0 +669 KEY_ZR 0;-32767 0;0 +670 KEY_ZR 0;-32767 0;0 +671 KEY_ZR 0;-32767 0;0 +672 KEY_ZR 0;-32767 0;0 +673 KEY_ZR 0;-32767 0;0 +674 KEY_ZR 0;-32767 0;0 +675 KEY_ZR 0;-32767 0;0 +676 KEY_ZR 0;-32767 0;0 +677 KEY_ZR 0;-32767 0;0 +678 KEY_ZR 0;-32767 0;0 +679 KEY_ZR 0;-32767 0;0 +680 KEY_ZR 0;-32767 0;0 +681 KEY_ZR 0;-32767 0;0 +682 KEY_ZR 0;-32767 0;0 +683 KEY_ZR 0;-32767 0;0 +684 KEY_ZR 0;-32767 0;0 +685 KEY_ZR 0;-32767 0;0 +686 KEY_ZR 0;-32767 0;0 +687 KEY_ZR 0;-32767 0;0 +688 KEY_ZR 0;-32767 0;0 +689 KEY_ZR 0;-32767 0;0 +690 KEY_ZR 0;-32767 0;0 +691 KEY_ZR 0;-32767 0;0 +692 KEY_ZR 0;-32767 0;0 +693 KEY_ZR 0;-32767 0;0 +694 KEY_ZR 0;-32767 0;0 +695 KEY_ZR 0;-32767 0;0 +696 KEY_ZR 0;-32767 0;0 +697 KEY_ZR 0;-32767 0;0 +698 KEY_ZR 0;-32767 0;0 +699 KEY_ZR 0;-32767 0;0 +700 KEY_ZR 0;-32767 0;0 +701 KEY_ZR 0;-32767 0;0 +702 KEY_ZR 0;-32767 0;0 +703 KEY_ZR 0;-32767 0;0 +704 KEY_ZR 0;-32767 0;0 +705 KEY_ZR 0;-32767 0;0 +706 KEY_ZR 0;-32767 0;0 +707 KEY_ZR 0;-32767 0;0 +708 KEY_ZR 0;-32767 0;0 +709 KEY_ZR 0;-32767 0;0 +710 KEY_ZR 0;-32767 0;0 +711 KEY_ZR 0;-32767 0;0 +712 KEY_ZR 0;-32767 0;0 +713 KEY_ZR 0;-32767 0;0 +714 KEY_ZR 0;-32767 0;0 +715 KEY_ZR 0;-32767 0;0 +716 KEY_ZR 0;-32767 0;0 +717 KEY_ZR 0;-32767 0;0 +718 KEY_ZR 0;-32767 0;0 +719 KEY_ZR 0;-32767 0;0 +720 KEY_ZR 0;-32767 0;0 +721 KEY_ZR 0;-32767 0;0 +722 KEY_ZR 0;-32767 0;0 +723 KEY_ZR 0;-32767 0;0 +724 KEY_ZR 0;-32767 0;0 +725 KEY_ZR 0;-32767 0;0 +726 KEY_ZR 0;-32767 0;0 +727 KEY_ZR 0;-32767 0;0 +728 KEY_ZR 0;-32767 0;0 +729 KEY_ZR 0;-32767 0;0 +730 KEY_ZR 0;-32767 0;0 +731 KEY_ZR 0;-32767 0;0 +732 KEY_ZR 0;-32767 0;0 +733 KEY_ZR 0;-32767 0;0 +734 KEY_ZR 0;-32767 0;0 +735 KEY_ZR 0;-32767 0;0 +736 KEY_ZR 0;-32767 0;0 +737 KEY_ZR 0;-32767 0;0 +738 KEY_ZR 0;-32767 0;0 +739 KEY_ZR 0;-32767 0;0 +740 KEY_ZR;KEY_L 0;-32767 0;0 +741 KEY_ZR 0;0 0;0 +742 KEY_ZR 0;0 0;0 +743 KEY_ZR 0;0 0;0 +744 KEY_ZR 0;0 0;0 +745 KEY_ZR 0;0 0;0 +746 KEY_ZR 0;0 0;0 +747 KEY_ZR 0;0 0;0 +748 KEY_ZR 0;0 0;0 +749 KEY_ZR 0;0 0;0 +750 KEY_ZR 0;0 0;0 +751 KEY_ZR 0;0 0;0 +752 KEY_ZR 0;0 0;0 +753 KEY_ZR 0;0 0;0 +754 KEY_ZR 0;0 0;0 +755 KEY_ZR 0;0 0;0 +756 KEY_ZR;KEY_L 0;0 0;0 +757 KEY_ZR 0;0 0;0 +758 KEY_ZR 0;0 0;0 +759 KEY_ZR 0;0 0;0 +760 KEY_ZR 0;0 0;0 +761 KEY_ZR 0;0 0;0 +762 KEY_ZR 0;0 0;0 +763 KEY_ZR 0;0 0;0 +764 KEY_ZR 0;0 0;0 +765 KEY_ZR 0;0 0;0 +766 KEY_ZR 0;0 0;0 +767 KEY_ZR 0;0 0;0 +768 KEY_ZR 0;0 0;0 +769 KEY_ZR 0;0 0;0 +770 KEY_ZR 0;0 0;0 +771 KEY_ZR 0;0 0;0 +772 KEY_ZR;KEY_L 0;0 0;0 diff --git a/site/content/help/feature/telemetry.md b/site/content/help/feature/telemetry.md new file mode 100644 index 0000000..28e6a66 --- /dev/null +++ b/site/content/help/feature/telemetry.md @@ -0,0 +1,45 @@ ++++ +title = "Telemetry" +description = "Telemetry features" ++++ + +yuzu has some [issues](https://github.com/yuzu-emu/yuzu/issues), and by its +nature as an open source project, they are visible to everyone and fixable by +anyone. Unfortunately though, most contributions are made by +[a small minority of developers](https://github.com/yuzu-emu/yuzu/graphs/contributors). +These developers have found it difficult to prioritize their efforts, since the +majority of issue reports are written scattered across Discord, Reddit, forums, +IRC, and too many other places to count. + +Because of this, the yuzu team has put together a framework to report data about +how yuzu is used to our server, and use that data to discover what are the most +popular games and hardware configurations, where emulated games crash in yuzu +most often, and more. We had considered including this in last month's progress +report, but we decided that it would be best to publish this on its own, so it +gets the attention it deserves. We're very aware that privacy is important to +many of our users, and so from the earliest planning stage we knew we must be as +transparent and open about this as possible. + +The telemetry framework will collect information such as: + + * Information about the version of yuzu you are using + * Performance data for the games you play + * Your yuzu configuration settings + * Information about your computer hardware (e.g. GPU, CPU, and OS type) + * Emulation errors and crash information + +Not everyone is comfortable sharing information about their system, so we've made it easy to opt-out. + +You may have also noticed the field titled "Telemetry ID" in the screenshots, this +is an identifier generated randomly on install which is used instead of your IP +address. This makes data collection entirely anonymous, unless you choose to log in. +You can also reset your telemetry ID if you'd like by clicking "Regenerate". The +new ID will also be completely random, and so it would be treated as a wholly new +identity. + +Telemetry is an extremely useful developer tool, as they allow the developer to +be more aware of the users' needs and priorities accurately, rather than guessing. +But it is only as useful as the data obtained, which is why we urge users to not +opt-out, so the data can be as accurate and correct as possible. Just as inaccurate +measurements can damage a device during calibration, inaccurate statistical data +will only cause damage to yuzu. diff --git a/site/content/help/quickstart/atmosphere_dir.png b/site/content/help/quickstart/atmosphere_dir.png new file mode 100644 index 0000000..da31ede Binary files /dev/null and b/site/content/help/quickstart/atmosphere_dir.png differ diff --git a/site/content/help/quickstart/gpu_info.png b/site/content/help/quickstart/gpu_info.png new file mode 100644 index 0000000..55af4f0 Binary files /dev/null and b/site/content/help/quickstart/gpu_info.png differ diff --git a/site/content/help/quickstart/hekate_dir.png b/site/content/help/quickstart/hekate_dir.png new file mode 100644 index 0000000..a9ab734 Binary files /dev/null and b/site/content/help/quickstart/hekate_dir.png differ diff --git a/site/content/help/quickstart/hekate_ipl.ini b/site/content/help/quickstart/hekate_ipl.ini new file mode 100644 index 0000000..f54da89 --- /dev/null +++ b/site/content/help/quickstart/hekate_ipl.ini @@ -0,0 +1,6 @@ +[config] +updater2p=1 + +[CFW - sysMMC] +fss0=atmosphere/package3 +emummc_force_disable=1 \ No newline at end of file diff --git a/site/content/help/quickstart/index.md b/site/content/help/quickstart/index.md new file mode 100644 index 0000000..4d74394 --- /dev/null +++ b/site/content/help/quickstart/index.md @@ -0,0 +1,618 @@ +--- +title: Quickstart Guide +description: A guide designed to get you started with yuzu quickly. +--- + +## Table of Contents + +* [Downloading and Installing yuzu](#downloading-and-installing-yuzu) +* [Hardware Requirements](#hardware-requirements) +* [Guide Introduction](#guide-introduction) +* [Prerequisites](#prerequisites) +* [Booting into RCM](#booting-into-rcm) +* [Preparing the microSD Card](#preparing-the-microsd-card) +* [Booting Hekate from RCM](#booting-hekate-from-rcm) +* [Formatting the microSD Card to FAT32 (Recommended)](#formatting-the-microsd-card-to-fat32-recommended) +* [Backing up Switch NAND (Optional)](#backing-up-switch-nand-optional) +* [Dumping Decryption Keys](#dumping-decryption-keys) +* [Dumping System Firmware](#dumping-system-firmware) +* [Dumping Games](#dumping-games) + * [Dumping Physical Titles (Game Cards)](#dumping-physical-titles-game-cards) + * [Dumping Installed Updates/DLCs from Physical Titles](#dumping-installed-updatesdlcs-from-physical-titles) + * [Dumping Digital Titles (eShop)](#dumping-digital-titles-eshop) + * [Dumping Installed Updates](#dumping-installed-updates) + * [Dumping Installed DLCs](#dumping-installed-dlcs) +* [Dumping Save Files (Optional)](#dumping-save-files-optional) +* [Booting Hekate from CFW](#booting-hekate-from-cfw) +* [Mounting the microSD Card from your Switch to your Computer](#mounting-the-microsd-card-from-your-switch-to-your-computer) +* [Setting up yuzu](#setting-up-yuzu) + * [Setting up the Decryption Keys and Firmware](#setting-up-the-decryption-keys-and-firmware) + * [Transferring Games](#transferring-games) + * [Merging Split Game Dumps](#merging-split-game-dumps) + * [Adding Games to yuzu](#adding-games-to-yuzu) + * [Installing Game Updates/DLCs to yuzu](#installing-game-updatesdlcs-to-yuzu) + * [Transferring Save Data of a Game to yuzu](#transferring-save-data-of-a-game-to-yuzu) +* [Rebooting Back to Stock Firmware](#rebooting-back-to-stock-firmware) +* [Running yuzu](#running-yuzu) + +## Downloading and Installing yuzu + +{{< youtube j0fXerrGjF4 >}} + +## Hardware Requirements + +#### CPU: + +Any x86_64 CPU with support for the FMA instruction set, or an ARM64-v8a or newer CPU. 6 threads or more are recommended. + +- **Minimum:** Intel Core i5-4430 / AMD Ryzen 3 1200 / Qualcomm Snapdragon 460 + +- **Recommended:** Intel Core i5-11400 / AMD Ryzen 5 3600 / Qualcomm Snapdragon 865 + +- **Optimal:** Intel Core i9-13900K / AMD Ryzen 7 7800X3D / Qualcomm Snapdragon 8 Gen 2 + +#### Dedicated graphics: + +OpenGL 4.6 or Vulkan 1.1 compatible hardware and drivers are mandatory. Half-float support and VP9 decoding support are recommended. + +- **Minimum for Linux:** NVIDIA GeForce GT 1050 4GB / AMD Radeon R7 240 4GB + +- **Minimum for Windows:** NVIDIA GeForce GT 1050 4GB / AMD Radeon RX 550 4GB + +- **Recommended:** NVIDIA GeForce GTX 1660 6GB / AMD Radeon RX 5500 8GB [(with "Force maximum clocks" enabled)](https://yuzu-emu.org/entry/yuzu-progress-report-jan-2023/turboui.png) + +- **Optimal:** NVIDIA Geforce RTX 3060 12GB / AMD Radeon RX 6700 10GB [(with "Force maximum clocks" enabled)](https://yuzu-emu.org/entry/yuzu-progress-report-jan-2023/turboui.png) + +#### Integrated graphics: + +Integrated graphics will produce very low performance. A dedicated GPU will produce better results on all scenarios. +This is only for listing iGPU support. + +- **Minimum for Linux:** Intel HD Graphics 4400 / AMD Radeon R5 Graphics + +- **Minimum for Windows:** Intel UHD Graphics 730 / AMD Radeon Vega 3 + +- **Minimum for Android:** Qualcomm Adreno 605 (with Turnip drivers) / ARM Mali G57 + +- **Recommended:** Intel Iris Xe Graphics / AMD Radeon 680M / Qualcomm Adreno 740 / ARM Mali G720 + +#### RAM: + +Since an integrated GPU uses system RAM as its video memory (VRAM), our memory requirement in this configuration is higher. Highest possible frequency is strongly recommended. + +- **Minimum with dedicated graphics & for Android:** 8 GB + +- **Minimum with integrated graphics:** 12 GB + +- **Recommended:** 16 GB + +- **Optimal:** 32 GB + +#### Notes: + +- An up-to-date Windows 10 version is required, old Windows 10 releases or older Windows versions are not supported. Windows 11 offers similar performance. + +- Our recommended/optimal specifications don't guarantee perfect performance in all games, but rather strive to provide a cost effective recommendation while still considering performance. + +- CPUs lacking the FMA instruction set will produce very poor results. Intel Core gen 3 series or older and old Pentium/Celeron/Atom CPUs will not produce optimal results. + +- Mobile CPUs will not reach the same performance as their desktop counterparts due to thermal, power, and technical limitations. + +- Check our recommended settings and drivers [here](https://community.citra-emu.org/t/recommended-settings/319349). + +- **GPUs must support OpenGL 4.6 & OpenGL Compatibility profile, or Vulkan 1.1 (or higher).**<br> +To find out if your GPU meets these requirements, visit https://opengl.gpuinfo.org or https://vulkan.gpuinfo.org/ and check your GPU details.<br> + +Sample Image: + +![GPUInfo](./gpu_info.png) + +## Guide Introduction + +To start playing commercial games, yuzu needs a couple of system files from a **HACKABLE** Nintendo Switch console in order to play them properly. + +This guide will help you copy all your system files, games, updates, and DLC from your Switch to your computer and organize them in a format yuzu understands. This process should take about 60 to 90 minutes. + +<article class="message has-text-weight-semibold"> + <div class="message-body"> + <p>DISCLAIMER:</p> + <ul> + <li>This guide is designed for early Switch consoles that are vulnerable to the <code>fusée-gelée</code> RCM exploit, as it is the most accessible entryway to load custom firmware and run the tools necessary to obtain the required system files and games. + <li>While there are possible ways to jailbreaking patched Switch models, instructions for booting into custom firmware may differ from this guide, but the overall dumping process should mostly be the same as long as you are able to run Hekate and Atmosphére on your console. + <ul> + <li>Join the <a href="https://discord.gg/u77vRWY">yuzu Discord server</a> for any further assistance on this case.</li> + </ul> + <li>The following Switch models are patched from <code>fusée-gelée</code> and therefore, unable to complete the first couple of steps: + <ul> + <li>Original Switch model manufactured after 2018. + <ul> + <li>Visit <a href="https://ismyswitchpatched.com/">Is My Switch Patched?</a> to check if your console is patched.</li> + </ul> + <li>Mariko Switch released in late 2019 (also known as the Red Box Switch, HAC-001(-01))</li> + <li>Nintendo Switch Lite (HDH-001)</li> + <li>Nintendo Switch OLED Model (HEG-001)</li> + </ul> + </ul> + </div> +</article> + +## Prerequisites + +- A **hackable** Nintendo Switch console (preferably a model that is vulnerable to the `fusée-gelée` exploit). + - Visit [Is My Switch Patched?](https://ismyswitchpatched.com/) to check if your console is not patched. +- A **microSD card** with at least `32 GB` of storage capacity. `64 GB` or higher is recommended. +- A **USB-C to USB-A** or **USB-C to USB-C cable** to connect your Switch to your computer. +- [TegraRcmGUI](https://github.com/eliboa/TegraRcmGUI/releases/latest) -- Download `TegraRcmGUI_v2.6_Installer.msi` +- [ums-loader](https://github.com/lulle2007200/ums-loader/releases/latest) -- Download `ums-loader.bin` +- [Hekate](https://github.com/CTCaer/hekate/releases/latest) -- Download `hekate_ctcaer_X.X.X_Nyx_X.X.X.zip` + - **Windows users:** Also download `nyx_usb_max_rate__run_only_once_per_windows_pc.reg` and run it for faster transfer speeds over USB. For details, see the **NOTE** section in the release page. +- This hekate configuration file -- [hekate_ipl.ini](./hekate_ipl.ini) +- [Atmosphére](https://github.com/Atmosphere-NX/Atmosphere/releases/latest) -- Download both `atmosphere-X.X.X-master-XXXXXXXX+hbl-X.X.X+hbmenu-X.X.X.zip` and `fusee.bin`. +- [Lockpick_RCM](https://github.com/shchmue/Lockpick_RCM/releases/latest) -- Download `Lockpick_RCM.bin` +- [NXDumpTool](https://github.com/DarkMatterCore/nxdumptool/releases/latest) -- Download `nxdumptool.nro` +- [nxDumpFuse](https://github.com/oMaN-Rod/nxDumpFuse/releases/latest) -- Download `win-x64.zip` +- [TegraExplorer](https://github.com/suchmememanyskill/TegraExplorer/releases/latest) -- Download `TegraExplorer.bin` +- (Optional) [JKSV](https://github.com/J-D-K/JKSV/releases/latest) -- Download `JKSV.nro` + - Download this homebrew application if you wish to dump your save data from your Switch to yuzu. +- [RCM Jig](https://www.amazon.com/dp/B07J9JJRRG) -- We highly recommend one like this, but you could use any of the methods outlined [here.](https://noirscape.github.io/RCM-Guide/) + +## Booting into RCM + +The Switch has a hidden recovery mode called `RCM`. The `fusée-gelée` exploit abuses a critical error from RCM, where binaries sent to the console have their data read before checking for signatures. As such, you can run any custom code on your Switch as long as it's vulnerable to this exploit. However, these steps won't work on patched models despite RCM also existing on such consoles. + +**Step 1:** Open the **TegraRcmGUI installer** (`TegraRcmGUI_v2.6_Installer.msi`), go through the installation wizard, and start **TegraRcmGUI**. + +**Step 2:** In the `Settings` tab, click on `Install Driver` and follow the installation instructions. + +**Step 3:** After the drivers have been installed, connect your Switch to your computer using a **USB-C cable**. + +**Step 4:** Hold the `Power` button to enter the power menu, select `Power Options` and then select `Power Off`. Keep your Switch connected to your computer. + +**Step 5:** Insert your **RCM jig** into the **right side Joy-Con rail**, make sure it is seated securely at the base. + +**Step 6:** Hold `Volume +` and press the `Power` button. + +If you see the Switch icon turn **green** with `RCM O.K.` in the TegraRcmGUI window, your console has successfully booted into RCM mode. +> If your Switch starts to turn on normally (Nintendo logo appears), go back to **Step 4** and try again. + +Once you have successfully booted into RCM mode, you can now remove the RCM jig from the console. + +## Preparing the microSD Card + +We'll now place some files downloaded from the prerequisites section to the microSD card. We can mount the card from a Switch to a computer via USB using the **ums-loader** payload. + +**Step 1:** Insert the microSD card into the microSD card slot of your Switch. + +**Step 2:** Open **TegraRcmGUI**. In the `Payload` tab, click on the folder icon and navigate to the `ums-loader.bin` file you downloaded earlier. + +**Step 3:** Click on `Inject Payload` and your Switch will now boot into the UMS menu. + +**Step 4:** Navigate through the menu using the `Volume` buttons and select `Start UMS` using the `Power` button. You should see a removable drive showing up on your computer. + +**Step 5:** Open the file explorer and navigate to the microSD card drive. +> **NOTE:** If you have a `Nintendo` folder in your microSD card, make a backup of it by copying the folder to your computer. + +**Step 6:** Extract all the contents inside the `atmosphere-X.X.X-master-XXXXXXXX+hbl-X.X.X+hbmenu-X.X.X.zip` archive into the root of the microSD card. + +**Step 7:** Extract the `bootloader` folder from inside the `hekate_ctcaer_X.X.X_Nyx_X.X.X.zip` archive into the root of the microSD card. +> **IMPORTANT:** Drag and drop the contents, do not create any new folders from the previous `.zip` files. + +**Step 8:** Place the `hekate_ipl.ini` file into the `bootloader` folder. + +**Step 9:** Place the `fusee.bin`, `Lockpick_RCM.bin` and `TegraExplorer.bin` files into the `payloads` folder (located inside the `bootloader` folder). + +**Step 10:** Create a folder named `nxdumptool` within the `switch` folder and place the `nxdumptool.nro` file inside it. + +> If you've downloaded JKSV from [Prerequisites](#prerequisites), place the `JKSV.nro` file into the `switch` folder. + +**Step 11:** Check that you've placed all of the files correctly using the following screenshots: +<details> +<summary>Screenshots</summary> + +![microSD card root](./sd_root.png) +![Atmosphére folder](./atmosphere_dir.png) +![Hekate folder](./hekate_dir.png) +![Payloads folder](./payloads_dir.png) +![Switch folder](./switch_dir.png) + +</details> + +**Step 12:** Safely eject the microSD card drive. Do not unplug the Switch from your computer yet. +> If unsure of how to safely eject media, use one of the following support pages corresponding to your OS: +> - **Windows users:** [Safely remove hardware in Windows](https://support.microsoft.com/en-us/windows/safely-remove-hardware-in-windows-1ee6677d-4e6c-4359-efca-fd44b9cec369) + +**Step 13:** From the UMS menu, select `Reboot RCM`. Your Switch will now boot into RCM mode. + +## Booting Hekate from RCM + +**Hekate** is a custom bootloader which allows you to load custom firmware and the many tools used for the dumping process. + +**Step 1:** Extract the `hekate_ctcaer_X.X.X.bin` file from the `hekate_ctcaer_X.X.X_Nyx_X.X.X.zip` archive to any directory on your computer. + +**Step 2:** Open **TegraRcmGUI**. In the `Payload` tab, click on the folder icon and navigate to the `hekate_ctcaer_X.X.X.bin` file you extracted earlier. + +**Step 3:** Click on `Inject Payload` and your Switch will now boot into the Hekate custom bootloader. + +> **NOTE:** If you see a vertical text-based menu appearing on your Switch's display, some of the Hekate files might not be stored in the correct places in your microSD card. Use the `Volume` buttons to navigate through the Hekate menu and select `Power off` using the `Power` button to turn off the console. Make sure that the files in your microSD card match up with the images shown in [Preparing the microSD Card](#preparing-the-microsd-card) and then try again. + +## Formatting the microSD Card to FAT32 (Recommended) + +We'll now format the microSD card to `FAT32` using **Hekate**. +> **NOTE:** The `exFAT` file system is not recommended for regular usage on the Switch, as it's prone to file corruption. Large capacity microSD cards are usually formatted as `exFAT` by default. + +**Step 1:** In the Hekate Home menu, tap on the `Tools` tab and select `Partition SD Card`. +> Hekate's partition manager by default will temporarily store all data from the card into memory and places it back after the formatting process is done. If the pop-up windows says that data cannot be backed up, select the `SD UMS` option to mount the microSD card to your computer to manually back up your data. + +**Step 2:** Tap `OK` on the pop-up and then tap `Next Step`. + +**Step 3:** Tap `Start` to start the formatting process. After the safety timer, press the `Power` button. + +**Step 4:** Once the formatting process has completed, tap `OK`. +> If you have backed up your `Nintendo` folder, you can select the `SD UMS` option from the Partition Manager menu to mount the microSD card to your computer and place it back in there. Once you're done, safely eject the drive and then tap `Close` and `OK` on your Switch to proceed with the last step. + +**Step 5:** Tap `Close` and lastly `Home` to return to the Hekate Home menu. + +## Backing up Switch NAND (Optional) + +All the tools used in this guide do not alter or modify the data stored inside the Switch. However, it is possible to make a backup of the entire internal storage (`NAND`) of your console using **Hekate** for recovery purposes. + +**Step 1:** In the Hekate Home menu, tap on the `Tools` tab and select `Backup eMMC`. + +**Step 2:** Tap on `eMMC BOOT0 & BOOT1`. +> This may take a few seconds to load. After the progress bar has finished, it should show `Finished and verified!`. Beneath `Filepath:` you will see the location of the `BOOT0` and `BOOT1` dump. + +**Step 3:** Tap on `Close` and select `eMMC RAW GPP`. +> This should take some time as a Switch's `rawnand.bin` file is quite large. If the progress bar appears to go backwards at some points or turn green, do not worry as this is just Hekate verifying the data. The backup process should take between 10-45 minutes to complete depending on the quality/speed of your microSD card at the default verification setting. Keep note of the location of the output file(s). + +**Step 4:** Tap on `Close` twice to return to the `Tools` menu. + +To access the NAND backup, we'll now mount the microSD card as a drive from your Switch to your computer via USB. + +**Step 5:** Tap on `USB Tools` and select `SD Card`. The microSD card should now show up on your computer as a USB drive. + +**Step 6:** Navigate to the microSD card drive and copy the `backup` folder to your computer. + +**Step 7:** Once the file transfer has completed, safely eject the microSD card drive. Do not unplug the Switch from your computer yet. +> If unsure of how to safely eject media, use one of the following support pages corresponding to your OS: +> - **Windows users:** [Safely remove hardware in Windows](https://support.microsoft.com/en-us/windows/safely-remove-hardware-in-windows-1ee6677d-4e6c-4359-efca-fd44b9cec369) + +We'll now return to the Hekate Home menu to proceed with the remaining sections of the guide. + +**Step 8:** Tap on `Close` twice to return to the `Tools` menu. + +**Step 9:** Tap on the `Home` tab to return to the Hekate Home menu. + +## Dumping Decryption Keys + +We will now dump the decryption keys from your Switch using **Lockpick_RCM** so that yuzu is able to decrypt and open your game files (including amiibo dumps). + +> **NOTE:** Make sure that your Switch is on the latest system update before proceeding with this section. + +**Step 1:** In the Hekate Home menu, tap on `Payloads`. + +**Step 2:** Tap on `Lockpick_RCM.bin` in the list of payloads. + +**Step 3:** In Lockpick_RCM, press the `Power` button to select `Dump from SysNAND`. + +> After Lockpick_RCM has finished dumping the keys, the files will be stored in `sdcard:/switch/prod.keys` and `sdcard:/switch/title.keys`. + +**Step 4:** Press any button to return to the main menu. + +**Step 5:** Navigate through the menu using the `Volume` buttons to highlight and select `Dump Amiibo Keys` using the `Power` button. + +> The amiibo decryption keys will be stored in `sdcard:/switch/key_retail.bin`. + +**Step 6:** Press any button to return to the main menu, then navigate using the `Volume` buttons to highlight and select `Reboot to hekate` using the `Power` button. You should now be booted back into Hekate. + +## Dumping System Firmware + +Some games such as _Mario Kart 8 Deluxe_ require the use of system files found inside the Switch's **System Firmware** to be playable. We'll now dump the firmware files from your Switch using **TegraExplorer**. + +> **NOTE:** Make sure that your Switch is on the latest system update before proceeding with this section. + +**Step 1:** In the Hekate Home menu, tap on `Payloads`. + +**Step 2:** Tap on `TegraExplorer.bin` in the list of payloads. + +**Step 3:** In TegraExplorer, navigate through the main menu using the `Volume` buttons and select the `FirmwareDump.te` script using the `Power` button. + +**Step 4:** Select `Dump sysmmc`. + +> After TegraExplorer has finished dumping the firmware, the files will be stored in `sdcard:/tegraexplorer/Firmware/<firmware version>` as a series of `.nca` files. + +**Step 5:** Press any button to return to the main menu and select `Reboot to bootloader/update.bin`. You should now be booted back into Hekate. + +## Dumping Games + +This section covers the dumping process for any game on your Switch that is either a digital or physical copy, alongside any installed game updates and DLC. We'll be using **NXDumpTool** for this. + +> **NOTE:** Make sure that all of your games are up-to-date before proceeding with this section. + +**Step 1:** In the Hekate Home menu, tap on `Launch`. + +**Step 2:** Tap on `CFW - sysMMC`. + +> **NOTE:** If you get the following error message: +> ``` +> Error while loading fss0: +> atmosphere/package3 +> Wrong ini cfg or missing/corrupt files! +> +> Failed to launch HOS! +> ``` +> Some of the Atmosphére files might not be stored in the correct places in your microSD card. Press any button to return to the Hekate menu and tap on `Power Off` to turn off your console. Make sure that the files in your microSD card match up with the images shown in [Preparing the microSD Card](#preparing-the-microsd-card) and then try again. + +> Your Switch will now boot into the **Atmosphére** custom firmware (`CFW`). You should see the Atmosphére logo show up instead of the Nintendo logo at boot. It is normal that the HOME Menu remains the same and you can double check that you're loaded into CFW by navigating to **System Settings > System** and checking the `Current version` value. +> +> The current version value should resemble something like this: `XX.X.X|AMS 1.X.X|S` + +**Step 3:** Once your Switch has booted into the HOME Menu, hold the `R` button on your controller while launching any game to access the **hbmenu**. +> The Homebrew menu (`hbmenu`) can be loaded from two different modes: +> - **Applet Mode:** Opening the **Album**, substituting the Album app by default when CFW is loaded into the system. You can still access the original app by opening **Album** while holding `R` on your controller. +> - **Title Override:** Holding `R` on your controller while launching any game. +> +> For the purpose of this section, we are launching the **hbmenu** via **Title Override** as that mode will grant full RAM access from the console for maximum performance and stability in the dumping process. + +**Step 4:** Use the touchscreen or your controller to navigate through the hbmenu and select `nxdumptool`. + +You should now be at the main menu of NXDumpTool, displaying the following options: +> - **Dump gamecard content** +> - **Dump installed SD card / eMMC content** +> - **Update options** + +### Dumping Physical Titles (Game Cards) + +**Step 1:** Select `Dump gamecard content`. + +**Step 2:** Select `NX Card Image (XCI) dump`. + +**Step 3:** Set the following settings: +> - **Split output dump (FAT32 support):** `Yes` +> - **Create directory with archive bit set:** `No` +> - **Keep certificate:** `No` +> - **Trim output dump:** `Yes` +> - **CRC32 checksum calculation + dump verification:** `No` + +**Step 4:** Select `Start XCI dump process`. Wait for the dumping process to finish. + +**Step 5:** Press any button to return to the previous menu and then press `B` twice to return to the main menu. + +### Dumping Installed Updates/DLCs from Physical Titles + +**Step 1:** Select `Dump installed SD card / eMMC content`. + +**Step 2:** Press `Y` to enter into the `Dump installed content with missing base application` menu. + +**Step 3:** Select the update or DLC you wish to dump from the list. + +**Step 4:** Select `Nintendo Submission Package (NSP) dump`. + +**Step 5:** Set the following settings: +> For update dumps: +> - **Split output dump (FAT32 support):** `Yes` +> - **Verify dump using No-Intro database:** `No` +> - **Remove console specific data:** `Yes` +> - **Generate ticket-less dump:** `No` +> - **Change NPDM RSA key/sig in Program NCA:** `No` +> - **Dump delta fragments:** `No` +> +> For DLC dumps: +> - **Split output dump (FAT32 support):** `Yes` +> - **Verify dump using No-Intro database:** `No` +> - **Remove console specific data:** `Yes` +> - **Generate ticket-less dump:** `No` + +**Step 6:** Select `Start NSP dump process`. Wait for the dumping process to finish. + +**Step 7:** Press any button to return to the previous menu. Press `B` twice if you want to return to the list of installed updates/DLCs, or press `B` twice again if you're done and want to return to the main menu. + +### Dumping Digital Titles (eShop) + +**Step 1:** Select `Dump installed SD card / eMMC content`. + +**Step 2:** Select the game you wish to dump from the list. + +**Step 3:** Select `Nintendo Submission Package (NSP) dump`. + +> In this menu, you'll see the following options depending on what is installed on your console for the selected game: +> - **Dump base application NSP** +> - **Dump installed update NSP** +> - **Dump installed DLC NSP** +> +> The latter two options are covered in [Dumping Installed Updates](#dumping-installed-updates) and [Dumping Installed DLCs.](#dumping-installed-dlcs) But for now, let's focus on dumping the base application first. + +**Step 4:** Select `Dump base application NSP`. + +**Step 5:** Set the following settings: +> - **Split output dump (FAT32 support):** `Yes` +> - **Verify dump using No-Intro database:** `No` +> - **Remove console specific data:** `Yes` +> - **Generate ticket-less dump:** `No` +> - **Change NPDM RSA key/sig in Program NCA:** `No` + +**Step 6:** Select `Start NSP dump process`. Wait for the dumping process to finish. + +**Step 7:** Press any button to return to the previous menu. Press `B` twice if you want to return to the list of installed digital titles, or press `B` again if you're done and want to return to the main menu. + +### Dumping Installed Updates + +**Step 1:** Select `Dump installed update NSP`. + +**Step 2:** Set the following settings: +> - **Split output dump (FAT32 support):** `Yes` +> - **Verify dump using No-Intro database:** `No` +> - **Remove console specific data:** `Yes` +> - **Generate ticket-less dump:** `No` +> - **Change NPDM RSA key/sig in Program NCA:** `No` +> - **Dump delta fragments:** `No` + +**Step 3:** Select `Start NSP dump process`. Wait for the dumping process to finish. + +**Step 4:** Press any button to return to the previous menu. Press `B` twice if you want to return to the list of installed digital titles, or press `B` again if you're done and want to return to the main menu. + +### Dumping Installed DLCs + +**Step 1:** Select `Dump installed DLC NSP`. + +**Step 2:** Set the following settings: +> - **Split output dump (FAT32 support):** `Yes` +> - **Verify dump using No-Intro database:** `No` +> - **Remove console specific data:** `Yes` +> - **Generate ticket-less dump:** `No` +> - **DLC to dump:** Select the DLC ID to dump + +**Step 3:** Select `Start NSP dump process`. Wait fot the dumping process to finish. + +**Step 4:** Press any button to return to the previous menu. Press `B` three times if you want to return to the list of installed digital titles, or press `B` again if you're done and want to return to the main menu. + +> If you have multiple DLCs installed for the game that you have selected, repeat **Step 2** and **Step 3** but this time selecting another DLC ID from the `DLC to dump` option. + +Once you have finished dumping your game files, press the `+ (Plus)` button on your controller to exit NXDumpTool and return to the hbmenu. + +## Dumping Save Files (Optional) + +We'll now dump the save data of all your games to transfer your progress to yuzu using **JKSV**. + +**Step 1:** Open the **hbmenu** by opening the **Album** or through **Title Override**. + +**Step 2:** Select `JKSV` from the list of homebrew apps. + +**Step 3:** Move up or down to highlight a source from the left side of the interface. +> Most save data are stored under the user account of choice. Some games only save its progress as console saves (such as _Animal Crossing: New Horizons_) are available from the `Device` source. + +**Step 4:** Press the `X` button for `User Options`. + +**Step 5:** Select `Dump All For <User name>`. + +> After JKSV has finished dumping the save data for all your games, the files will be stored in `sd:/JKSV`. + +**Step 6:** Press `+ (Plus)` to exit JKSV and return to the hbmenu. + +## Booting Hekate from CFW + +Once you're done with dumping the games (and/or save data) that you need, we'll now boot into **Hekate** from custom firmware. There's no need to scroll back to the beginning of the guide to achieve this. + +**Step 1:** Hold the ``Power`` button to enter the power menu. + +**Step 2:** Select `Power Options`. + +**Step 3:** Select `Restart`. You should now be booted back into Hekate. + +## Mounting the microSD Card from your Switch to your Computer + +We'll now access the microSD card from the Switch to your computer without the need of taking it out from the microSD card slot. This is done from **Hekate** which has the feature to mount the card over a USB connection. + +**Step 1:** In the Hekate Home menu, tap on the `Tools` tab. + +**Step 2:** Tap on `USB Tools`. + +**Step 3:** Tap on `SD Card`. Your microSD card should now be mounted as a drive to your computer. + +## Setting up yuzu + +We'll now transfer the dumped system firmware, decryption keys and game files from your microSD card to your computer and setting them up for yuzu. + +### Setting up the Decryption Keys and Firmware + +**Step 1:** Open **yuzu** or **yuzu Early Access**. + +**Step 2:** Go to **File > Open yuzu Folder**. This is the `yuzu` data folder where we'll place the decryption keys and firmware files. + +**Step 3:** Open another file explorer window and navigate to your microSD card drive. + +**Step 4:** Open the `switch` folder and copy `prod.keys`, `title.keys`, and `key_retail.bin` files to the `keys` folder (that is inside the `yuzu` folder). + +**Step 5:** Navigate to `sdcard:/tegraexplorer/Firmware/<firmware version>/`. + +**Step 6:** Copy all the `.nca` files and place them in `yuzu/nand/system/Contents/registered/`. + +**Step 7:** Close the `yuzu` folder and relaunch the emulator. The missing keys warning message should not appear at launch anymore. + +### Transferring Games + +**Step 1:** Make a new folder to store all your game dumps somewhere in your computer. + +**Step 2:** Navigate to `sdcard:/switch/nxdumptool/`. +> Your physical game dumps can be found inside the `XCI` folder, while digital games, updates and DLCs are located inside the `NSP` folder. + +**Step 3:** Move every `.xci` and `.nsp` file (not folders) you can find within the `XCI` and `NSP` folders to your newly created games folder. + +> For games/updates/DLCs larger than `4 GB`, you'll notice that its dumped into many parts due to limitations in the `FAT32` filesystem. +> - For physical game dumps, you'll see `.xc0`, `.xc1`, `.xc2`, etc. files inside the `XCI` folder. +> - For digital game dumps, you'll see folder(s) inside the `NSP` folder with the name of the game with `00`, `01`, `02`, etc. files inside each of them. +> +> yuzu cannot recognize those large game dumps in their split state. In order to fix this, we'll be using **nxDumpFuse** to merge the parts together into one complete file. + +### Merging Split Game Dumps + +**Step 1:** Extract `nxDumpFuse.exe` from the `win-x64.zip` archive. + +**Step 2:** Open **nxDumpFuse** and click on `Input`. + +**Step 3:** Navigate to ``sdcard:/switch/nxdumptool`` and open the `NSP` or `XCI` folder. + +**Step 4:** Select one part of the split game dump, then click on `Open`. +> - For physical dumps, select a `.xc0` file. +> - For digital dumps, select a `00` file that is inside a folder with its respective game name. + +**Step 5:** Click on `Output` and navigate to your newly created games folder, then click on `Select Folder`. + +**Step 6:** Click on `Fuse`. Wait for the merging process to finish. +> You can see more details on the merging process by expanding the Log frame. + +Your merged game dumps should now be available at your games folder. + +### Adding Games to yuzu + +**Step 1:** Open **yuzu** or **yuzu Early Access**. + +**Step 2:** Double click on the emulator window to add a game folder. + +**Step 3:** Navigate to your newly created games folder and click `Select Folder`. + +All your dumped games should now appear on the emulator window as a list. However, we're still not done yet! + +### Installing Game Updates/DLCs to yuzu + +**Step 1:** In **yuzu**, go to **File > Install Files to NAND ...** + +**Step 2:** Navigate to your games folder and select `.nsp` files with the `(UPD)` or `(DLC)` suffix on its filename, then click on `Open`. +> yuzu will now show a checklist of `.nsp` files that you've selected to install. Make sure that the files you want to install are listed there. If you changed your mind, you can just uncheck the item from the list. + +**Step 3:** Click on `Install`. Wait for the installation process to finish. + +Your games should now be up-to-date with their DLCs installed and ready to go. + +> To double check if the installation was successful, you can see the list of installed contents for each game by looking at the **Add-ons** column from the game list. For more details, you can right-click on any game from the game list and then click on `Properties`. + +### Transferring Save Data of a Game to yuzu + +> You can skip this section if you didn't follow the steps from [Dumping Save Files (Optional)](#dumping-save-files-optional). + +**Step 1:** In **yuzu**, right-click on a game from the game list. + +**Step 2:** Select `Open Save Data Location`. It should now open the game's save data folder. + +**Step 3:** Open another file explorer window and navigate to your microSD card drive. + +**Step 4:** Open the `JKSV` folder. +> **NOTE:** You'll see a bunch of folders with the name of your games here. Inside each of these contains another folder corresponding to the user name and the date that it was dumped. Inside that folder are the files (and/or folders) that we need, so copy carefully! + +**Step 5:** Copy the save data file(s) to the save data folder that was opened from yuzu. + +## Rebooting Back to Stock Firmware + +If you're done following the sections you needed for setting up yuzu, we'll now reboot the Switch back to its original firmware. But first, we must safely disconnect the Switch from your computer. + +**Step 1:** Safely eject the microSD card drive. +> If unsure of how to safely eject media, use one of the following support pages corresponding to your OS: +> - **Windows users:** [Safely remove hardware in Windows](https://support.microsoft.com/en-us/windows/safely-remove-hardware-in-windows-1ee6677d-4e6c-4359-efca-fd44b9cec369) + +**Step 2:** Tap on `Close` twice to return to the `Tools` menu. You can now disconnect the USB cable. + +**Step 3:** Tap on the `Home` tab to return to the Hekate Home menu. + +**Step 4:** Tap on `Reboot` and then tap on `OFW`. Your Switch will now reboot to the original firmware. +> You can double check that your Switch is in stock firmware by navigating into **System Settings > System** and checking the `Current version` value. It should only show numbers. + +### If you need any help during this process or get a strange error during or while using yuzu, feel free to ask for help on the [yuzu Discord server.](https://discord.gg/u77vRWY) Happy Emulating! diff --git a/site/content/help/quickstart/payloads_dir.png b/site/content/help/quickstart/payloads_dir.png new file mode 100644 index 0000000..6c5fcfd Binary files /dev/null and b/site/content/help/quickstart/payloads_dir.png differ diff --git a/site/content/help/quickstart/sd_root.png b/site/content/help/quickstart/sd_root.png new file mode 100644 index 0000000..0312742 Binary files /dev/null and b/site/content/help/quickstart/sd_root.png differ diff --git a/site/content/help/quickstart/switch_dir.png b/site/content/help/quickstart/switch_dir.png new file mode 100644 index 0000000..e122d51 Binary files /dev/null and b/site/content/help/quickstart/switch_dir.png differ diff --git a/site/content/help/reference/asking.md b/site/content/help/reference/asking.md new file mode 100644 index 0000000..c6a42ce --- /dev/null +++ b/site/content/help/reference/asking.md @@ -0,0 +1,23 @@ +--- +title: Asking for Help +description: "How to properly ask in our forums or support channel for assistance." +--- + +### Before starting your support request: +* **Read the [Quickstart Guide](https://yuzu-emu.org/help/quickstart/).** Watching a YouTube video tutorial or reading a guide elsewhere doesn't count, as the majority of those provides incorrect instructions and quickly get outdated. +* **Check if the problem is already reported in our [game compatibility list](https://yuzu-emu.org/game/)** Someone may be experiencing the same issue as you, or specific settings may be required for the game you are attempting to play. +* **Reset your config file to defaults** This can resolve many common misconfiguration issues. This can be done by going to Configuration menu, General tab, and selecting "Reset All Settings" +* **Make sure you're using the latest yuzu Mainline build.** We don't provide support for older builds. Make sure you're using the latest Mainline build available, as we always pour new improvements into them. +* **Check if your drivers are up-to-date.** Many issues are simply solved by updating your drivers, mainly GPU. Always make sure your GPU drivers are up-to-date before proceeding. Just using the Windows builtin updater usually is not enough! Always install your GPU drivers through your GPU vendor's website. + * Intel: [Automatically update your drivers](https://downloadcenter.intel.com/product/80939/Graphics-Drivers) + * NVIDIA: [Automatic Driver Updates](https://www.geforce.com/drivers) + * ATI: [Auto-Detect and Install Radeon Graphics Drivers for Windows](https://www.amd.com/en/support) +* **Check if your System matches yuzu's minimum requirements.** Assuming your system runs it because it runs other emulators is not enough. Many people simply ignore this step thinking their system matches the minimum requirements and end up wasting their time trying to get it to work. System Requirements are at the beginning of the Quickstart guide. + +### Submitting your support request: +* Choose a place to ask for support: + * **Discord:** Go to the [**#yuzu-support channel on our Discord Server**](https://discord.gg/u77vRWY) and submit a message describing your issue alongside uploading your log file. Remember to read the #read-me channel for instructions on how to join the server. + * **Forums:** Go to the [**Support section of our forums**](https://community.citra-emu.org/c/yuzu-support) and start a new thread or post in an existing one if it discusses the same problem you're experiencing, attaching or uploading your log file. +* **Don't forget to upload the file containing the log.** +* Include screenshots if you believe they help clarifying your problem. Upload them as attachments to the post or upload them to image sharing websites like [**Imgur**](http://imgur.com/) and link them on your request. +* Provide basic system information. CPU, GPU, OS, RAM and GPU Drivers' version are usually enough. diff --git a/site/content/help/reference/error-codes.md b/site/content/help/reference/error-codes.md new file mode 100644 index 0000000..9650f71 --- /dev/null +++ b/site/content/help/reference/error-codes.md @@ -0,0 +1,89 @@ +--- +title: Error Codes Reference +description: "A list of common error codes and how to resolve them." +--- + +#### To use this list, press Ctrl-F and then type in the error code from yuzu. This should look similar to `XXXX-XXXX` where the Xs represent numbers and letters. + +#### Key Errors +##### Please use the general how-to guide, which includes instructions on dumping the necessary files from your switch to have yuzu derive all of your keys, +##### For all: If you try to run recent games and you haven't done the key derivation process recently, you may need to redump and rerun it as newer games use newer keys only available on newer firmwares. Getting an incorrect key means you might have a bad dump of your switch's files. Try again and if it persists, contact the discord. If you are missing the titlekey or an update won't load, sometimes updates change the titlekey between versions -- either way redump and if that doesn't work contact the discord/devs. +| Error Code | Name | +| ---------- | ---- | +| `0008-000C` | `ErrorMissingProductionKeyFile` | +| `0008-000D` | `ErrorMissingHeaderKey` | +| `0008-000E` | `ErrorIncorrectHeaderKey` | +| `0008-0011` | `ErrorMissingTitlekey` | +| `0008-0012` | `ErrorMissingTitlekek` | +| `0008-0014` | `ErrorMissingKeyAreaKey` | +| `0008-0015` | `ErrorIncorrectKeyAreaKey` | +| `0008-0016` | `ErrorIncorrectTitlekeyOrTitlekek` | +| `0008-0018` | `ErrorNCANotProgram` | + +#### Other Common Errors +| Error Code | Name | +| ---------- | ---- | +| `0008-001C` | `ErrorNullFile` <br> The file your are trying to use is empty and contains no data. This is a sign of a bad copy or corrupt storage device. | +| `0008-001D` | `ErrorMissingNPDM` <br> Ensure that your rom directory has a file called `main.npdm`. This is used to determine key info about how to run the game and is required to run. You may need to redump if you deleted this. | +| `0008-001E` | `Error32BitISA` <br> The game you are trying to run uses the 32-bit ARM architecture, which is not currently supported by yuzu. | +| `0008-0029` | `ErrorNAXInconvertibleToNCA` <br> The NAX file you are trying to run is not a game but in fact a save file. Double check your files. | +| `0008-002A` | `ErrorBadNAXFilePath` <br> You can only execute games that are NAX encrypted if they are left in the original directory structure from the SD card (`registered/<hex digits>.nca/00`). The hex digits contain needed data to decrypt the game properly. | +| `0008-0039` | `ErrorMissingBKTRBaseRomFS` <br> You are trying to run a game update, which isn't possible. To use a game update, instead go to File > Install file to NAND... and select the update from that menu. After it's done, launch the base game and yuzu will apply the update. | + +#### Corruption Errors - All of these errors are indicative of a bad/corrupt dump. If there are no special instructions, try redumping. Should the error persist contact the devs/discord for help. +| Error Code | Name | +| ---------- | ---- | +| `0008-0004` | `ErrorBadNPDMHeader` | +| `0008-0005` | `ErrorBadACIDHeader` | +| `0008-0006` | `ErrorBadACIHeader` | +| `0008-0007` | `ErrorBadFileAccessControl` | +| `0008-0008` | `ErrorBadFileAccessHeader` | +| `0008-0009` | `ErrorBadPFSHeader` | +| `0008-000A` | `ErrorIncorrectPFSFileSize` | +| `0008-0013` | `ErrorInvalidRightsID` | +| `0008-0017` | `ErrorXCIMissingProgramNCA` <br> In some rare cases, this has been known to appear with missing keys. Try rederiving your keys and if that doesn't work contact the devs. | +| `0008-0019` | `ErrorNoExeFS` | +| `0008-001A` | `ErrorBadXCIHeader` | +| `0008-001B` | `ErrorXCIMissingPartition` <br> If you trimmed your XCI, it might have been done improperly. Try avoiding trimming. | +| `0008-001F` | `ErrorNoRomFS` | +| `0008-0020` | `ErrorIncorrectELFFileSize` | +| `0008-0021` | `ErrorLoadingNRO` | +| `0008-0022` | `ErrorNoIcon` | +| `0008-0023` | `ErrorNoControl` | +| `0008-0024` | `ErrorBadNAXHeader` | +| `0008-0025` | `ErrorIncorrectNAXFileSize` | +| `0008-0031` | `ErrorNSPMissingProgramNCA` | +| `0008-0032` | `ErrorBadBKTRHeader` | + +#### Less Common General Errors - You should not expect to see these unless you are doing more than just playing games +| Error Code | Name | +| ---------- | ---- | +| `0008-000F` | `ErrorNCA2` <br> The NCA you are attempting to load is using an older format that is not currently supported. If you would like support to be added, consider filing an issue. | +| `0008-0010` | `ErrorNCA0` <br> The NCA you are attempting to load is using an older format that is not currently supported. If you would like support to be added, consider filing an issue. | + +#### Less Common Key Errors - Below errors should not be obtained if using the normal key derivation process (which is highly encouraged for newcomers), but if you are not using it these errors will make sense to you. +| Error Code | Name | +| ---------- | ---- | +| `0008-002B` | `ErrorMissingSDSeed` | +| `0008-002C` | `ErrorMissingSDKEKSource` | +| `0008-002D` | `ErrorMissingAESKEKGenerationSource` | +| `0008-002E` | `ErrorMissingAESKeyGenerationSource` | +| `0008-002F` | `ErrorMissingSDSaveKeySource` | +| `0008-0030` | `ErrorMissingSDNCAKeySource` | + +#### Internal Errors - Should never be seen ever. Report to the devs immediately. +| Error Code | Name | +| ---------- | ---- | +| `0008-0000` | `Success` | +| `0008-0001` | `ErrorAlreadyLoaded` | +| `0008-0002` | `ErrorNotImplemented` | +| `0008-0003` | `ErrorNotInitialized` | +| `0008-0026` | `ErrorNAXKeyHMACFailed` | +| `0008-0027` | `ErrorNAXValidationHMACFailed` | +| `0008-0028` | `ErrorNAXKeyDerivationFailed` | +| `0008-0033` | `ErrorBKTRSubsectionNotAfterRelocation` | +| `0008-0034` | `ErrorBKTRSubsectionNotAtEnd` | +| `0008-0035` | `ErrorBadRelocationBlock` | +| `0008-0036` | `ErrorBadSubsectionBlock` | +| `0008-0037` | `ErrorBadRelocationBuckets` | +| `0008-0038` | `ErrorBadSubsectionBuckets` | diff --git a/site/content/help/reference/log-files.md b/site/content/help/reference/log-files.md new file mode 100644 index 0000000..c6da10c --- /dev/null +++ b/site/content/help/reference/log-files.md @@ -0,0 +1,29 @@ +--- +title: Getting Log Files +description: "How to properly gather and upload log files from yuzu." +--- + +<article class="message has-text-weight-semibold"> + <div class="message-body"> + <p>Before starting, please make sure that the log filter is set to <span style="color:cyan">*:Info</span> for better analyzation purposes. You can check the current log filter by going to <span style="color:cyan">Emulation -> Configure -> General -> Debug</span>, under the Logging section.</p> + <img src="https://i.imgur.com/9fLfykf.png"></img> + </div> +</article> + +1. Launch the game that exhibits incorrect behaviour. + +2. *(Android only)* Go to `Settings > Share debug logs` and share in the corresponding support/forum channel. + +3. *(Windows/Linux only)* Close out of yuzu once the game crashes, freezes or shows any kind of unwanted behaviour. +<p style="color:cyan"><b>Note: After this step, yuzu needs to remain closed. Do not open the emulator until the rest of the steps are completed.</b></p> + +4. Gathering the log files: + - 4a. *(Windows only)* Navigate to `%appdata%\yuzu\log\`. A file called `yuzu_log.txt` should be present in the directory. + + - 4b. *(Linux only)* In the terminal, type `echo $XDG_DATA_HOME`. This command will print out the user-specific data directory. If nothing gets printed out, that means the directory hasn't been changed and the log is present in `~/.local/share/yuzu/log`. If something has been printed out, however, you should follow that directory instead and manually navigate to `/yuzu/log` there. + +5. *(Optional)* If the log file is larger than 8 MB and you are planning to upload the file to Discord, you'll need to compress the file with a compression tool, such as [**7-Zip**](https://www.7-zip.org/). + +6. Once you have obtained the log file, upload it where you were asked to provide a log file by this guide. (Discord, Community Forums...) + +**You're done!** diff --git a/site/content/privacy.md b/site/content/privacy.md new file mode 100644 index 0000000..7eadf45 --- /dev/null +++ b/site/content/privacy.md @@ -0,0 +1,63 @@ ++++ +title = "Privacy Policy for the yuzu Emulator Project" ++++ + +The yuzu Emulator Project values your privacy and is committed to protecting your personal information. +This Privacy Policy explains how we collect, use, and protect your anonymized telemetry data when you use the yuzu application (the "App"), and how we collect, use, and protect your information when you use the website and forum. + +1. Information We Collect + + When you use the App, we may collect the following types of anonymized telemetry data: + - Technical information, such as your IP address, device type, and operating system version. + - Usage information, such as the actions you take in the App and the dates and times of your visits. + + When you visit our website and forum, we may collect the following types of information: + - Personal Information: This includes your name, email address, and any other information you provide to us when registering for an account, posting on our forum, or contacting us. + - Usage Information: This includes information about how you use our website and forum, such as your IP address, browser type, device type, and operating system. + - Cookies: We may use cookies and similar technologies to collect information about your browsing behavior on our website and forum. Cookies are small files that are stored on your device and can be used to track your activity on our site. + +2. How We Use Your Information + + We use the anonymized telemetry data we collect to: + - Operate and improve the App, website, and forum, including fixing bugs, and adding new features. + - Analyze usage trends and measure the effectiveness of the App, website and forum. + - Comply with legal obligations and enforce our rights and agreements. + +3. How We Share Your Information + + We do not share your anonymized telemetry data from the App with any third-party service providers or government agencies. + + We may share your information from the website and forum with the following third parties: + - Service Providers: We may share your information with third-party service providers who help us operate our website and forum, such as hosting providers, payment processors, and email service providers. + - Law Enforcement: We may disclose your information to law enforcement agencies or other governmental authorities in response to a lawful request for information. + +4. Data Retention + + We will retain your anonymized telemetry data and personal information for as long as necessary to fulfill the purposes outlined in this Privacy Policy, unless a longer retention period is required or permitted by law. + +5. Security + + We take reasonable measures to protect your anonymized telemetry data and personal information from unauthorized access, disclosure, alteration, and destruction. + However, no data transmission over the internet or wireless network can be guaranteed to be 100% secure. + +6. Children's Privacy + + Our website, form and App are not directed to children under the age of 13, and we do not knowingly collect personal information from children under the age of 13. + +7. Your Choices + + You can choose to opt-out of providing anonymized telemetry data to us by disabling telemetry collection in the App's settings. + Please note that disabling telemetry may impact our ability to improve the App and fix bugs. + +8. Changes to this Privacy Policy + + We may update this Privacy Policy from time to time by posting a new version on our website or within the App. + If we make material changes, we will provide notice on our website or within the App. + +9. Contact Us + + If you have any questions or concerns about this Privacy Policy or our data practices, please contact us at yuzu@yuzu-emu.org. + +<br> + +This Privacy Policy is effective as of **May 1st, 2023**. diff --git a/site/content/rules.md b/site/content/rules.md new file mode 100644 index 0000000..d32c162 --- /dev/null +++ b/site/content/rules.md @@ -0,0 +1,36 @@ ++++ +title = "Community Rules" ++++ + +## Warez/downloading games talk is prohibited. + +To prevent legal issues, you may not request or refer to any kind of ROM, NAND, ISO, game, or other copyrighted material that has been illegally obtained or shared. This rule also applies to pre-release leaks. We don't allow discussion / support requests about games until they are officially released. + +If any post like that is found, the thread containing it will be locked and further support revoked. Stating that you've downloaded a ROM or telling others where to download a ROM will get you suspended from the forum immediately, no matter if you purchased the game or not. You must legally dump/rip your own games, NAND, etc. + +## Asking for help + +When asking for support, please always provide the githash - located in the title bar of yuzu's GUI - your full PC specs (CPU, RAM, GPU, Operating System), any relevant settings, and detailed information on what you are attempting to do (such as what game you are trying to run). Ignoring this rule may result in your thread being locked. + +## General posting guidelines + +Flaming/harassment of other members will not be tolerated. We want to keep our forums civil and friendly. If you have an issue with a member that you cannot resolve on your own, please ask a moderator or administrator to help. + +You may not post or display any content (images, text, videos) that is sexually explicit or erotic, i.e. content whose sole purpose is arousal. This forum does not currently have spoiler tags, so any questionable content for artistic use involving nudity or highly offensive/descriptive language must be hosted outside of the forum and showed here only as a link with suitable NFSW warnings. + +No spamming, off-topic posts. We will not tolerate posts that are either irrelevant to a thread's subject or solely for advertising. Also before posting, please assign appropriate tags that fit your thread. Users on the forum are allowed to self-promote if they are involved with the community, but random promotion from unknown accounts is SPAM and will be deleted. + +## How many accounts can I have at one time? +Users may only have one active account at a time. Alternate, duplicate, or multiple active accounts will be suspended from the forums. + +## Can I post in other languages? + +This is an English only forum, please do not post in any other language. If you are not a native English speaker and are using a translator to assist, you may write your post in your own language as long as you provide the text of the automatic translation in the post. + +## Repercussions + +First and foremost, breaking a rule related to piracy will result in an immediate suspension of your account, and likely the deletion of the infringing post. + +The moderation staff will discuss prolonged or permanent suspension beforehand on every case, with the only exceptions being SPAM, or anything imminently harmful such as harassment. + +Short suspensions of under one month are left to the discretion of the staff involved per the situation. diff --git a/site/content/screenshots.md b/site/content/screenshots.md new file mode 100644 index 0000000..fab178c --- /dev/null +++ b/site/content/screenshots.md @@ -0,0 +1,4 @@ ++++ +title = "Screenshots" +type = "screenshots" ++++