mirror of
https://github.com/ryujinx-mirror/ryujinx.git
synced 2024-12-22 18:45:46 +00:00
Docs: Update setup/index
This commit is contained in:
Trigus42
parent
c6a5444d99
commit
561e9379c1
2 changed files with 183 additions and 179 deletions
|
|
@ -40,6 +40,7 @@ markdown_extensions:
|
|||
- pymdownx.inlinehilite
|
||||
- pymdownx.superfences
|
||||
- pymdownx.smartsymbols
|
||||
- sane_lists
|
||||
extra_css:
|
||||
- stylesheets/extra.css
|
||||
plugins:
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ This article assumes you have already **[hacked your Nintendo Switch](https://nh
|
|||
This guide also illustrates how to use an untrimmed game cartridge dump (XCI file) to install firmware directly to Ryujinx. If you would prefer to dump the firmware standalone, you may follow this **[firmware dumping guide](firmware-dumping)**.
|
||||
|
||||
If you haven't already downloaded Ryujinx, get the latest version from the releases page.
|
||||
<!-- Ryujinx checks for updates automatically at startup. You can disable this feature in `Options > Settings`. You can also check for updates manually by navigating to `Help > Check for Updates`. -->
|
||||
<!-- Ryujinx checks for updates automatically at startup. You can disable this feature in *Options > Settings*. You can also check for updates manually by navigating to `Help > Check for Updates`. -->
|
||||
|
||||
## Preface
|
||||
Ryujinx comes pre-optimized by default. If a particular menu option is not mentioned in this guide, it should be ignored and not changed unless directly instructed by Ryujinx staff.
|
||||
|
|
@ -65,17 +65,15 @@ By default Ryujinx will use `%appdata%/Ryujinx` (or the equivalent application d
|
|||
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!)
|
||||
*[Image missing]*
|
||||
<!--  -->
|
||||
|
||||
|
||||
3. Click *OK* on the warning box.
|
||||
Now that *Ryujinx* has been launched, the proper folders have been
|
||||
created for you in your %appdata% folder.
|
||||
created for you in your `%appdata%` folder.
|
||||
|
||||
4. Click *File* at the top left of the *Ryujinx* window, and then click
|
||||
*Open Ryujinx* *Folder*.
|
||||
<!--  -->
|
||||
|
||||
|
||||
|
||||
5. Navigate down into the system subfolder and paste your prod.keys file
|
||||
here. The file/folder structure should look like this (JohnDoe
|
||||
|
|
@ -95,22 +93,22 @@ dumped, or have compiled your [dumped firmware](firmware-dumping) into a ZIP fil
|
|||
ensure you have placed the file correctly.
|
||||
|
||||
2. Now that *Ryujinx* is open, click *Tools > Firmware > Install from XCI/ZIP*.
|
||||
<!--  -->
|
||||
|
||||
This brings up the "Choose the firmware file to open" window.
|
||||
<!--  -->
|
||||
|
||||
|
||||
|
||||
3. Using the *Ryujinx* window, 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)*
|
||||
 -->
|
||||
*(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
|
||||
|
|
@ -154,29 +152,31 @@ various reasons e.g. bugfixes, new content, etc. *Ryujinx* has built-in
|
|||
functionality to manage which version of the game you want to play.
|
||||
|
||||
1. In the main *Ryujinx* game list right-click the game you want to
|
||||
apply an update to. Then click *Manage Title Updates*.
|
||||
apply an update to. Then click *Manage Title Updates*.
|
||||
|
||||
|
||||
|
||||
After clicking *Manage Title Updates*, you will see the *Ryujinx --
|
||||
Title Update Manager* menu.
|
||||
|
||||
2. In the *Ryujinx -- Title Update Manager* menu, click *Add*.
|
||||
2. In the *Ryujinx -- Title Update Manager* menu, click *Add*.
|
||||
|
||||
|
||||
3. Clicking *Add* will bring up the navigation menu. Navigate to the
|
||||
location of your game's update files and select update you want to
|
||||
add to *Ryujinx*, and click *Add*.
|
||||
|
||||
3. Clicking *Add* will bring up the navigation menu. Navigate to the location
|
||||
of your game's update files and select update you want to add to *Ryujinx*,
|
||||
and click *Add*.
|
||||
|
||||
|
||||
This will bring you back to the *Ryujinx -- Title Update Manager*
|
||||
window. You may repeat this for any other game version update files
|
||||
you wish to add to *Ryujinx*.
|
||||
|
||||
4. In the *Ryujinx -- Title Update Manager* window, select the version
|
||||
of the update you wish to be applied to the game and click *Save*.
|
||||
1. In the *Ryujinx -- Title Update Manager* window, select the version
|
||||
of the update you wish to be applied to the game and click *Save*.
|
||||
|
||||
|
||||
5. Verify that the proper version number is shown in the main *Ryujinx*
|
||||
games list window.
|
||||
2. Verify that the proper version number is shown in the main *Ryujinx*
|
||||
games list window.
|
||||
|
||||
|
||||
Your game update has now been applied, and you may repeat the
|
||||
|
|
@ -192,21 +192,21 @@ DLC.
|
|||
|
||||
1. With *Ryujinx* open, right-click on the game you want to add or
|
||||
manage DLC for and click *Manage DLC* to bring up the *Ryujinx - DLC
|
||||
Manager* window.
|
||||
Manager* window.
|
||||
|
||||
|
||||
2. Within the *Ryujinx -- DLC Manager* window, click *Add* to open the
|
||||
DLC navigation screen.
|
||||
DLC navigation screen.
|
||||
|
||||
|
||||
3. Navigate to the location of the DLC file(s) you wish to apply, then
|
||||
double-click the file to automatically add it. Or you may select the
|
||||
file or files, and click *Add*.
|
||||
file or files, and click *Add*.
|
||||
**Note: you may add more than one DLC file at a time!**
|
||||
|
||||
|
||||
4. You will now see your DLC in the *Ryujinx - DLC Manager* window.
|
||||
**Click *Save*** to save your configuration.
|
||||
**Click *Save*** to save your configuration.
|
||||
|
||||
|
||||
**Note: always drill down to see the proper status of the DLC .nca file you are managing. Checking and unchecking the .nca file is the way to enable and disable the DLC. The parent container (.nsp file) shows unchecked by default, even if the DLC is enabled.**
|
||||
|
|
@ -216,32 +216,30 @@ Repeat this process, if you wish, for any other games you would like to manage D
|
|||
## 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:
|
||||
1. ExeFS Partition Replacement
|
||||
Various game mods are available from enthusiasts & content creators online. *Ryujinx* supports the following types of mods:
|
||||
|
||||
1. ExeFS Partition Replacement
|
||||
2. ExeFS File Replacement
|
||||
3. ExeFS Patching
|
||||
4. RomFS Partition Replacement
|
||||
5. RomFS File Replacement
|
||||
|
||||
**For an in-depth explanation of the mods implementation & advanced usage options in _Ryujinx_, check the description in the original PR [here](https://github.com/ryujinx-mirror/ryujinx/pull/1249)**.
|
||||
**For an in-depth explanation of the mods implementation & advanced usage options in *Ryujinx*, check the description in the original PR [here](https://github.com/ryujinx-mirror/ryujinx/pull/1249)**.
|
||||
|
||||
To enable mods:
|
||||
|
||||
1. With _Ryujinx_ open, right-click on the game you wish to manage mods for and click _Open Mods Directory_.
|
||||
|
||||
|
||||
1. With *Ryujinx* open, right-click on the game you wish to manage mods for and click *Open Mods Directory*.
|
||||
|
||||
|
||||
This will open the `AppData\Roaming\Ryujinx\mods\contents\<game ID>\` folder.
|
||||
|
||||
2. Create a subfolder under the game id folder with an appropriate name conveying the mod you will be using. For instance, you might name the folder "Lana" if you were using a mod to add a Lana skin to Mario Kart 8 Deluxe.
|
||||
2. Create a subfolder under the game id folder with an appropriate name conveying the mod you will be using. For instance, you might name the folder "Lana" if you were using a mod to add a Lana skin to Mario Kart 8 Deluxe.
|
||||
|
||||
|
||||
|
||||
3. Copy your mod's romfs folder or exefs folder into the new folder you created.
|
||||
|
||||
|
||||
3. Copy your mod's romfs folder or exefs folder into the new folder you created.
|
||||
|
||||
|
||||
|
||||
Mods can also be placed in the `AppData\Roaming\Ryujinx\sdcard` folder if the mod has been packaged for real hardware (usually indicated with an "atmosphere" folder as the top directory). With _Ryujinx_ open, right-clicking on the game you wish to manage SD mods for and clicking _Open Atmosphere Mods Directory_ will open the `AppData\Roaming\Ryujinx\sdcard\atmosphere\contents\<game ID>` folder where the romfs/exefs folders are located.
|
||||
Mods can also be placed in the `AppData\Roaming\Ryujinx\sdcard` folder if the mod has been packaged for real hardware (usually indicated with an "atmosphere" folder as the top directory). With *Ryujinx* open, right-clicking on the game you wish to manage SD mods for and clicking *Open Atmosphere Mods Directory* will open the `AppData\Roaming\Ryujinx\sdcard\atmosphere\contents\<game ID>` folder where the romfs/exefs folders are located.
|
||||
|
||||
|
||||
|
||||
|
|
@ -250,13 +248,13 @@ Mods can also be placed in the `AppData\Roaming\Ryujinx\sdcard` folder if the mo
|
|||
|
||||
Ryujinx now has native cheats/runtime mods support!
|
||||
It implements full support Atmosphere style cheats (except game pausing/resume):
|
||||
https://github.com/Atmosphere-NX/Atmosphere/blob/master/docs/features/cheats.md
|
||||
[Atmosphere Cheats](https://github.com/Atmosphere-NX/Atmosphere/blob/master/docs/features/cheats.md)
|
||||
|
||||
## Installation of Atmosphere Cheats
|
||||
|
||||
A good place to acquire Atmosphere cheats is:
|
||||
|
||||
- https://github.com/WerWolv/EdiZon_CheatsConfigsAndScripts/tree/master/Cheats (general switch cheats)
|
||||
- [WerWolv's EdiZon Cheats](https://github.com/WerWolv/EdiZon_CheatsConfigsAndScripts/tree/master/Cheats) (general switch cheats)
|
||||
|
||||
Inside the cheat `zip`, `rar`, or other archive format, there is usually a file structure like this:
|
||||
|
||||
|
|
@ -264,7 +262,9 @@ Inside the cheat `zip`, `rar`, or other archive format, there is usually a file
|
|||
Cheat_Name\cheats\0123456789ABCDEF.txt
|
||||
```
|
||||
|
||||
Where `0123456789ABCDEF` will vary according to the game and the cheat (this is the build id of the executable the cheat attaches itself to). A cheat can also contain several `txt` files. **Cheats are game-specific and version-specific, they will not work if transferred from one game to another or to an incompatible update of the game.**
|
||||
Where `0123456789ABCDEF` will vary according to the game and the cheat (this is the build id of the executable the cheat attaches itself to). A cheat can also contain several `txt` files.
|
||||
|
||||
**Cheats are game-specific and version-specific, they will not work if transferred from one game to another or to an incompatible update of the game.**
|
||||
|
||||
To install the cheat:
|
||||
|
||||
|
|
@ -320,7 +320,7 @@ To disable the time cheat, just remove its section and the code:
|
|||
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.
|
||||
|
||||
### 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.
|
||||
|
|
@ -346,20 +346,17 @@ In the Manage Accounts - Avatar window, select the avatar you want, and choose a
|
|||
|
||||
### 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 **Add New Profile** button at the bottom left corner of the window.
|
||||
2. Click on the **Add New Profile** button at the bottom left corner of the window.
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
4. You will now be prompted to choose the profile image. Follow step 3 from the user profile editing instructions above.
|
||||
|
||||
|
||||
4. You will now be prompted to choose the profile image. Follow step 3 from the user profile editing instructions above.
|
||||
|
||||
|
||||
That's it!
|
||||
|
||||
|
|
@ -370,45 +367,43 @@ carefully!
|
|||
|
||||
1. Plug in the controller(s) that you will be using.
|
||||
|
||||
2. Open *Ryujinx* and navigate to *Options \> Settings*
|
||||
!
|
||||
2. Open *Ryujinx* and navigate to *Options \> Settings*
|
||||
|
||||
|
||||
3. You will now see the *Ryujinx - Settings* window. Click on the
|
||||
*Input* tab.
|
||||
*Input* tab.
|
||||
|
||||
|
||||
Before proceeding to configure anything, the options on the Input page
|
||||
need some explanation:
|
||||
Before proceeding to configure anything, the options on the Input page
|
||||
need some explanation:
|
||||
|
||||
*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 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***
|
||||
|
||||
*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 (top left menu item)**
|
||||
**If you leave this box unchecked, you will need to click configure under**
|
||||
**Handheld (bottom right menu item)**
|
||||
*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 (top left menu item).**
|
||||
**If you leave this box unchecked, you will need to click configure under Handheld (bottom right menu item)**
|
||||
|
||||
|
||||
4. Click *Configure* under *Player 1* if you have enabled *Docked
|
||||
1. Click *Configure* under *Player 1* if you have enabled *Docked
|
||||
Mode*, or click configure *Handheld* if you have not enabled *Docked
|
||||
Mode*.
|
||||
Mode*.
|
||||
|
||||
|
||||
5. You should now be in the *Ryujinx -- Controller Settings* screen.
|
||||
2. You should now be in the *Ryujinx -- Controller Settings* screen.
|
||||
Click on the *Input Device* dropdown and choose the *Xinput
|
||||
controller*. 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/).
|
||||
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 Xinput controller you should now see a full
|
||||
1. After selecting your Xinput controller you should now see a full
|
||||
mapping UI. If you want to map the buttons in a standard
|
||||
Xinput-compatible fashion, there is no need to individually map the
|
||||
buttons. Simply click on the empty *Profile* dropdown, select
|
||||
|
|
@ -417,8 +412,8 @@ better graphical fidelity on games that support these features.
|
|||
controller. Otherwise, click on "*Unbound*" for each button you want
|
||||
to map, then press the actual button on your controller that you
|
||||
want for the Nintendo Switch controller button you've
|
||||
chosen.
|
||||
|
||||
chosen.
|
||||
|
||||
|
||||
You may continue tweaking the settings to your liking, or binding
|
||||
each button from scratch if you want a fully custom button layout.
|
||||
|
|
@ -432,7 +427,7 @@ configure, configure them now under Player 2, Player 3, and so on.
|
|||
7. ***Click Save to save your configuration.***
|
||||
|
||||
Alternately, you may skip the input UI and edit your config.json file
|
||||
found in %appdata%\\ryujinx\
|
||||
found in `%appdata%\ryujinx\`
|
||||
|
||||
## Motion Controls
|
||||
### Motion Controls
|
||||
|
|
@ -441,39 +436,37 @@ Ryujinx offers the ability to use motion controls with motion-enabled controller
|
|||
|
||||
To use motion controls in Ryujinx:
|
||||
|
||||
1. Launch & configure your favorite cemuhook server application (Betterjoy, DS4Windows, Steam Gyro, etc.) with your bluetooth or wired motion-enabled controller. Leave the application running.
|
||||
1. Launch & configure your favorite cemuhook server application (Betterjoy, DS4Windows, Steam Gyro, etc.) with your bluetooth or wired motion-enabled 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".
|
||||
|
||||
|
||||
3. Select your motion controller from the dropdown. It will be listed as "Xinput controller".
|
||||
4. Configuration options:
|
||||
|
||||
|
||||
- If you have already configured your controller's input buttons to your liking and only need to configure motion controls, check the "Enable Motion Controls" box and fill in the following information:
|
||||
|
||||
4. Configuration options:
|
||||
**Controller Slot:** the controller slot # your motion controller is configured as in your cemuhook server application. Default is "0"
|
||||
**Gyro Sensitivity:** 100% (you may adjust this to suit)
|
||||
**Server Host:** the IP address of the computer being used to host the cemuhook server. 127.0.0.1 is localhost/the same computer running Ryujinx.
|
||||
**Server Port:** 26760
|
||||
|
||||
- If you have already configured your controller's input buttons to your liking and only need to configure motion controls, check the "Enable Motion Controls" box and fill in the following information:
|
||||
|
||||
|
||||
**Controller Slot:** the controller slot # your motion controller is configured as in your cemuhook server application. Default is "0"
|
||||
**Gyro Sensitivity:** 100% (you may adjust this to suit)
|
||||
**Server Host:** the IP address of the computer being used to host the cemuhook server. 127.0.0.1 is localhost/the same computer running Ryujinx.
|
||||
**Server Port:** 26760
|
||||
- Alternately, you can simply click on the empty Profile dropdown, select Default, and click Load. This populates the buttons with preset mappings and also fills in the motion control settings with recommended defaults. You may continue tweaking the settings to your liking, or binding 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.**
|
||||
Make sure to check the "Enable Motion Controls" box!
|
||||
|
||||
- Alternately, you can simply click on the empty Profile dropdown, select Default, and click Load. This populates the buttons with preset mappings and also fills in the motion control settings with recommended defaults. You may continue tweaking the settings to your liking, or binding 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.**
|
||||
Make sure to check the "Enable Motion Controls" box!
|
||||
- Paired Joycons extra options:
|
||||
|
||||
|
||||
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.
|
||||
|
||||
- Paired Joycons extra options:
|
||||
|
||||
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. Click Save to save your configuration.
|
||||
|
|
@ -485,11 +478,15 @@ Repeat steps 2 through 5 for any other motion controllers you wish to configure.
|
|||
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:**
|
||||
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"
|
||||
|
||||
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".
|
||||
|
||||
|
||||
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"
|
||||
|
||||
|
||||
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".
|
||||
|
||||
|
||||
**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.
|
||||
|
||||
## Profiled Persistent Translation Cache
|
||||
|
|
@ -507,158 +504,164 @@ game.
|
|||
**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 *System* tab and **uncheck the box** marked
|
||||
*Enable Profiled Persistent Translation Cache*
|
||||
*Enable 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.
|
||||
|
||||
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_
|
||||
|
||||
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_ > _Purge the PPTC cache_
|
||||
|
||||
2. Navigate to *Cache Management > Purge the PPTC cache*
|
||||
|
||||
|
||||
## Graphics Enhancements
|
||||
|
||||
*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):
|
||||
_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._
|
||||
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.*
|
||||
|
||||
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_:**
|
||||
**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.**
|
||||
### Enable Resolution Scaling
|
||||
|
||||
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.
|
||||
|
||||
**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*
|
||||
|
||||
2. Navigate to the *Graphics* tab and click the dropdown next to Resolution Scale. Select your desired level of resolution scaling.
|
||||
|
||||
|
||||
**Click *Save*** to save the enhancement setting.
|
||||
**Click *Save*** to save the enhancement setting.
|
||||
|
||||
**To enable _Anisotropic Filtering_:**
|
||||
### Enable Anisotropic Filtering
|
||||
|
||||
**Note: enabling this feature may cause graphical glitches on some**
|
||||
**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.
|
||||
*Anisotropic Filtering*. Set it to your desired level.
|
||||
|
||||
|
||||
**Click *Save*** to save the enhancement setting.
|
||||
|
||||
**To Manage _Shader Cache_:**
|
||||
### Manage shader Cache
|
||||
|
||||
**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:
|
||||
1. With Ryujinx open, navigate to _Options > Settings_.
|
||||
Disabling this setting is strongly discouraged. However, if you absolutely must disable it:
|
||||
|
||||
2. Navigate to the Graphics tab and disable shader cache by unchecking the box marked "Enable Shader Cache"
|
||||
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"
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
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:
|
||||
1. 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:
|
||||
|
||||
|
||||
1. Right click on a game in the game list and navigate to Cache Management > Open Shader Cache Directory.
|
||||
|
||||
|
||||
### Adjust aspect ratio
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
To adjust your aspect ratio:
|
||||
|
||||
**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.
|
||||
#### Method 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.
|
||||
|
||||
|
||||
**Option 2:**
|
||||
- With your game running, click on the aspect ratio button in the status toolbar at the bottom of the Ryujinx window.
|
||||
#### Method 2
|
||||
With your game running, click on the aspect ratio button in the status toolbar at the bottom of the Ryujinx window.
|
||||
|
||||
|
||||
**Option 3:**
|
||||
1. Use Option 1 and select "Stretch to Fit Window" or Option 2 and select "Stretched".
|
||||
#### Method 3
|
||||
|
||||
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!
|
||||
|
||||
## 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.**
|
||||
|
||||
To enable *Portable Mode*
|
||||
### Enable *Portable Mode*
|
||||
|
||||
**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.).
|
||||
### Method 1: Create a "portable" subfolder
|
||||
|
||||
**Recommended method**
|
||||
|
||||
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
|
||||
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"
|
||||
### Method 2: Command-line
|
||||
|
||||
|
||||
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:
|
||||
```
|
||||
ryujinx.exe -r D:\ryujinxdata
|
||||
```
|
||||
|
||||
|
||||
|
||||
The command prompt window will become the console window when Ryujinx launches.
|
||||
|
||||
**Option 3:** Custom Shortcut
|
||||
### Method 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]` 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`.
|
||||
|
||||
|
||||
|
||||
|
||||
Note: On MacOS, the command would be as follows, without the quotes:
|
||||
"/Applications/Ryujinx.app/Contents/MacOS/Ryujinx -r /path/to/custom/ryujinx/folder"
|
||||
On MacOS, the command would be `/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
|
||||
|
||||
Ryujinx can automatically launch games in fullscreen mode. You can enable this functionality in one of two ways:
|
||||
|
||||
**Method One:** In Ryujinx, click on Options, then check the box marked "Start Games in Fullscreen Mode".
|
||||
### Method 1
|
||||
In Ryujinx, click on Options, then check the box marked "Start Games in Fullscreen Mode".
|
||||
|
||||
|
||||
|
||||
|
||||
**Method Two:** If you launch Ryujinx from the commandline, add a --fullscreen option. Like so:
|
||||
|
||||
|
||||
### Method 2
|
||||
If you launch Ryujinx from the commandline, add a --fullscreen option. Like so:
|
||||
|
||||
Loading…
Reference in a new issue