deadcade/Ryujinx
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Updated Ryujinx Setup & Configuration Guide (markdown)

EmulationFanatic 2020-11-12 16:36:54 -07:00
parent b3dd2d76bb
commit e2b993dcc5
1 changed files with 32 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
Ryujinx-Setup-&-Configuration-Guide.md

@ -1,11 +1,12 @@
This article assumes you have already dumped your Nintendo Switch keys
This article assumes you have already [dumped your Nintendo Switch keys](https://nh-server.github.io/switch-guide/user_guide/sysnand/making_essential_backups/)
(prod.keys) and firmware file(s). This guide illustrates using a
properly dumped recent game cartridge as an untrimmed XCI file to
install a firmware directly to Ryujinx. It is also possible to install
firmware from a folder or ZIP file. You may also follow this [firmware dumping guide using Goldleaf](https://github.com/Ryujinx/Ryujinx/wiki/Firmware-Dumping-Guide-(hbmenu-&-Goldleaf)).
If you haven't already downloaded *Ryujinx*, get the latest version
from: <https://ryujinx.org/download>
from: <https://ryujinx.org/download>.
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
@ -458,26 +459,25 @@ To purge the PPTC cache files:
Graphics Enhancements
=====================
Currently, *Ryujinx* offers two 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.
2. _Anisotropic Filtering_, which can visibly improve graphic quality.
[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._
*Ryujinx* **does not have** a disk shader cache at this time, though
this functionality may be added sometime in the future.\
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.**
**To enable _Resolution Scaling_:**\
**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.**
1. With *Ryujinx open, click *Options \> Settings*\
1. With *Ryujinx* open, click *Options \> Settings*\
![image](https://user-images.githubusercontent.com/62343878/86672580-078e3480-bfb4-11ea-8c01-86b05066a4dc.png)
2. Navigate to the *Graphics* tab and click the dropdown next to Resolution Scale. Select your desired level of resolution scaling.\
![image](https://user-images.githubusercontent.com/62343878/86673437-e7ab4080-bfb4-11ea-86de-876d7563f6a2.png)
@ -499,6 +499,29 @@ this functionality may be added sometime in the future.\
\
**Click *Save*** to save the enhancement setting.
**To Manage _Shader Cache_:**
**Shader Cache is enabled by default**.
To disable Shader Cache:
1. With Ryujinx open, navigate to _Options > Settings_.
![image](https://user-images.githubusercontent.com/62343878/98552955-50087800-225c-11eb-8404-94dc31446a3a.png)
2. Navigate to the Graphics tab and disable shader cache by unchecking the box marked "Enable Shader Cache"
![image](https://user-images.githubusercontent.com/62343878/98550108-ea66bc80-2258-11eb-8444-e0dfbdfc5287.png)
To purge the shader cache for a particular game:
1. Right click on a game in the game list and navigate to Cache Management > Purge Shader Cache.
![image](https://user-images.githubusercontent.com/62343878/98551756-e76ccb80-225a-11eb-83b8-ce99b712e7d6.png)
To view the shader cache directory for a particular game:
1. Right click on a game in the game list and navigate to Cache Management > Open Shader Cache Directory.
![image](https://user-images.githubusercontent.com/62343878/98551866-0ec39880-225b-11eb-8380-967c97bfd97f.png)
Portable Mode
=============
@ -506,7 +529,7 @@ If you wish, you may use a custom folder location for all Ryujinx data (as oppos
**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* **WARNING: _DO NOT_ PUT YOUR CUSTOM DATA FOLDER INSIDE THE RYUJINX PROGRAM FOLDER. THE RYUJINX PROGRAM FOLDER IS PURGED EACH TIME THE AUTO-UPDATER INSTALLS AN UPDATE:**
**Option 1:** 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_):