mirror of
https://git.ryujinx.app/ryubing/ryujinx.git
synced 2025-09-08 18:04:51 +00:00
Update Setup & Configuration Guide
Daenorth
parent
504afe827c
commit
089e022b6f
@ -1,14 +1,12 @@
|
|||||||
This article assumes you have already **[hacked your Nintendo Switch](https://nh-server.github.io/switch-guide/)** and **dumped your Nintendo Switch keys** (prod.keys) and firmware file(s).
|
This article assumes you have already [**hacked your Nintendo Switch**](https://nh-server.github.io/switch-guide/) and **dumped your Nintendo Switch keys** (prod.keys) and firmware file(s).
|
||||||
|
|
||||||
This guide also illustrates how to use an untrimmed game cartridge dump (XCI file) to install firmware directly to Ryujinx.
|
This guide also illustrates how to use an untrimmed game cartridge dump (XCI file) to install firmware directly to Ryujinx.
|
||||||
|
|
||||||
If you haven't already downloaded Ryujinx, you can get the latest stable version
|
If you haven't already downloaded Ryujinx, you can get the latest stable version from [here](https://update.ryujinx.app/latest) and the latest canary build from [here](https://update.ryujinx.app/latest/canary).\
|
||||||
from [here](https://update.ryujinx.app/latest)
|
|
||||||
and the latest canary build from [here](https://update.ryujinx.app/latest/canary).\
|
|
||||||
Stable allows the end user to get a more **enjoyable and stable experience**.\
|
Stable allows the end user to get a more **enjoyable and stable experience**.\
|
||||||
Canary allow the user to get the latest features quickly, while being more unstable and possibly containing more bugs.
|
Canary allow the user to get the latest features quickly, while being more unstable and possibly containing more bugs.
|
||||||
|
|
||||||
Ryujinx checks for updates automatically at startup. You can disable this feature if you wish in Options > Settings . You may also check for updates manually by navigating to Help > Check for Updates.
|
Ryujinx checks for updates automatically at startup. You can disable this feature if you wish in Options \> Settings . You may also check for updates manually by navigating to Help \> Check for Updates.
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
@ -48,34 +46,21 @@ Ryujinx checks for updates automatically at startup. You can disable this featur
|
|||||||
|
|
||||||
[Launch in Fullscreen](#launch-in-fullscreen)
|
[Launch in Fullscreen](#launch-in-fullscreen)
|
||||||
|
|
||||||
Preface
|
# Preface
|
||||||
=======
|
|
||||||
|
|
||||||
Ryujinx comes pre-optimized by default. If a particular menu option is
|
Ryujinx comes pre-optimized by default. If a particular menu option is not mentioned in this guide, it should be ignored and should not be changed unless directly instructed by Ryujinx staff.
|
||||||
not mentioned in this guide, it should be ignored and should not be
|
|
||||||
changed unless directly instructed by Ryujinx staff.
|
|
||||||
|
|
||||||
***When requesting support on the Ryujinx official Discord server, you
|
**_When requesting support on the Ryujinx official Discord server, you will usually be asked for your log file. With this in mind, Logging should be left at default settings (enabled) for everything except debug logs. Do not enable debug logs unless specifically instructed by Ryujinx staff._**
|
||||||
will usually be asked for your log file. With this in mind, Logging
|
|
||||||
should be left at default settings (enabled) for everything except debug
|
|
||||||
logs. Do not enable debug logs unless specifically instructed by Ryujinx
|
|
||||||
staff.***
|
|
||||||
|
|
||||||
System Requirements
|
# System Requirements
|
||||||
===================
|
|
||||||
|
|
||||||
In order to use *Ryujinx* your computer will need:
|
In order to use _Ryujinx_ your computer will need:
|
||||||
|
|
||||||
- At least 8GB RAM
|
- At least 8GB RAM
|
||||||
|
- A video card/GPU that supports OpenGL 4.5/Vulkan 1.2 or higher
|
||||||
- A video card/GPU that supports OpenGL 4.5/Vulkan 1.2 or higher
|
- Your **prod.keys** and either your **dumped firmware** or game cartridge untrimmed XCI
|
||||||
|
- Your dumped Nintendo Switch games or homebrew
|
||||||
- Your **prod.keys** and either your **dumped firmware** or game
|
- Windows 10.0.17134 or higher / macOS 12 / Any modern linux distribution (see dependencies)
|
||||||
cartridge untrimmed XCI
|
|
||||||
|
|
||||||
- Your dumped Nintendo Switch games or homebrew
|
|
||||||
|
|
||||||
- Windows 10.0.17134 or higher / macOS 12 / Any modern linux distribution (see dependencies)
|
|
||||||
|
|
||||||
A recommended **baseline** system (native resolution and framerate) would look something like:
|
A recommended **baseline** system (native resolution and framerate) would look something like:
|
||||||
|
|
||||||
@ -83,244 +68,179 @@ A recommended **baseline** system (native resolution and framerate) would look s
|
|||||||
- RAM: 16GB DDR4
|
- RAM: 16GB DDR4
|
||||||
- GPU: NVIDIA GTX 1060 6GB
|
- GPU: NVIDIA GTX 1060 6GB
|
||||||
|
|
||||||
Dependencies
|
# Dependencies
|
||||||
============
|
|
||||||
**Windows**
|
**Windows**
|
||||||
- **Windows 10 RS4 (Redstone 4, version 1803) or newer** is required.
|
|
||||||
- Graphics drivers must be up to date. On laptops with 2 different graphics cards, both iGPU and dGPU drivers must be updated.
|
|
||||||
|
|
||||||
**Linux**<br>
|
- **Windows 10 RS4 (Redstone 4, version 1803) or newer** is required.
|
||||||
|
- Graphics drivers must be up to date. On laptops with 2 different graphics cards, both iGPU and dGPU drivers must be updated.
|
||||||
|
|
||||||
|
**Linux**\
|
||||||
copy the command into your terminal emulator of choice and execute it
|
copy the command into your terminal emulator of choice and execute it
|
||||||
- *Archlinux based distros:*<br>
|
|
||||||
`sudo pacman -S sdl2 openal`
|
|
||||||
|
|
||||||
- *Ubuntu based distros:*<br>
|
- _Archlinux based distros:_\
|
||||||
`sudo apt-get install libsdl2-2.0 libsdl2-dev libalut-dev`
|
`sudo pacman -S sdl2 openal`
|
||||||
|
- _Ubuntu based distros:_\
|
||||||
- *Fedora:*<br>
|
`sudo apt-get install libsdl2-2.0 libsdl2-dev libalut-dev`
|
||||||
`sudo dnf install SDL2-devel openal-soft`
|
- _Fedora:_\
|
||||||
|
`sudo dnf install SDL2-devel openal-soft`
|
||||||
|
|
||||||
**MacOS**
|
**MacOS**
|
||||||
|
|
||||||
- macOS 12 Monterey or latest (recommended) installed.
|
- macOS 12 Monterey or latest (recommended) installed.
|
||||||
|
|
||||||
Initial Setup - Placement of prod.keys
|
# Initial Setup - Placement of prod.keys
|
||||||
======================================
|
|
||||||
|
|
||||||
By default Ryujinx will use `%appdata%/Ryujinx` (or the equivalent application data folder on Linux/macOS) to store all of it's permanent files. This includes firmware, save files, shader caches and other configuration. If you wish Ryujinx to be fully self-contained you may use [portable mode!](#portable-mode)
|
By default Ryujinx will use `%appdata%/Ryujinx` (or the equivalent application data folder on Linux/macOS) to store all of it's permanent files. This includes firmware, save files, shader caches and other configuration. If you wish Ryujinx to be fully self-contained you may use [portable mode!](#portable-mode)
|
||||||
|
|
||||||
|
1. Now that you've downloaded the _Ryujinx_ archive, open it and extract the contents of the publish folder onto your drive in the location of your choice. We recommend against using your desktop or the root of any drive as these can sometimes be protected.
|
||||||
|
|
||||||
1. Now that you've downloaded the *Ryujinx* archive, open it and
|
2. Navigate to where you extracted the _Ryujinx_ files, and double-click on _Ryujinx.exe_. This will launch the emulator and you will be met with the following message (don't worry; this is normal!)
|
||||||
extract the contents of the publish folder onto your drive in
|
|
||||||
the location of your choice. We recommend against using your desktop
|
|
||||||
or the root of any drive as these can sometimes be protected.
|
|
||||||
|
|
||||||
|
{width="25%"} {width="25%"}
|
||||||
|
|
||||||
2. Navigate to where you extracted the *Ryujinx* files, and
|
3. Click _Run anyway_ on the warning box. Now that _Ryujinx_ has been launched, the proper folders have been created for you in your %appdata% folder.
|
||||||
double-click on *Ryujinx.exe*. This will launch the emulator and you
|
|
||||||
will be met with the following message (don't worry; this is
|
|
||||||
normal!)
|
|
||||||
|
|
||||||
{width=25%}
|
4. You will be met with a *Ryujinx Error (RYU-0001) just press on the OK as pictured and follow the steps further down.
|
||||||
{width=25%}
|
{width="25%"}
|
||||||
|
|
||||||
3. Click *Run anyway* on the warning box.
|
4. Click _Actions_ at the top left of the _Ryujinx_ window, and then move your mouse to _Install Keys_ then either choose _Install keys from KEYS or ZIP_ or _Install keys from Directory_.\
|
||||||
Now that *Ryujinx* has been launched, the proper folders have been
|
{width="25%"}
|
||||||
created for you in your %appdata% folder.
|
|
||||||
|
|
||||||
4. Click *Actions* at the top left of the *Ryujinx* window, and then move your mouse to
|
5. Navigate to the folder where you have your keys and select it.
|
||||||
*Install Keys* then either choose *Install keys from KEYS or ZIP* or *Install keys from Directory*.\
|
|
||||||
{width=25%}
|
|
||||||
|
|
||||||
|
6. Close and reopen _Ryujinx_ so that the prod.keys file is validated.
|
||||||
5. Navigate to the folder where you have your keys and select it.
|
|
||||||
|
|
||||||
6. Close and reopen *Ryujinx* so that the prod.keys file is validated.
|
|
||||||
|
|
||||||
You're done installing keys!
|
You're done installing keys!
|
||||||
|
|
||||||
Initial Setup Continued - Installation of Firmware
|
# Initial Setup Continued - Installation of Firmware
|
||||||
==================================================
|
|
||||||
|
|
||||||
Now that your keys are installed, it's time to install a firmware. Make
|
Now that your keys are installed, it's time to install a firmware. Make sure you have an untrimmed XCI file of a recent game cartridge you dumped, or have compiled your dumped firmware into a ZIP file.
|
||||||
sure you have an untrimmed XCI file of a recent game cartridge you
|
|
||||||
dumped, or have compiled your dumped firmware into a ZIP file.
|
|
||||||
|
|
||||||
1. Open *Ryujinx*. There should be no warning about missing prod.keys anymore; if
|
1. Open _Ryujinx_. There should be no warning about missing prod.keys anymore; if you still get the warning, go back through the prod.keys steps and ensure you have placed the file correctly.
|
||||||
you still get the warning, go back through the prod.keys steps and
|
2. Now that _Ryujinx_ is open, click _Tools \> Install Firmware \> Install from XCI/ZIP_\
|
||||||
ensure you have placed the file correctly.
|
|
||||||
|
3. This will bring up your OS's File Explorer, navigate to the location of your dumped XCI file and click _Open_. You will be asked to confirm whether you want to install the firmware. Make sure your prod.keys are at least as new as the firmware you are installing!\
|
||||||
|
(Your firmware version number may vary)\
|
||||||
|
|
||||||
|
4. Click _Yes_. You will see a message that the firmware is installing and was successfully installed:\
|
||||||
|
|
||||||
|
5. Click _OK_. If all went well, you will now see your firmware version listed as the "System Version" in the bottom right hand corner of the main _Ryujinx_ window.\
|
||||||
|
|
||||||
|
|
||||||
2. Now that *Ryujinx* is open, click *Tools \> Install Firmware \> Install from
|
# Adding Your Games to Ryujinx
|
||||||
XCI/ZIP*\
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
3. This will bring up your OS's File Explorer, navigate to the location of your dumped
|
|
||||||
XCI file and click *Open*. You will be asked to confirm whether you
|
|
||||||
want to install the firmware. Make sure your prod.keys are at least
|
|
||||||
as new as the firmware you are installing!\
|
|
||||||
(Your firmware version number may vary)\
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
4. Click *Yes*. You will see a message that the firmware is
|
|
||||||
installing and was successfully installed:\
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
5. Click *OK*. If all went well, you will now see your firmware version
|
|
||||||
listed as the "System Version" in the bottom right hand corner of
|
|
||||||
the main *Ryujinx* window.\
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Adding Your Games to Ryujinx
|
|
||||||
============================
|
|
||||||
|
|
||||||
You have keys and firmware ready to go. Time to add your games!
|
You have keys and firmware ready to go. Time to add your games!
|
||||||
|
|
||||||
With *Ryujinx* open, click on *Options \> Settings*. This takes you
|
With _Ryujinx_ open, click on _Options \> Settings_. This takes you straight to the _User Interface_ tab.\
|
||||||
straight to the *User Interface* tab.\
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
There are two different methods in which you can add a Game Directory in this window.\
|
There are two different methods in which you can add a Game Directory in this window.\
|
||||||
\
|
\
|
||||||
**1st Method:**\
|
**1st Method:**\
|
||||||
Type the absolute path of the folder containing your games into the path
|
Type the absolute path of the folder containing your games into the path field and click _Add_.\
|
||||||
field and click *Add*.\
|
|
||||||
|
|
||||||
|
|
||||||
\
|
\
|
||||||
**2nd Method:**\
|
**2nd Method:**\
|
||||||
Without typing anything into the path field, click *Add*.\
|
Without typing anything into the path field, click _Add_.\
|
||||||
|
|
||||||
|
|
||||||
\
|
\
|
||||||
This brings up your OS's navigation window. Navigate to the folder containing
|
This brings up your OS's navigation window. Navigate to the folder containing your games (e.g. D:\\Switch Games) and click _Add_.\
|
||||||
your games (e.g. D:\\Switch Games) and click *Add*.\
|
|
||||||
|
|
||||||
|
|
||||||
|
1. Whichever method you chose, **click _Save_** to save the game directory setting.
|
||||||
|
2. Your games will now show up in the main _Ryujinx_ window.\
|
||||||
|
|
||||||
|
|
||||||
1. Whichever method you chose, **click *Save*** to save the game
|
# Managing Game Updates
|
||||||
directory setting.
|
|
||||||
|
|
||||||
2. Your games will now show up in the main *Ryujinx* window.\
|
|
||||||
|
|
||||||
|
|
||||||
Managing Game Updates
|
|
||||||
=====================
|
|
||||||
|
|
||||||
Manage game update versions from within Ryujinx
|
Manage game update versions from within Ryujinx
|
||||||
|
|
||||||
Now that your games are added, you may wish to update your game for
|
Now that your games are added, you may wish to update your game for various reasons e.g. bugfixes, new content, etc. _Ryujinx_ has built-in functionality to manage which version of the game you want to play.
|
||||||
various reasons e.g. bugfixes, new content, etc. *Ryujinx* has built-in
|
|
||||||
functionality to manage which version of the game you want to play.
|
|
||||||
|
|
||||||
## Autoadd Game Updates
|
## Autoadd Game Updates
|
||||||
|
|
||||||
Since version 1.2.0, *Ryujinx* supports automatically adding and assigning game updates.
|
Since version 1.2.0, _Ryujinx_ supports automatically adding and assigning game updates.
|
||||||
|
|
||||||
1. Go to **Options > Settings**\
|
1. Go to **Options \> Settings**\
|
||||||
|
|
||||||
|
2. Scroll down until you see **"Autoadd DLC/Game Updates"**.\
|
||||||
2. Scroll down until you see **"Autoadd DLC/Game Updates"**.\
|
|
||||||
|
|
||||||
|
|
||||||
From there, simply add the directories where your Game Updates are located by following Method 1 or Method 2 from [Adding Your Games to Ryujinx](#adding-your-games-to-ryujinx).
|
From there, simply add the directories where your Game Updates are located by following Method 1 or Method 2 from [Adding Your Games to Ryujinx](#adding-your-games-to-ryujinx).
|
||||||
|
|
||||||
If you add multiple updates in one go with this method, *Ryujinx* will automatically choose the highest version.
|
If you add multiple updates in one go with this method, _Ryujinx_ will automatically choose the highest version.
|
||||||
|
|
||||||
## Managing Game Updates
|
## Managing Game Updates
|
||||||
|
|
||||||
1. In the main *Ryujinx* game list, right-click the game you want to manage Game Updates for.
|
1. In the main _Ryujinx_ game list, right-click the game you want to manage Game Updates for. Then click **Manage Title Updates**.\
|
||||||
Then click **Manage Title Updates**.\
|
\
|
||||||
\
|
\
|
||||||
\
|
After clicking _Manage Title Updates_, you will see the _Ryujinx - Title Update Manager_ menu.
|
||||||
After clicking *Manage Title Updates*, you will see the *Ryujinx -
|
|
||||||
Title Update Manager* menu.
|
|
||||||
|
|
||||||
If you want to add a game update file, go to step 2.
|
If you want to add a game update file, go to step 2.
|
||||||
|
|
||||||
If you **do not** want to add a game update file, go to step 4.
|
If you **do not** want to add a game update file, go to step 4.
|
||||||
|
|
||||||
2. Click **Add**\
|
2. Click **Add**\
|
||||||
|
|
||||||
|
3. This will bring up your OS's File Explorer. From there, navigate to the location of your game's update files, select which one you want to Add and click on **Open**.\
|
||||||
|
\
|
||||||
|
You may repeat this for any other game update files you want to add.
|
||||||
|
4. Select the version of the update you want to be applied by clicking on it and click **Save**.\
|
||||||
|
|
||||||
|
|
||||||
3. This will bring up your OS's File Explorer.
|
Your game update should now be applied, you may repeat the process for any other games you wish to apply updates to.
|
||||||
From there, navigate to the location of your game's update files,
|
|
||||||
select which one you want to Add and click on **Open**.\
|
|
||||||
\
|
|
||||||
You may repeat this for any other game update files you want to add.
|
|
||||||
|
|
||||||
4. Select the version of the update you want to
|
# Managing DLC
|
||||||
be applied by clicking on it and click **Save**.\
|
|
||||||
|
|
||||||
|
|
||||||
Your game update should now be applied,
|
|
||||||
you may repeat the process for any other
|
|
||||||
games you wish to apply updates to.
|
|
||||||
|
|
||||||
Managing DLC
|
|
||||||
============
|
|
||||||
|
|
||||||
Manage Downloadable Content for your games
|
Manage Downloadable Content for your games
|
||||||
|
|
||||||
Now that your games and game updates are added,
|
Now that your games and game updates are added, you may wish to add DLC to your game. _Ryujinx_ has built-in functionality to manage your DLC.
|
||||||
you may wish to add DLC to your game.
|
|
||||||
*Ryujinx* has built-in functionality to manage your DLC.
|
|
||||||
|
|
||||||
## Autoadd DLC
|
## Autoadd DLC
|
||||||
|
|
||||||
Since 1.2.0, *Ryujinx* supports automatically adding and assigning DLC.
|
Since 1.2.0, _Ryujinx_ supports automatically adding and assigning DLC.
|
||||||
|
|
||||||
1. Go to **Options > Settings**\
|
1. Go to **Options \> Settings**\
|
||||||
|
|
||||||
|
2. Scroll down until you see **"Autoadd DLC/Game Updates"**.\
|
||||||
|
|
||||||
|
|
||||||
2. Scroll down until you see **"Autoadd DLC/Game Updates"**.\
|
From there, simply add the directories where your Game Updates are located by following Method 1 or Method 2 from [Adding Your Games to Ryujinx](#adding-your-games-to-ryujinx).
|
||||||
|
|
||||||
|
|
||||||
From there, simply add the directories where your Game Updates
|
If you add multiple DLCs in one go with this method, _Ryujinx_ will automatically enable every DLC for each game.
|
||||||
are located by following Method 1 or Method 2 from
|
|
||||||
[Adding Your Games to Ryujinx](#adding-your-games-to-ryujinx).
|
|
||||||
|
|
||||||
If you add multiple DLCs in one go with this method,
|
|
||||||
*Ryujinx* will automatically enable every DLC for each game.
|
|
||||||
|
|
||||||
## Managing DLC
|
## Managing DLC
|
||||||
|
|
||||||
Managing Downloadable Content includes,
|
Managing Downloadable Content includes, removing, adding and selecting which DLC you want.
|
||||||
removing, adding and selecting which DLC you want.
|
|
||||||
|
|
||||||
1. In the main *Ryujinx* game list,
|
1. In the main _Ryujinx_ game list, right-click the game you want to manage Game Updates for. Then click **Manage DLC**.\
|
||||||
right-click the game you want to manage
|
|
||||||
Game Updates for. Then click **Manage DLC**.\
|
|
||||||
|
|
||||||
|
|
||||||
If you want to add a game update file, go to step 2.
|
If you want to add a game update file, go to step 2.
|
||||||
|
|
||||||
If you **do not** want to add a game update file, go to step 4.
|
If you **do not** want to add a game update file, go to step 4.
|
||||||
|
|
||||||
2. Click **Add**\
|
2. Click **Add**\
|
||||||
|
|
||||||
|
3. This will bring up your OS's File Explorer. From there, navigate to the location of your DLC files, select which ones you want to Add and click on **Open**.\
|
||||||
|
\
|
||||||
3. This will bring up your OS's File Explorer.
|
You may repeat this for any other DLC files you want to add.
|
||||||
From there, navigate to the location of your DLC files,
|
4. Select which DLC you want to be applied by clicking on it and click **Save**.\
|
||||||
select which ones you want to Add and click on **Open**.\
|
\
|
||||||
\
|
Repeat this process, if you wish, for any other games you would like to manage DLC for.
|
||||||
You may repeat this for any other DLC files you want to add.
|
|
||||||
|
|
||||||
4. Select which DLC you want to be applied by clicking on it and click **Save**.\
|
|
||||||
\
|
|
||||||
Repeat this process, if you wish, for any other games you would like to manage DLC for.
|
|
||||||
|
|
||||||
Your DLC should now be applied and enabled automatically.
|
Your DLC should now be applied and enabled automatically.
|
||||||
|
|
||||||
Managing Mods
|
# Managing Mods
|
||||||
============
|
|
||||||
Quick Start Guide for managing mods
|
Quick Start Guide for managing mods
|
||||||
|
|
||||||
Various game mods are available from enthusiasts & content creators online. *Ryujinx* supports the following types of mods:
|
Various game mods are available from enthusiasts & content creators online. _Ryujinx_ supports the following types of mods:
|
||||||
|
|
||||||
1. ExeFS Partition Replacement
|
1. ExeFS Partition Replacement
|
||||||
2. ExeFS File Replacement
|
2. ExeFS File Replacement
|
||||||
3. ExeFS Patching
|
3. ExeFS Patching
|
||||||
@ -329,58 +249,37 @@ Various game mods are available from enthusiasts & content creators online. *Ryu
|
|||||||
|
|
||||||
## Using the Mod Manager
|
## Using the Mod Manager
|
||||||
|
|
||||||
*Ryujinx* has a built-in **Mod Manager** that can
|
_Ryujinx_ has a built-in **Mod Manager** that can very easily be used to enable, disable, add and remove mods.
|
||||||
very easily be used to enable, disable, add and remove mods.
|
|
||||||
|
|
||||||
1. Right-click on the game you want to
|
|
||||||
add a mod for, from there click on **Manage Mods**.\
|
|
||||||
|
|
||||||
|
|
||||||
2. The **Mod Manager** window will pop-up,
|
|
||||||
this is where you can add, remove, enable and
|
|
||||||
disable your mods for the game of your choice.\
|
|
||||||
|
|
||||||
|
|
||||||
3. To add Mods, simply click the **Add** button.\
|
|
||||||
|
|
||||||
|
|
||||||
4. This will bring up your OS's File explorer.
|
|
||||||
From there select the **unzipped** folder
|
|
||||||
containing all the files for the mod you want to add.\
|
|
||||||
|
|
||||||
Your mods should now be installed and already enabled by default.\
|
|
||||||
|
|
||||||
|
|
||||||
|
1. Right-click on the game you want to add a mod for, from there click on **Manage Mods**.\
|
||||||
|
|
||||||
|
2. The **Mod Manager** window will pop-up, this is where you can add, remove, enable and disable your mods for the game of your choice.\
|
||||||
|
|
||||||
|
3. To add Mods, simply click the **Add** button.\
|
||||||
|
|
||||||
|
4. This will bring up your OS's File explorer. From there select the **unzipped** folder containing all the files for the mod you want to add.\
|
||||||
|
 Your mods should now be installed and already enabled by default.\
|
||||||
|
|
||||||
5. Click **Save** to exit and save your mods.\
|
5. Click **Save** to exit and save your mods.\
|
||||||
|
|
||||||
|
|
||||||
## Manually Adding Mods (NOT RECOMMENDED)
|
## Manually Adding Mods (NOT RECOMMENDED)
|
||||||
|
|
||||||
**This is only recommended for experienced users who know what they are doing.**
|
**This is only recommended for experienced users who know what they are doing.**
|
||||||
|
|
||||||
1. Right-click on the game you wish to add mods for and click **Open Mods Directory**.\
|
1. Right-click on the game you wish to add mods for and click **Open Mods Directory**.\
|
||||||
\
|
\
|
||||||
This will open the `AppData\Roaming\Ryujinx\mods\contents\<game ID>\` folder.
|
This will open the `AppData\Roaming\Ryujinx\mods\contents\<game ID>\` folder.
|
||||||
|
2. Create a subfolder with a name that fits the mod you'll be using. Then, place the ExeFS and RomFS of the mod inside that folder.\
|
||||||
|
|
||||||
|
|
||||||
2. Create a subfolder with a name that fits
|
You can also place mods in `C:\Users\[redacted]\AppData\Roaming\Ryujinx\sdcard\atmosphere` if the mod was packaged for real hardware (usually indicated with an "atmosphere" folder as the top directory).
|
||||||
the mod you'll be using. Then, place the ExeFS
|
|
||||||
and RomFS of the mod inside that folder.\
|
|
||||||
|
|
||||||
|
|
||||||
You can also place mods in
|
Right-click the game you wish to add an atmosphere mod to and click on **Open Atmosphere Mods Directory**. This will open `AppData\Roaming\Ryujinx\sdcard\atmosphere\contents\<game ID>` where you can then place the RomFS and ExeFS of the mod you wish to add.\
|
||||||
`C:\Users\[redacted]\AppData\Roaming\Ryujinx\sdcard\atmosphere`
|
|
||||||
if the mod was packaged for real hardware
|
|
||||||
(usually indicated with an "atmosphere" folder as the top directory).
|
|
||||||
|
|
||||||
Right-click the game you wish to add an atmosphere mod
|
|
||||||
to and click on **Open Atmosphere Mods Directory**.
|
|
||||||
This will open `AppData\Roaming\Ryujinx\sdcard\atmosphere\contents\<game ID>`
|
|
||||||
where you can then place the RomFS and ExeFS of the mod you wish to add.\
|
|
||||||
\
|
\
|
||||||
|
|
||||||
|
|
||||||
Managing Cheats
|
# Managing Cheats
|
||||||
===============
|
|
||||||
|
|
||||||
Ryujinx fully supports Atmosphere style cheats (except game pausing/resume): [Atmosphere's cheats docs](https://github.com/Atmosphere-NX/Atmosphere/blob/master/docs/features/cheats.md)
|
Ryujinx fully supports Atmosphere style cheats (except game pausing/resume): [Atmosphere's cheats docs](https://github.com/Atmosphere-NX/Atmosphere/blob/master/docs/features/cheats.md)
|
||||||
|
|
||||||
@ -400,18 +299,12 @@ Where `0123456789ABCDEF` will vary according to the game and the cheat (this is
|
|||||||
|
|
||||||
To install the cheat:
|
To install the cheat:
|
||||||
|
|
||||||
1. Open Ryujinx, right-click the game you wish to
|
1. Open Ryujinx, right-click the game you wish to install the cheat and select to open its `Mod directory`.\
|
||||||
install the cheat and select to open its `Mod directory`.\
|
|
||||||
|
2. A directory like this will open: `Ryujinx\mods\contents\XXXXXXXXXXXXXXXX\`, `XXXXXXXXXXXXXXXX` will be the id of the chosen game.\
|
||||||
|
|
||||||
2. A directory like this will open: `Ryujinx\mods\contents\XXXXXXXXXXXXXXXX\`,
|
3. Extract the cheat archive to the mod directory, keeping the cheat name: `Ryujinx\mods\contents\XXXXXXXXXXXXXXXX\Cheat_Name\cheats\<all the txt files>`. The following image may be a bit confusing to look at, but take your time it's actually quite easy to understand.\
|
||||||
`XXXXXXXXXXXXXXXX` will be the id of the chosen game.\
|
|
||||||
|
|
||||||
|
|
||||||
3. Extract the cheat archive to the mod directory, keeping the cheat name: `Ryujinx\mods\contents\XXXXXXXXXXXXXXXX\Cheat_Name\cheats\<all the txt files>`.
|
|
||||||
The following image may be a bit confusing to look at,
|
|
||||||
but take your time it's actually quite easy to understand.\
|
|
||||||
|
|
||||||
|
|
||||||
## Activating/Deactivating cheats
|
## Activating/Deactivating cheats
|
||||||
|
|
||||||
@ -420,183 +313,139 @@ In Ryujinx, cheats are all automatically disabled, so you need to enable them in
|
|||||||
To do so, start by right-clicking a game and clicking on **"Manage Cheats"**\
|
To do so, start by right-clicking a game and clicking on **"Manage Cheats"**\
|
||||||
|
|
||||||
|
|
||||||
This will bring up Ryujinx's *Cheat Manager*, from where you can enable/disable cheats by checking the box next to their name.\
|
This will bring up Ryujinx's _Cheat Manager_, from where you can enable/disable cheats by checking the box next to their name.\
|
||||||
\
|
\
|
||||||
Next, click **Save** to save which cheats you enabled/disabled.
|
Next, click **Save** to save which cheats you enabled/disabled.
|
||||||
|
|
||||||
Managing User Profiles
|
# Managing User Profiles
|
||||||
=====================
|
|
||||||
|
|
||||||
Ryujinx offers the ability to use multiple, customizable user profiles. **WARNING:** Save data is specific to each user profile so if you delete a profile, the save data under that profile is also deleted.
|
Ryujinx offers the ability to use multiple, customizable user profiles. **WARNING:** Save data is specific to each user profile so if you delete a profile, the save data under that profile is also deleted.
|
||||||
|
|
||||||
### To edit a user profile:
|
### To edit a user profile:
|
||||||
1. With Ryujinx open, but no game running, click on Options > Manage User Profiles\
|
|
||||||
|
1. With Ryujinx open, but no game running, click on Options \> Manage User Profiles\
|
||||||
|
|
||||||
|
|
||||||
Now in the Manage User Profiles window, you will see the default RyuPlayer profile. This is the default profile that comes with Ryujinx and **cannot be deleted** as it contains all of the original save data for your games. You may, however, rename it and change the picture to something else, if you like.\
|
Now in the Manage User Profiles window, you will see the default RyuPlayer profile. This is the default profile that comes with Ryujinx and **cannot be deleted** as it contains all of the original save data for your games. You may, however, rename it and change the picture to something else, if you like.\
|
||||||
|
|
||||||
|
|
||||||
2. To rename a profile, hover over the profile and click the editing icon.\
|
2. To rename a profile, hover over the profile and click the editing icon.\
|
||||||
\
|
\
|
||||||
You can then edit the name of the profile.\
|
You can then edit the name of the profile.\
|
||||||
|
|
||||||
|
|
||||||
3. To change the profile image, hover over the profile and click the editing icon.\
|
3. To change the profile image, hover over the profile and click the editing icon.\
|
||||||
\
|
\
|
||||||
Then, click on "Change Profile Image".\
|
Then, click on "Change Profile Image".\
|
||||||
\
|
\
|
||||||
You will then be prompted to select from either a custom image, or from one of the many avatars provided in the firmware.\
|
You will then be prompted to select from either a custom image, or from one of the many avatars provided in the firmware.\
|
||||||
|
|
||||||
|
|
||||||
If you choose to import an image: supported formats are `png`, `bmp`, and `jpg`. You can use the image you want, but it will be resized to 256x256 pixels, so using a square image is recommended.
|
If you choose to import an image: supported formats are `png`, `bmp`, and `jpg`. You can use the image you want, but it will be resized to 256x256 pixels, so using a square image is recommended.
|
||||||
|
|
||||||
If you choose to use a built-in firmware avatar, click on **Select Firmware Avatar**
|
If you choose to use a built-in firmware avatar, click on **Select Firmware Avatar**
|
||||||
|
|
||||||
In the Manage Accounts - Avatar window, select the avatar you want, and choose a background color. When finished, click **Choose** to make it the profile's image.
|
In the Manage Accounts - Avatar window, select the avatar you want, and choose a background color. When finished, click **Choose** to make it the profile's image. 
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### To add a new profile:
|
### To add a new profile:
|
||||||
|
|
||||||
1. With Ryujinx open, but no game running, click on Options > Manage User Profiles
|
1. With Ryujinx open, but no game running, click on Options \> Manage User Profiles\
|
||||||
|
|
||||||
|
|
||||||
2. Click on the Plus sign next to the already existing Profile.\
|
2. Click on the Plus sign next to the already existing Profile.\
|
||||||
|
|
||||||
|
|
||||||
3. A window will pop up asking you to name the new Profile. Enter the desired name of the new profile, and click OK.
|
3. A window will pop up asking you to name the new Profile. Enter the desired name of the new profile, and click OK.
|
||||||
|
|
||||||
To set a profile picture, just click on Set Profile Image and follow Step 3 from the user profile editing instructions above.
|
To set a profile picture, just click on Set Profile Image and follow Step 3 from the user profile editing instructions above.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Input Configuration
|
# Input Configuration
|
||||||
===================
|
|
||||||
|
|
||||||
Setting up your controls: this part requires close attention, so read
|
Setting up your controls: this part requires close attention, so read carefully!
|
||||||
carefully!
|
|
||||||
|
|
||||||
1. Plug in the controller(s) that you will be using.
|
1. Plug in the controller(s) that you will be using.
|
||||||
|
2. Open _Ryujinx_ and navigate to _Options \> Settings_\
|
||||||
|
|
||||||
|
3. You will now see the _Ryujinx - Settings_ window. Click on the _Input_ tab.\
|
||||||
|
|
||||||
|
|
||||||
2. Open *Ryujinx* and navigate to *Options \> Settings*\
|
Before proceeding to configure anything, the options on the Input page need some explanation:
|
||||||
|
|
||||||
|
|
||||||
3. You will now see the *Ryujinx - Settings* window. Click on the
|
Enable Docked Mode: checking this box emulates the Nintendo Switch being docked. Docked Mode enables higher resolution, higher FPS, and better graphical fidelity on games that support these features. **If you check this box, you will need to click configure under Player 1.** **If you leave this box unchecked, you will need to click configure under Handheld.**
|
||||||
*Input* tab.\
|
|
||||||
|
|
||||||
|
|
||||||
Before proceeding to configure anything, the options on the Input page
|
Direct Keyboard Access: checking this box emulates a real, physical keyboard being directly connected to a Nintendo Switch via USB. **Do not check this box unless you have a specific reason.**
|
||||||
need some explanation:
|
|
||||||
|
|
||||||
Enable Docked Mode: checking this box emulates the Nintendo Switch being docked.
|
Direct Mouse Access: checking this box emulates a real, physical mouse being directly connected to a Nintendo Switch via USB. **Do not check this box unless you have a specific reason.**\
|
||||||
Docked Mode enables higher resolution, higher FPS, and better graphical fidelity on games that support these features.
|
|
||||||
**If you check this box, you will need to click configure under Player 1.**
|
|
||||||
**If you leave this box unchecked, you will need to click configure under Handheld.**
|
|
||||||
|
|
||||||
Direct Keyboard Access: checking this box emulates a real,
|
|
||||||
physical keyboard being directly connected to a Nintendo Switch via USB.
|
|
||||||
**Do not check this box unless you have a specific reason.**
|
|
||||||
|
|
||||||
Direct Mouse Access: checking this box emulates a real,
|
|
||||||
physical mouse being directly connected to a Nintendo Switch via USB.
|
|
||||||
**Do not check this box unless you have a specific reason.**\
|
|
||||||
|
|
||||||
|
|
||||||
4. If you have checked Docked Mode, select Player 1 under the "Player" Dropdown.
|
4. If you have checked Docked Mode, select Player 1 under the "Player" Dropdown. If you have unchecked Docked Mode, select Handheld under the "Player" Dropdown.\
|
||||||
If you have unchecked Docked Mode, select Handheld under the "Player" Dropdown.\
|
|
||||||
|
5. Click on the Input Device dropdown and choose the controller you want. If you have connected multiple controllers, choose the one you want to be configured to be P1 in game. **If you do not see any Xinput controllers in the list, you will need to use an Xinput wrapper/translator such as** [x360ce](https://www.x360ce.com/).\
|
||||||
|
|
||||||
|
6. After selecting your controller you should now see a full mapping UI.\
|
||||||
|
|
||||||
|
|
||||||
5. Click on the Input Device dropdown and choose the controller you want.
|
You may continue tweaking the settings to your liking, or binding each button from scratch if you want a fully custom button layout.\
|
||||||
If you have connected multiple controllers,
|
**NOTE: while the default _Deadzones_ are 0.10, we recommend increasing your _Deadzones_ to at least 0.20 in order to avoid unwanted joystick drift.**
|
||||||
choose the one you want to be configured to be P1 in game.
|
|
||||||
**If you do not see any Xinput controllers in the list,
|
|
||||||
you will need to use an Xinput wrapper/translator such as** [x360ce](https://www.x360ce.com/).\
|
|
||||||
|
|
||||||
|
|
||||||
6. After selecting your controller you should now see a full mapping UI.\
|
If you are in _Docked Mode_ and have additional controllers to configure, configure them now under Player 2, Player 3, and so on.
|
||||||
|
|
||||||
|
|
||||||
|
7. **_Click Apply and then OK to save your configuration._**
|
||||||
|
|
||||||
You may continue tweaking the settings to your liking, or binding
|
# Motion Controls
|
||||||
each button from scratch if you want a fully custom button layout.\
|
|
||||||
**NOTE: while the default *Deadzones* are 0.10, we recommend
|
|
||||||
increasing your *Deadzones* to at least 0.20 in order to avoid
|
|
||||||
unwanted joystick drift.**
|
|
||||||
|
|
||||||
If you are in *Docked Mode* and have additional controllers to
|
|
||||||
configure, configure them now under Player 2, Player 3, and so on.
|
|
||||||
|
|
||||||
7. ***Click Apply and then OK to save your configuration.***
|
|
||||||
|
|
||||||
Motion Controls
|
|
||||||
===============
|
|
||||||
### Motion Controls
|
### Motion Controls
|
||||||
|
|
||||||
Ryujinx offers the ability to **natively** use motion controls with
|
Ryujinx offers the ability to **natively** use motion controls with motion-enabled controllers such as a Switch Pro Controller, DS4, DS5, DSE and others.
|
||||||
motion-enabled controllers such as a Switch Pro Controller, DS4, DS5, DSE and others.
|
|
||||||
|
|
||||||
## Native motion controls
|
## Native motion controls
|
||||||
|
|
||||||
Native motion controls should already be enabled and working by default.
|
Native motion controls should already be enabled and working by default. If you want to change the sensitivity and deadzone, you can do so in the **Settings**.\
|
||||||
If you want to change the sensitivity and deadzone, you can do so in the **Settings**.\
|
|
||||||
|
|
||||||
|
|
||||||
Then, go to the **Input** tab, make sure the box next to **"Motion"** is checked and click **Configure**.\
|
Then, go to the **Input** tab, make sure the box next to **"Motion"** is checked and click **Configure**.\
|
||||||
|
|
||||||
|
|
||||||
You will now see the *Motion Controls Settings*.
|
You will now see the _Motion Controls Settings_. From here, feel free to modify the sensitivity and deadzone. **Since you are natively using motion, you do not need to touch any cemuhook related settings.**\
|
||||||
From here, feel free to modify the sensitivity and deadzone.
|
|
||||||
**Since you are natively using motion, you do not need to touch any cemuhook related settings.**\
|
|
||||||
\
|
\
|
||||||
Make sure to click on **Save** to save your configuration.
|
Make sure to click on **Save** to save your configuration.
|
||||||
|
|
||||||
## Cemuhook motion controls
|
## Cemuhook motion controls
|
||||||
|
|
||||||
Since Ryujinx uses SDL2 as it's input wrapper,
|
Since Ryujinx uses SDL2 as it's input wrapper, it means that not all controllers are supported, and that not all the features of a controller are supported. Meaning that sometimes, a controller that has motion controls may not be **natively** supported by Ryujinx.
|
||||||
it means that not all controllers are supported,
|
|
||||||
and that not all the features of a controller are supported.
|
|
||||||
Meaning that sometimes, a controller that has motion controls may not be **natively** supported by Ryujinx.
|
|
||||||
|
|
||||||
Cemuhook is also needed to use a joycon pair, since it can group 2 controllers under 1.
|
Cemuhook is also needed to use a joycon pair, since it can group 2 controllers under 1.
|
||||||
|
|
||||||
To fix this, we can use cemuhook:
|
To fix this, we can use cemuhook:
|
||||||
|
|
||||||
1. Launch & configure your favorite cemuhook server application (Betterjoy, DS4Windows,etc.) with your Bluetooth or wired motion-capable controller. Leave the application running.
|
1. Launch & configure your favorite cemuhook server application (Betterjoy, DS4Windows,etc.) with your Bluetooth or wired motion-capable controller. Leave the application running.
|
||||||
|
2. In Ryujinx, navigate to **Options \> Settings \> Input** tab and select which controller you are configuring. **Remember: if you are in docked mode, configure Player 1. If you are in Handheld mode, configure the Handheld controller.**\
|
||||||
2. In Ryujinx, navigate to **Options > Settings > Input** tab and select which controller you are configuring. **Remember: if you are in docked mode, configure Player 1. If you are in Handheld mode, configure the Handheld controller.**\
|
|
||||||
|
|
||||||
|
|
||||||
3. Select your motion controller from the dropdown. It will be listed as **"Xinput controller"**, **"Xbox 360 Controller"** or **"Xbox One Controller"**.\
|
3. Select your motion controller from the dropdown. It will be listed as **"Xinput controller"**, **"Xbox 360 Controller"** or **"Xbox One Controller"**.\
|
||||||
|
|
||||||
|
4. Next up, make sure **Motion** is activated, and click **Configure** to bring up the _Motion Controls Settings_.\
|
||||||
|
|
||||||
4. Next up, make sure **Motion** is activated, and click **Configure** to bring up the *Motion Controls Settings*.\
|
5. Once here, check the box named **Use CemuHook compatible motion**, then enter the IP and Port that your cemuhook application uses (usually 127.0.0.1 and 26760).\
|
||||||
|
\
|
||||||
|
If you set your controller type to Joycon Pair, an option called "Mirror Input" becomes available. This is useful for games in which both Joycons are connected to a Joycon grip and are moving together. If you enable this checkbox, the first Joycon's motion will be used for both Joycons.
|
||||||
5. Once here, check the box named **Use CemuHook compatible motion**, then enter the IP and Port that your cemuhook application uses (usually 127.0.0.1 and 26760).\
|
6. Click **Save** to save your configurations.
|
||||||
\
|
|
||||||
If you set your controller type to Joycon Pair, an option called "Mirror Input" becomes available. This is useful for games in which both Joycons are connected to a Joycon grip and are moving together. If you enable this checkbox, the first Joycon's motion will be used for both Joycons.
|
|
||||||
|
|
||||||
6. Click **Save** to save your configurations.
|
|
||||||
|
|
||||||
Repeat steps 2 through 5 for any other motion controllers you wish to configure. If you have more than one, make sure to choose the respective slot # for each controller
|
Repeat steps 2 through 5 for any other motion controllers you wish to configure. If you have more than one, make sure to choose the respective slot # for each controller
|
||||||
|
|
||||||
Amiibo Emulation
|
# Amiibo Emulation
|
||||||
================
|
|
||||||
|
|
||||||
All Amiibo are able to be virtually scanned within the emulator, as long as you are actively connected to the internet. No files or dumps are required!
|
All Amiibo are able to be virtually scanned within the emulator, as long as you are actively connected to the internet. No files or dumps are required!
|
||||||
|
|
||||||
**To scan an Amiibo:**
|
**To scan an Amiibo:**
|
||||||
|
|
||||||
1. While playing a game that supports Amiibo, either navigate to the area where Amiibo scanning is expected, or press/hold the correct button to enable the Amiibo scan prompt (this site has a basic list of supported games and what benefits are provided by each: https://amiibo.life/games)
|
1. While playing a game that supports Amiibo, either navigate to the area where Amiibo scanning is expected, or press/hold the correct button to enable the Amiibo scan prompt (this site has a basic list of supported games and what benefits are provided by each: https://amiibo.life/games)
|
||||||
|
|
||||||
2. Click the "Actions" menu header, then click "Scan an Amiibo"\
|
2. Click the "Actions" menu header, then click "Scan an Amiibo"\
|
||||||
{width=50%}
|
{width="50%"}
|
||||||
|
|
||||||
3. Choose the Amiibo you want from the Amiibo Series and Character dropdowns. Note: only the Amiibo that have content for the game you are currently playing are shown in this window. All the same, if you'd like to see all Amiibo you may check the box that says "Show All Amiibo".\
|
3. Choose the Amiibo you want from the Amiibo Series and Character dropdowns. Note: only the Amiibo that have content for the game you are currently playing are shown in this window. All the same, if you'd like to see all Amiibo you may check the box that says "Show All Amiibo".\
|
||||||
{width=50%}
|
{width="50%"}
|
||||||
|
|
||||||
**Addendum:** In The Legend of Zelda: Breath of the Wild, you may continually scan Amiibo as many times as you wish by checking the box labeled "Hack: Use Random Tag Uuid" box.
|
**Addendum:** In The Legend of Zelda: Breath of the Wild, you may continually scan Amiibo as many times as you wish by checking the box labeled "Hack: Use Random Tag Uuid" box.
|
||||||
|
|
||||||
@ -608,181 +457,148 @@ If you would still like the functionality of reading your own dumped Amiibo file
|
|||||||
|
|
||||||
Scanning of Amiibo .bin files is disabled by default until the Amiibo key is placed in the correct location.
|
Scanning of Amiibo .bin files is disabled by default until the Amiibo key is placed in the correct location.
|
||||||
|
|
||||||
1. Click *File* at the top left of the *Ryujinx* window, and then click
|
1. Click _File_ at the top left of the _Ryujinx_ window, and then click _Open Ryujinx_ _Folder_.\
|
||||||
*Open Ryujinx* *Folder*.\
|
{width="50%"}
|
||||||
{width=50%}
|
2. Navigate down into the system subfolder and paste your key_retail.bin file here. The file/folder structure should look like this (JohnDoe substituted for your username):\
|
||||||
|
{width="50%"}
|
||||||
|
3. Restart Ryujinx for the key to be detected.
|
||||||
2. Navigate down into the system subfolder and paste your key_retail.bin file
|
|
||||||
here. The file/folder structure should look like this (JohnDoe
|
|
||||||
substituted for your username):\
|
|
||||||
{width=50%}
|
|
||||||
|
|
||||||
3. Restart Ryujinx for the key to be detected.
|
|
||||||
|
|
||||||
The steps to scan an Amiibo .bin are nearly the same from before, you just need to select the new "Scan An Amiibo (From Bin)" option and select an Amiibo file from there.\
|
The steps to scan an Amiibo .bin are nearly the same from before, you just need to select the new "Scan An Amiibo (From Bin)" option and select an Amiibo file from there.\
|
||||||
{width=50%}
|
{width="50%"}
|
||||||
|
|
||||||
|
# Profiled Persistent Translation Cache
|
||||||
Profiled Persistent Translation Cache
|
|
||||||
=====================================
|
|
||||||
|
|
||||||
Speed up game loading times with PPTC
|
Speed up game loading times with PPTC
|
||||||
|
|
||||||
In a nutshell, this feature caches translated functions so that they do
|
In a nutshell, this feature caches translated functions so that they do not need to be translated every time the game loads. This results in a significant reduction of load times (the amount of time between launching a game and arriving at the title screen) for nearly every game.
|
||||||
not need to be translated every time the game loads. This results in a
|
|
||||||
significant reduction of load times (the amount of time between
|
|
||||||
launching a game and arriving at the title screen) for nearly every
|
|
||||||
game.
|
|
||||||
|
|
||||||
**NOTE: You must launch the game at least twice and let it load**
|
**NOTE: You must launch the game at least twice and let it load** **to the title screen or beyond before performance improvements are** **unlocked on the third launch! These improvements are permanent and do** **not require any extra launches going forward.**
|
||||||
**to the title screen or beyond before performance improvements are**
|
|
||||||
**unlocked on the third launch! These improvements are permanent and do**
|
|
||||||
**not require any extra launches going forward.**
|
|
||||||
|
|
||||||
PPTC (Profiled Persistent Translation Cache) is now enabled by default. To disable it:
|
PPTC (Profiled Persistent Translation Cache) is now enabled by default. To disable it:
|
||||||
|
|
||||||
1. With *Ryujinx* open, click on *Options \> Settings*\
|
1. With _Ryujinx_ open, click on _Options \> Settings_\
|
||||||
|
|
||||||
|
2. Then navigate to the CPU tab and uncheck the box marked "PPTC (Profiled Persistent Translation Cache)"\
|
||||||
2. Then navigate to the CPU tab and uncheck the box marked "PPTC (Profiled Persistent Translation Cache)"\
|
|
||||||
|
|
||||||
|
|
||||||
From time to time you may wish to examine or purge your PPTC cache files if you are experiencing PPTC-related issues.
|
From time to time you may wish to examine or purge your PPTC cache files if you are experiencing PPTC-related issues.
|
||||||
|
|
||||||
To open the PPTC cache file location:
|
To open the PPTC cache file location:
|
||||||
1. With Ryujinx open, right-click the game in the game list whose PPTC cache files you wish to view. This will bring up a pop-up menu.
|
|
||||||
|
|
||||||
2. Navigate to _Cache Management_ > _Open the PPTC directory_\
|
1. With Ryujinx open, right-click the game in the game list whose PPTC cache files you wish to view. This will bring up a pop-up menu.
|
||||||
|
2. Navigate to _Cache Management_ \> _Open the PPTC directory_\
|
||||||
|
|
||||||
|
|
||||||
To purge the PPTC cache files:
|
To purge the PPTC cache files:
|
||||||
1. With Ryujinx open, right-click the game in the game list whose PPTC cache files you wish to purge. This will bring up a pop-up menu.
|
|
||||||
|
|
||||||
2. Navigate to _Cache Management_ > _Open PPTC Directory_\
|
1. With Ryujinx open, right-click the game in the game list whose PPTC cache files you wish to purge. This will bring up a pop-up menu.
|
||||||
|
2. Navigate to _Cache Management_ \> _Open PPTC Directory_\
|
||||||
|
|
||||||
|
3. You can then select the folders and delete them.\
|
||||||
|
|
||||||
|
|
||||||
3. You can then select the folders and delete them.\
|
# Graphics Enhancements
|
||||||
|
|
||||||
|
|
||||||
Graphics Enhancements
|
_Ryujinx_ offers a few graphics enhancement options.
|
||||||
=====================
|
|
||||||
|
|
||||||
*Ryujinx* offers a few graphics enhancement options.
|
|
||||||
|
|
||||||
1. _Resolution Scaling_, which offers a much sharper image with little to no impact to performance. Resolution scaling can increase image quality much more noticeably than Anisotropic Filtering. Ryujinx's resolution scaling implementation allows native, 2x, 3x, 4x, or even custom ratios for upscaling.
|
1. _Resolution Scaling_, which offers a much sharper image with little to no impact to performance. Resolution scaling can increase image quality much more noticeably than Anisotropic Filtering. Ryujinx's resolution scaling implementation allows native, 2x, 3x, 4x, or even custom ratios for upscaling.
|
||||||
|
2. _Anisotropic Filtering_, which can visibly improve graphic quality. [Wikipedia says](https://en.wikipedia.org/wiki/Anisotropic_filtering):\
|
||||||
2. _Anisotropic Filtering_, which can visibly improve graphic quality.
|
_In layman's terms, anisotropic filtering retains the "sharpness" of_ _a texture normally lost by MIP map texture's attempts to avoid_ _aliasing. Anisotropic filtering can therefore be said to maintain crisp_ _texture detail at all viewing orientations while providing fast_ _anti-aliased texture filtering._
|
||||||
[Wikipedia says](https://en.wikipedia.org/wiki/Anisotropic_filtering):\
|
|
||||||
_In layman\'s terms, anisotropic filtering retains the \"sharpness\" of_
|
|
||||||
_a texture normally lost by MIP map texture\'s attempts to avoid_
|
|
||||||
_aliasing. Anisotropic filtering can therefore be said to maintain crisp_
|
|
||||||
_texture detail at all viewing orientations while providing fast_
|
|
||||||
_anti-aliased texture filtering._
|
|
||||||
|
|
||||||
3. _Shader Cache_, which stores onto disk the shaders that have already been compiled, negating the need to compile them again. This feature is highly sought after as it significantly reduces stuttering and FPS drops on subsequent plays of a particular game making for a smoother, more enjoyable gameplay experience. **Note: Shader Cache is enabled by default.**
|
3. _Shader Cache_, which stores onto disk the shaders that have already been compiled, negating the need to compile them again. This feature is highly sought after as it significantly reduces stuttering and FPS drops on subsequent plays of a particular game making for a smoother, more enjoyable gameplay experience. **Note: Shader Cache is enabled by default.**
|
||||||
|
|
||||||
4. _Aspect Ratio Options_, which allow you to adjust the width-to-height ratio to your liking. **Note: these options may give your game a stretched or squeezed appearance unless you are using mods that change the expected aspect ratio of the game.**
|
4. _Aspect Ratio Options_, which allow you to adjust the width-to-height ratio to your liking. **Note: these options may give your game a stretched or squeezed appearance unless you are using mods that change the expected aspect ratio of the game.**
|
||||||
|
|
||||||
**To enable _Resolution Scaling_:**\
|
**To enable _Resolution Scaling_:**\
|
||||||
**Note: Enabling this feature may cause graphical glitches on some games.**\
|
**Note: Enabling this feature may cause graphical glitches on some games.**\
|
||||||
**These settings may be changed in-game on the fly! On a standard 1080p display, 2x resolution scaling is recommended.**
|
**These settings may be changed in-game on the fly! On a standard 1080p display, 2x resolution scaling is recommended.**
|
||||||
|
|
||||||
1. With *Ryujinx* open, click *Options \> Settings*\
|
1. With _Ryujinx_ open, click _Options \> Settings_\
|
||||||
|
|
||||||
|
2. Navigate to the _Graphics_ tab and click the dropdown next to Resolution Scale. Select your desired level of resolution scaling.
|
||||||
2. Navigate to the *Graphics* tab and click the dropdown next to Resolution Scale. Select your desired level of resolution scaling.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**Click *Apply* and then *OK* to save the enhancement setting.**
|
**Click _Apply_ and then _OK_ to save the enhancement setting.**
|
||||||
|
|
||||||
**To enable _Anisotropic Filtering_:**
|
**To enable _Anisotropic Filtering_:**
|
||||||
|
|
||||||
**Note: enabling this feature may cause graphical glitches on some**
|
**Note: enabling this feature may cause graphical glitches on some** **games.**
|
||||||
**games.**
|
|
||||||
|
|
||||||
1. With *Ryujinx* open, click on *Options \> Settings*\
|
1. With _Ryujinx_ open, click on _Options \> Settings_\
|
||||||
|
|
||||||
|
2. Navigate to the _Graphics_ tab and click the dropdown next to _Anisotropic Filtering_. Set it to your desired level.\
|
||||||
|
|
||||||
|
|
||||||
2. Navigate to the *Graphics* tab and click the dropdown next to
|
**Click _Apply_ and then _OK_ to save the settings.**
|
||||||
*Anisotropic Filtering*. Set it to your desired level.\
|
|
||||||
|
|
||||||
|
|
||||||
**Click *Apply* and then *OK* to save the settings.**
|
**To Manage _Shader Cache_:**\
|
||||||
|
|
||||||
**To Manage _Shader Cache_:**
|
|
||||||
**Shader Cache is enabled by default**. There are no good reasons to disable it other than for testing purposes.
|
**Shader Cache is enabled by default**. There are no good reasons to disable it other than for testing purposes.
|
||||||
|
|
||||||
Disabling this setting is strongly discouraged. However, if you absolutely must disable it:
|
Disabling this setting is strongly discouraged. However, if you absolutely must disable it:
|
||||||
1. With Ryujinx open, navigate to _Options > Settings_.
|
|
||||||
|
|
||||||
|
1. With Ryujinx open, navigate to _Options \> Settings_.
|
||||||
2. Navigate to the Graphics tab and disable shader cache by unchecking the box marked "Enable Shader Cache"
|
2. Navigate to the Graphics tab and disable shader cache by unchecking the box marked "Enable Shader Cache"
|
||||||
|
|
||||||
|
|
||||||
In some rare cases, a shader cache might become corrupted and crash when compiling shaders on boot. To solve this you'll have to purge the shader cache for that particular game:
|
In some rare cases, a shader cache might become corrupted and crash when compiling shaders on boot. To solve this you'll have to purge the shader cache for that particular game:
|
||||||
|
|
||||||
Right click on a game in the game list and navigate to Cache Management > Purge Shader Cache.\
|
Right click on a game in the game list and navigate to Cache Management \> Purge Shader Cache.\
|
||||||
|
|
||||||
|
|
||||||
To view the shader cache directory for a particular game:
|
To view the shader cache directory for a particular game:
|
||||||
|
|
||||||
Right click on a game in the game list and navigate to Cache Management > Open Shader Cache Directory.\
|
Right click on a game in the game list and navigate to Cache Management \> Open Shader Cache Directory.\
|
||||||
|
|
||||||
|
|
||||||
To adjust your aspect ratio:
|
To adjust your aspect ratio:
|
||||||
|
|
||||||
**Option 1:**
|
**Option 1:**
|
||||||
- With Ryujinx open, navigate to Options > Settings and click on the Graphics tab. Click on the Aspect Ratio dropdown and adjust the ratio to your liking.\
|
|
||||||
|
- With Ryujinx open, navigate to Options \> Settings and click on the Graphics tab. Click on the Aspect Ratio dropdown and adjust the ratio to your liking.\
|
||||||
|
|
||||||
|
|
||||||
**Option 2:**
|
**Option 2:**
|
||||||
|
|
||||||
- With your game running, click on the aspect ratio button in the status toolbar at the bottom of the Ryujinx window.\
|
- With your game running, click on the aspect ratio button in the status toolbar at the bottom of the Ryujinx window.\
|
||||||
|
|
||||||
|
|
||||||
**Option 3 (NOT RECOMMENDED):**
|
**Option 3 (NOT RECOMMENDED):**
|
||||||
1. Use Option 1 and select "Stretch to Fit Window" or Option 2 and select "Stretched".
|
|
||||||
|
|
||||||
|
1. Use Option 1 and select "Stretch to Fit Window" or Option 2 and select "Stretched".
|
||||||
2. Simply click and drag your window borders to the size you want!
|
2. Simply click and drag your window borders to the size you want!
|
||||||
|
|
||||||
Portable Mode
|
# Portable Mode
|
||||||
=============
|
|
||||||
|
|
||||||
If you wish, you may use a custom folder location for all Ryujinx data (as opposed to keeping it in its default location: %appdata%). This is done via the command-line or, more conveniently, a custom shortcut. In the future, the ability to configure custom data folders may be added to the GUI.
|
If you wish, you may use a custom folder location for all Ryujinx data (as opposed to keeping it in its default location: %appdata%). This is done via the command-line or, more conveniently, a custom shortcut. In the future, the ability to configure custom data folders may be added to the GUI.
|
||||||
|
|
||||||
**NOTE: You must manually create the custom folder first before using portable mode! After enabling portable mode, you will need to copy your prod.keys file and any desired game data/save data from its original location to the new data folder.**
|
**NOTE: You must manually create the custom folder first before using portable mode! After enabling portable mode, you will need to copy your prod.keys file and any desired game data/save data from its original location to the new data folder.**
|
||||||
|
|
||||||
To enable *Portable Mode*
|
To enable _Portable Mode_
|
||||||
|
|
||||||
**Option 1: (Recommended)** Create a "portable" subfolder
|
**Option 1: (Recommended)** Create a "portable" subfolder
|
||||||
|
|
||||||
1. Create a subfolder in the Ryujinx program base directory called "portable". This automatically enables portable mode and utilizes this "portable" folder for system folder contents (keys, firmware, PPTC/shader caches, etc.).\
|
1. Create a subfolder in the Ryujinx program base directory called "portable". This automatically enables portable mode and utilizes this "portable" folder for system folder contents (keys, firmware, PPTC/shader caches, etc.).\
|
||||||
|
|
||||||
|
|
||||||
**Option 2:** Command-line
|
**Option 2:** Command-line
|
||||||
1. Open a command prompt, navigate to the location of the Ryujinx executable and type the following command: ryujinx.exe -r d:\[folderpath]. For example, if your custom folder was d:\ryujinxdata, your command would be the following, without quotes (_THIS IS ONLY AN EXAMPLE. USE WHATEVER CUSTOM FOLDER NAME YOU PREFER_):
|
|
||||||
"ryujinx.exe -r d:\ryujinxdata"\
|
1. Open a command prompt, navigate to the location of the Ryujinx executable and type the following command: ryujinx.exe -r d:\[folderpath\]. For example, if your custom folder was d:\\ryujinxdata, your command would be the following, without quotes (_THIS IS ONLY AN EXAMPLE. USE WHATEVER CUSTOM FOLDER NAME YOU PREFER_): "ryujinx.exe -r d:\\ryujinxdata"\
|
||||||
|
|
||||||
|
|
||||||
The command prompt window will become the console window when Ryujinx launches.
|
The command prompt window will become the console window when Ryujinx launches.
|
||||||
|
|
||||||
**Option 3:** Custom Shortcut
|
**Option 3:** Custom Shortcut
|
||||||
|
|
||||||
1. Right-click on your Ryujinx executable and click Send To -> Desktop Shortcut\
|
1. Right-click on your Ryujinx executable and click Send To -\> Desktop Shortcut\
|
||||||
|
|
||||||
|
|
||||||
2. Locate the new shortcut on your desktop and right-click on it, then click Properties\
|
2. Locate the new shortcut on your desktop and right-click on it, then click Properties\
|
||||||
|
|
||||||
|
3. In the Properties window, click into the Target field and add a space onto the end of the existing command. Then add "-r \[folderpath\]" without quotes where \[folderpath\] is your own custom data folder full path, and click OK. For example, if your custom data folder was d:\\ryujinxdata, the addition you would paste into the target field would be "-r d:\\ryujinxdata" without the quotes.\
|
||||||
|
|
||||||
|
|
||||||
3. In the Properties window, click into the Target field and add a space onto the end of the existing command. Then add "-r [folderpath]" without quotes where [folderpath] is your own custom data folder full path, and click OK. For example, if your custom data folder was d:\ryujinxdata, the addition you would paste into the target field would be "-r d:\ryujinxdata" without the quotes.\
|
Note: On MacOS, the command would be as follows, without the quotes: "/Applications/Ryujinx.app/Contents/MacOS/Ryujinx -r /path/to/custom/ryujinx/folder"
|
||||||
|
|
||||||
|
|
||||||
Note: On MacOS, the command would be as follows, without the quotes:
|
|
||||||
"/Applications/Ryujinx.app/Contents/MacOS/Ryujinx -r /path/to/custom/ryujinx/folder"
|
|
||||||
|
|
||||||
You can now use this shortcut any time you want to launch Ryujinx in portable mode!
|
You can now use this shortcut any time you want to launch Ryujinx in portable mode!
|
||||||
|
|
||||||
Launch in Fullscreen
|
# Launch in Fullscreen
|
||||||
====================
|
|
||||||
|
|
||||||
Ryujinx can automatically launch games in fullscreen mode. You can enable this functionality in one of two ways:
|
Ryujinx can automatically launch games in fullscreen mode. You can enable this functionality in one of two ways:
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user