mirror of
https://github.com/GreemDev/Ryujinx.git
synced 2024-11-22 12:08:35 +00:00
Replaced all gtk screenshots with ava screenshots and added various missing changes from 1.2.0 onwards.
GabCoolGuy
parent
411786503d
commit
cf16a8e122
1 changed files with 314 additions and 269 deletions
|
|
@ -116,15 +116,17 @@ 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!)
|
||||
|
||||
|
||||
3. Click *OK* on the warning box.\
|
||||
|
||||
|
||||
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.
|
||||
|
||||
4. Click *File* at the top left of the *Ryujinx* window, and then click
|
||||
*Open Ryujinx* *Folder*.\
|
||||
|
||||
*Open Ryujinx* *Folder*.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Navigate down into the system subfolder and paste your prod.keys file
|
||||
|
|
@ -133,7 +135,8 @@ By default Ryujinx will use `%appdata%/Ryujinx` (or the equivalent application d
|
|||
|
||||
|
||||
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
|
||||
==================================================
|
||||
|
|
@ -146,32 +149,29 @@ dumped, or have compiled your [dumped firmware](https://github.com/Ryujinx/Ryuji
|
|||
you still get the warning, go back through the prod.keys steps and
|
||||
ensure you have placed the file correctly.
|
||||
|
||||
2. Now that *Ryujinx* is open, click *Tools \> Firmware \> Install from
|
||||
2. Now that *Ryujinx* is open, click *Tools \> Install 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
|
||||
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
|
||||
============================
|
||||
|
|
@ -179,30 +179,33 @@ Adding Your Games to Ryujinx
|
|||
You have keys and firmware ready to go. Time to add your games!
|
||||
|
||||
With *Ryujinx* open, click on *Options \> Settings*. This takes you
|
||||
straight to the *General* tab.\
|
||||
|
||||
straight to the *User Interface* tab.\
|
||||
|
||||
|
||||
|
||||
There are two different methods in which you can add a Game Directory in this window.\
|
||||
\
|
||||
**1st Method:**\
|
||||
Type the absolute path of the folder containing your games into the path
|
||||
field and click *Add*.\
|
||||
\
|
||||
|
||||
|
||||
\
|
||||
**2nd Method:**\
|
||||
Without typing anything into the path field, click *Add*.\
|
||||
\
|
||||
|
||||
|
||||
\
|
||||
This brings up the 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*.\
|
||||
|
||||
|
||||
|
||||
|
||||
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.\
|
||||
|
||||
|
||||
|
||||
Managing Game Updates
|
||||
=====================
|
||||
|
|
@ -213,113 +216,183 @@ 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.
|
||||
|
||||
1. In the main *Ryujinx* game list right-click the game you want to
|
||||
apply an update to. Then click *Manage Title Updates*.\
|
||||
\
|
||||
## Autoadd Game Updates
|
||||
|
||||
Since version 1.2.0, *Ryujinx* supports automatically adding and assigning game updates.
|
||||
|
||||
1. Go to **Options > Settings**\
|
||||
|
||||
|
||||
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).
|
||||
|
||||
If you add multiple updates in one go with this method, *Ryujinx* will automatically choose the highest version.
|
||||
|
||||
## Managing Game Updates
|
||||
|
||||
1. In the main *Ryujinx* game list, right-click the game you want to manage Game Updates for.
|
||||
Then click **Manage Title Updates**.\
|
||||
\
|
||||
\
|
||||
After clicking *Manage Title Updates*, you will see the *Ryujinx --
|
||||
After clicking *Manage Title Updates*, you will see the *Ryujinx -
|
||||
Title Update Manager* menu.
|
||||
|
||||
2. In the *Ryujinx -- Title Update Manager* menu, click *Add*.\
|
||||
|
||||
If you want to add a game update file, go to step 2.
|
||||
|
||||
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*.
|
||||
If you **do not** want to add a game update file, go to step 4.
|
||||
|
||||
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*.\
|
||||
|
||||
2. Click **Add**\
|
||||
|
||||
|
||||
5. 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
|
||||
process for any other games you wish to apply updates to.
|
||||
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**.\
|
||||
|
||||
|
||||
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
|
||||
|
||||
Some games have downloadable content available that you may wish to add
|
||||
to your game. *Ryujinx* has built-in functionality to add & manage your
|
||||
DLC.
|
||||
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.
|
||||
|
||||
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.\
|
||||
|
||||
## Autoadd DLC
|
||||
|
||||
2. Within the *Ryujinx -- DLC Manager* window, click *Add* to open the
|
||||
DLC navigation screen.\
|
||||
|
||||
Since 1.2.0, *Ryujinx* supports automatically adding and assigning DLC.
|
||||
|
||||
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*.\
|
||||
**Note: you may add more than one DLC file at a time!**\
|
||||
|
||||
1. Go to **Options > Settings**\
|
||||
|
||||
|
||||
4. You will now see your DLC in the *Ryujinx - DLC Manager* window.
|
||||
**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.**
|
||||
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).
|
||||
|
||||
If you add multiple DLCs in one go with this method,
|
||||
*Ryujinx* will automatically enable every DLC for each game.
|
||||
|
||||
## Managing DLC
|
||||
|
||||
Managing Downloadable Content includes,
|
||||
removing, adding and selecting which DLC you want.
|
||||
|
||||
1. In the main *Ryujinx* game list,
|
||||
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 **do not** want to add a game update file, go to step 4.
|
||||
|
||||
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**.\
|
||||
\
|
||||
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.
|
||||
|
||||
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
|
||||
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/Ryujinx/pull/1249)**.
|
||||
## Using the Mod Manager
|
||||
|
||||
To enable mods:
|
||||
*Ryujinx* has a built-in **Mod Manager** that can
|
||||
very easily be used to enable, disable, add and remove mods.
|
||||
|
||||
1. With _Ryujinx_ open, right-click on the game you wish to manage mods for and click _Open Mods Directory_.
|
||||
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.
|
||||
|
||||
|
||||
|
||||
## Manually Adding Mods (NOT RECOMMENDED)
|
||||
|
||||
**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**.\
|
||||
\
|
||||
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 with a name that fits
|
||||
the mod you'll be using. Then, place the ExeFS
|
||||
and RomFS of the mod inside that folder.\
|
||||
|
||||
|
||||
|
||||
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).
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
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
|
||||
===============
|
||||
|
||||
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
|
||||
Ryujinx fully supports Atmosphere style cheats (except game pausing/resume): [Atmosphere's cheats doc](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)
|
||||
- [EdiZon](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:
|
||||
|
||||
|
|
@ -331,52 +404,29 @@ Where `0123456789ABCDEF` will vary according to the game and the cheat (this is
|
|||
|
||||
To install the cheat:
|
||||
|
||||
- Open Ryujinx, right-click the game you wish to install the cheat and select to open its `Mod directory`;
|
||||
- A directory like this will open: `Ryujinx\mods\contents\XXXXXXXXXXXXXXXX\`, `XXXXXXXXXXXXXXXX` will be the id of the chosen game;
|
||||
- Extract the cheat archive to the mod directory, keeping the cheat name: `Ryujinx\mods\contents\XXXXXXXXXXXXXXXX\Cheat_Name\cheats\<all the txt files>`.
|
||||
1. Open Ryujinx, right-click the game you wish to
|
||||
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.\
|
||||
|
||||
|
||||
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
|
||||
|
||||
Currently, all cheats are automatically enabled and cannot be disabled, so mixing, for instance, 60, 90 and 120 fps cheats may cause a conflict.
|
||||
In Ryujinx, cheats are all automatically disabled, so you need to enable them in the Ryujinx UI to be able to use them.
|
||||
|
||||
One alternative is to create a directory `disabled_cheats` in the mod directory and move all unused cheats there. Another one is to prepend something to the file name, for instance `off_0123456789ABCDEF.txt` as a valid cheat must not have anything but `0123456789ABCDEF.txt` in its name.
|
||||
To do so, start by right-clicking a game and clicking on **"Manage Cheats"**\
|
||||
|
||||
|
||||
The .txt files can also contain several cheats that may conflict. To switch off individual cheats inside a .txt file first **backup the .txt file** to something like `bak_0123456789ABCDEF.txt` (this will also prevent the backup to be loaded as a cheat). Next, in the .txt file, there will be sections, each with a name within `[ ]` brackets and filled with sequences of letters and numbers (the code of the cheat), for instance:
|
||||
|
||||
```
|
||||
[New Super Mario Bros. U Deluxe]
|
||||
|
||||
[Start with 99 Lives]
|
||||
58000000 00CC9860
|
||||
78000000 0002A1C0
|
||||
61000000 00000000 00000063
|
||||
|
||||
[Time = 999]
|
||||
58000000 00C88A70
|
||||
78001000 00000090
|
||||
64000000 00000000 003E6F00
|
||||
|
||||
[Start as Penguin]
|
||||
58000000 00CC9860
|
||||
78000000 0002A1C4
|
||||
61000000 00000000 00000005
|
||||
```
|
||||
|
||||
To disable the time cheat, just remove its section and the code:
|
||||
|
||||
```
|
||||
[New Super Mario Bros. U Deluxe]
|
||||
|
||||
[Start with 99 Lives]
|
||||
58000000 00CC9860
|
||||
78000000 0002A1C0
|
||||
61000000 00000000 00000063
|
||||
|
||||
[Start as Penguin]
|
||||
58000000 00CC9860
|
||||
78000000 0002A1C4
|
||||
61000000 00000000 00000005
|
||||
```
|
||||
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.
|
||||
|
||||
Managing User Profiles
|
||||
=====================
|
||||
|
|
@ -384,48 +434,52 @@ 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.
|
||||
|
||||
### 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, simply select it and type in the new text.
|
||||
|
||||
2. To rename a profile, hover over the profile and click the editing icon.\
|
||||
|
||||
|
||||
3. To change the profile image, select the profile in the list and click **Change Profile Image**.
|
||||
|
||||
You can then edit the name of the profile.
|
||||
|
||||
You will then be prompted to select from either a custom image, or from one of the many avatars provided in the firmware.
|
||||
|
||||
|
||||
|
||||
3. To change the profile image, hover over the profile and click the editing icon.\
|
||||
|
||||
|
||||
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.\
|
||||
|
||||
|
||||
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**
|
||||
|
||||
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:
|
||||
|
||||
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 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.
|
||||
|
||||
|
||||
To set a profile picture, just click on Set Profile Image and 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!
|
||||
|
||||
|
||||
Input Configuration
|
||||
===================
|
||||
|
|
@ -436,55 +490,44 @@ carefully!
|
|||
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.\
|
||||
|
||||
|
||||
|
||||
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***
|
||||
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.**
|
||||
|
||||
*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)**\
|
||||
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.
|
||||
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.\
|
||||
|
||||
|
||||
|
||||
4. Click *Configure* under *Player 1* if you have enabled *Docked
|
||||
Mode*, or click configure *Handheld* if you have not enabled *Docked
|
||||
Mode*.\
|
||||
|
||||
|
||||
5. 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/).\
|
||||
|
||||
|
||||
|
||||
6. 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
|
||||
*Default*, and click *Load*. This populates the buttons with preset
|
||||
mappings for your Xinput-compatible (or Xinput wrapped/translated)
|
||||
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.
|
||||
|
||||
\
|
||||
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
|
||||
|
|
@ -494,57 +537,60 @@ better graphical fidelity on games that support these features.\
|
|||
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 Save to save your configuration.***
|
||||
|
||||
Alternately, you may skip the input UI and edit your config.json file
|
||||
found in %appdata%\\ryujinx\\
|
||||
7. ***Click Apply and then OK to save your configuration.***
|
||||
|
||||
Motion Controls
|
||||
===============
|
||||
### Motion Controls
|
||||
|
||||
Ryujinx offers the ability to use motion controls with motion-enabled controllers such as a Switch Pro Controller, Joycons, Playstation DS4, smartphones with motion support, Steam controller, and others.
|
||||
Ryujinx offers the ability to **natively** use motion controls with
|
||||
motion-enabled controllers such as a Switch Pro Controller, DS4, DS5, DSE and others.
|
||||
|
||||
To use motion controls in Ryujinx:
|
||||
## Native motion controls
|
||||
|
||||
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.
|
||||
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**.\
|
||||
|
||||
|
||||
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.
|
||||
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*.
|
||||
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.
|
||||
|
||||
3. Select your motion controller from the dropdown. It will be listed as "Xinput controller".
|
||||
## Cemuhook motion controls
|
||||
|
||||
|
||||
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.
|
||||
|
||||
4. Configuration options:
|
||||
Cemuhook is also needed to use a joycon pair, since it can group 2 controllers under 1.
|
||||
|
||||
- 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:
|
||||
To fix this, we can use cemuhook:
|
||||
|
||||
**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
|
||||
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.**\
|
||||
|
||||
|
||||
- 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.
|
||||
3. Select your motion controller from the dropdown. It will be listed as **"Xinput controller"**, **"Xbox 360 Controller"** or **"Xbox One Controller"**.\
|
||||
|
||||
|
||||
**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:
|
||||
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.
|
||||
|
||||
|
||||
6. Click **Save** to save your configurations.
|
||||
|
||||
|
||||
5. Click Save to save your configuration.
|
||||
|
||||
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
|
||||
================
|
||||
|
|
@ -553,10 +599,14 @@ All Amiibo are able to be virtually scanned within the emulator, as long as you
|
|||
|
||||
**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".
|
||||
|
||||
|
||||
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
|
||||
|
|
@ -566,8 +616,8 @@ Speed up game loading times with PPTC
|
|||
|
||||
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
|
||||
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**
|
||||
|
|
@ -578,28 +628,27 @@ game.
|
|||
PPTC (Profiled Persistent Translation Cache) is now enabled by default. To disable it:
|
||||
|
||||
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*\
|
||||
|
||||
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.
|
||||
|
||||
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:
|
||||
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_ > _Open PPTC Directory_\
|
||||
|
||||
|
||||
|
||||
3. You can then select the folders and delete them.\
|
||||
|
||||
|
||||
Graphics Enhancements
|
||||
=====================
|
||||
|
|
@ -625,11 +674,13 @@ _anti-aliased texture filtering._
|
|||
**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.
|
||||
|
||||
|
||||
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.**
|
||||
|
||||
**To enable _Anisotropic Filtering_:**
|
||||
|
||||
|
|
@ -637,14 +688,14 @@ _anti-aliased texture filtering._
|
|||
**games.**
|
||||
|
||||
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.\
|
||||
|
||||
\
|
||||
**Click *Save*** to save the enhancement setting.
|
||||
*Anisotropic Filtering*. Set it to your desired level.
|
||||
|
||||
|
||||
|
||||
**Click *Apply* and then *OK* to save the settings.**
|
||||
|
||||
**To Manage _Shader Cache_:**
|
||||
**Shader Cache is enabled by default**. There are no good reasons to disable it other than for testing purposes.
|
||||
|
|
@ -656,27 +707,26 @@ Disabling this setting is strongly discouraged. However, if you absolutely must
|
|||
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
|
||||
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.
|
||||
|
||||
- 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.
|
||||
|
||||
- With your game running, click on the aspect ratio button in the status toolbar at the bottom of the Ryujinx window.\
|
||||
|
||||
|
||||
**Option 3:**
|
||||
**Option 3 (NOT RECOMMENDED):**
|
||||
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!
|
||||
|
|
@ -691,30 +741,26 @@ If you wish, you may use a custom folder location for all Ryujinx data (as oppos
|
|||
To 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.).
|
||||
|
||||
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
|
||||
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"
|
||||
|
||||
|
||||
"ryujinx.exe -r d:\ryujinxdata"\
|
||||
|
||||
|
||||
The command prompt window will become the console window when Ryujinx launches.
|
||||
|
||||
**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"
|
||||
|
|
@ -726,10 +772,9 @@ 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 One:** 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 Two:** If you launch Ryujinx from the commandline, add a --fullscreen option. Like so:\
|
||||
|
||||
Loading…
Reference in a new issue