Mirror/Ryujinx
3
5
Fork 13
mirror of https://github.com/Ryujinx/Ryujinx.git synced 2024-11-20 03:26:34 +00:00
Code Issues Projects Releases Packages Wiki Activity

Updated Frequently Asked Questions (markdown)

Ac_K 2022-11-22 03:09:05 +01:00
parent 0b91eb088b
commit f6e46f2b74
1 changed files with 156 additions and 67 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

223
Frequently-Asked-Questions.md

@ -1,93 +1,182 @@
* ### Where can I get Ryujinx?<br> <details>
You can get the latest version from our website: https://ryujinx.org/download/ <summary><h3>🕹 Where can I get Ryujinx?</h3></summary>
<pre>You can get the latest version from our website: <a href="https://ryujinx.org/download/" target="_blank">https://ryujinx.org/download/</a></pre>
</details>
* ### Do I need a switch to use this emulator?<br> <details>
Yes, you need a hacked switch to dump games and your system keys.<br> <summary><h3>🕹 Do I need a Switch to use this emulator?</h3></summary>
If you don't have a switch you can only run homebrew applications. <pre>Yes, you need a hacked Switch to dump games and your system keys.<br>
If you don't have a switch you can only run homebrew applications.
</pre>
</details>
* ### Where can I download games?<br> <details>
We do not support piracy here. It is forbidden to request copyrighted content here (Firmwares/Games/Keys). <summary><h3>💾 Where can I download games?</h3></summary>
<pre>We do not support piracy here. It is forbidden to request copyrighted content here (Firmwares/Games/Keys).<br>
You can download games here: <a href="https://www.nintendo.com/store/games/nintendo-switch-games/" target="_blank">Nintendo eShop</a>
</pre>
</details>
* ### Does Ryujinx support (game)?<br> <details>
Some games are untested or the tests are out of date; you can find compatibility reports here: https://github.com/Ryujinx/Ryujinx-Games-List/issues <br> <summary><h3>🕹 Does Ryujinx support <i>game</i>?</h3></summary>
<pre>Some games are untested or the tests are out of date; you can find compatibility reports here: <a href="https://github.com/Ryujinx/Ryujinx-Games-List/issues" target="_blank">Ryujinx-Games-List</a><br>
If you wish to contribute you can open a new issue if the game has never been added, or you can add a comment on the game's issue for it to be merged into the top post. If you wish to contribute you can open a new issue if the game has never been added, or you can add a comment on the game's issue for it to be merged into the top post.
</pre>
</details>
* ### Are game mods currently supported in Ryujinx?<br> <details>
Yes, see https://github.com/Ryujinx/Ryujinx/wiki/Ryujinx-Setup-&-Configuration-Guide#managing-mods for more details. <summary><h3>🧩 Are game mods currently supported in Ryujinx?</h3></summary>
<pre>Yes, see <a href="https://github.com/Ryujinx/Ryujinx/wiki/Ryujinx-Setup-&-Configuration-Guide#managing-mods" target="_blank">Ryujinx-Setup-&-Configuration-Guide#managing-mods</a> for more details.
</pre>
</details>
* ### Is Vulkan currently supported in Ryujinx?<br> <details>
Yes! As of July 2022, Vulkan support is included in the main build of the emulator. On first-run, the emulator will pop up a message asking you if you'd like to use Vulkan or OpenGL. We recommend using Vulkan in all cases unless there is a Vulkan-specific bug in the game you're playing that is not present on OpenGL. <summary><h3>🖼 Is Vulkan currently supported in Ryujinx?</h3></summary>
<pre>Yes! As of July 2022, Vulkan support is included in the main build of the emulator.<br>
On first-run, the emulator will pop up a message asking you if you'd like to use Vulkan or OpenGL.<br>
We recommend using Vulkan in all cases unless there is a Vulkan-specific bug in the game you're playing that is not present on OpenGL.
</pre>
</details>
* ### Can I run Ryujinx on macOS?<br> <details>
macOS support is currently very experimental. This is due to limited OpenGL support in macOS, which is something that is out of our control. When Vulkan is supported we may be able to make more progress here. For now, you are able to use Boot Camp to run the Windows version of Ryujinx. <summary><h3>🍎 Can I run Ryujinx on macOS?</h3></summary>
<pre>macOS support is currently very experimental. This is due to limited OpenGL support in macOS, which is something that is out of our control.<br>
When Vulkan is supported we may be able to make more progress here. For now, you are able to use Boot Camp to run the Windows version of Ryujinx.
</pre>
</details>
* ### My game runs really slowly for me. What can I do to increase the FPS?<br> <details>
Ryujinx is still in the early stages of development. Over time, new updates will gradually increase performance. For now, the biggest contributor to performance in Ryujinx is a fast, high clock-speed CPU. As for GPUs, a GTX 1050 or better should be perfectly adequate (at least in the long term) to play nearly any Nintendo Switch game. <summary><h3>🐢 My game runs really slowly for me. What can I do to increase the FPS?</h3></summary>
<pre>Ryujinx is still in the early stages of development. Over time, new updates will gradually increase performance.<br>
For now, the biggest contributor to performance in Ryujinx is a fast, high clock-speed CPU.<br>
As for GPUs, a GTX 1050 or better should be perfectly adequate (at least in the long term) to play nearly any Nintendo Switch game.
</pre>
</details>
* ### What should I do if I'm having trouble with Ryujinx or found a bug?<br> <details>
Provide a detailed explanation of the issue, tell us which build number you're using, and upload a Ryujinx.log file in the #support channel on our Discord. Someone will take a look and give you some pointers on what's going wrong. <br><br> If you've found a bug, please upload a screenshot and a save file, along with an explanation on how to reproduce the issue. This allows our developers to quickly examine potential bugs. <summary><h3>🐛 What should I do if I'm having trouble with Ryujinx or found a bug?</h3></summary>
<pre>Provide a detailed explanation of the issue, tell us which build number you're using, and upload a Ryujinx.log file in the #support channel on our Discord.<br>
Someone will take a look and give you some pointers on what's going wrong.<br>
<br>
If you've found a bug, please upload a screenshot and a save file, along with an explanation on how to reproduce the issue.<br>
This allows our developers to quickly examine potential bugs.
</pre>
</details>
* ### How can I support Ryujinx?<br> <details>
There are many ways to support Ryujinx. You can support us through Patreon (https://www.patreon.com/ryujinx) or you can boost the Discord server with Discord Nitro. If you know how to help somebody in #support (on our Discord) you can help us by answering questions there.<br><br>If you are a developer there are Good First Issues listed on the Ryujinx GitHub (https://github.com/Ryujinx/Ryujinx/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).<br> <summary><h3>❤ How can I support Ryujinx?</h3></summary>
We do encourage you talk to some devs in #development (on our Discord) before developing any PRs so we can make sure you aren't conflicting with another dev's plans, and so we can help you get accustomed to our code base and methods. <pre>There are many ways to support Ryujinx.<br>
You can support us through Patreon (<a href="https://www.patreon.com/ryujinx" target="_blank">patreon.com/ryujinx</a>) or you can boost the Discord server with Discord Nitro.<br>
If you know how to help somebody in #support (on our Discord) you can help us by answering questions there.<br><br>
If you are a developer there are <b>Good First Issues</b> listed on the Ryujinx GitHub (<a href="https://github.com/Ryujinx/Ryujinx/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22" target="_blank">here</a>).<br>
We do encourage you talk to some devs in #development (on our Discord) before developing any PRs.<br>
Then we can make sure you aren't conflicting with another dev's plans, and so we can help you get accustomed to our code base and methods.
</pre>
</details>
* ### What should I do if Ryujinx is just showing a black screen?<br> <details>
First, make sure that the game you are trying to run is actually supported and that your graphics card is capable of running it. Once you've done that, make sure that any external application that could affect the rendering is disabled. This includes things like the **MSI Afterburner** overlay, which puts an overlay on top of the emulator display window. Additionally, be sure your GPU driver settings are set to defaults for Ryujinx. <summary><h3>⬛ What should I do if Ryujinx is just showing a black screen?</h3></summary>
<pre>First, make sure that the game you are trying to run is actually supported and that your graphics card is capable of running it.<br>
Once you've done that, make sure that any external application that could affect the rendering is disabled.<br>
This includes things like the "MSI Afterburner" overlay, which puts an overlay on top of the emulator display window.<br>
Additionally, be sure your GPU driver settings are set to defaults for Ryujinx.
</pre>
</details>
* ### How can I dump games?<br> <details>
A hacked Nintendo Switch is needed to dump games, which you can learn how to do here: https://nh-server.github.io/switch-guide/.<br> <summary><h3>💾 How can I dump games?</h3></summary>
Once you have hacked your Switch, you can dump your games to get an XCI or NSP file with this homebrew: https://github.com/DarkMatterCore/nxdumptool/releases <pre>A hacked Nintendo Switch is needed to dump games, which you can learn how to do here: <a href="https://nh-server.github.io/switch-guide/" target="_blank">NH-Server Switch Guide</a>.<br>
Once you have hacked your Switch, you can dump your games to get an XCI or NSP file with this homebrew: <a href="https://github.com/DarkMatterCore/nxdumptool/releases" target="_blank">NxDumpTool</a>.
</pre>
</details>
* ### Can I extract data from a game using Ryujinx?<br> <details>
Once you have set a games folder and your Switch keys properly, just right click on a game to extract the chosen section to a folder. <summary><h3>📦 Can I extract data from a game using Ryujinx?</h3></summary>
<pre>Once you have set a games folder and your Switch keys properly, just right click on a game to extract the chosen section to a folder.
</pre>
</details>
* ### How do I install System Data Archives? Why are they needed?<br> <details>
Some of our System Module implementations, such as time, require System Data Archives. You can get them by installing a Switch firmware from a game through our Firmware Installer, which can be found by clicking on the Install Firmware option in the Tools menu in the GUI.<br> <summary><h3>📦 How do I install System Data Archives? Why are they needed?</h3></summary>
Alternatively, you can install them manually by mounting your nand partition using `HacDiskMount` and copying the content to `Ryujinx/bis/system`. <pre>Some of our System Module implementations, such as time, require System Data Archives.<br>
You can get them by installing a Switch firmware from a game through our Firmware Installer.<br>
which can be found by clicking on the Install Firmware option in the Tools menu in the GUI.<br>
Alternatively, you can install them manually by mounting your nand partition using "HacDiskMount" and copying the content to "Ryujinx/bis/system".
</pre>
</details>
* ### Do I need to install shared fonts? Where I can get them?<br> <details>
If you are getting an error about shared fonts, just install a Switch firmware from a game or from one you've dumped from your Switch with Goldleaf through our Firmware Installer, which can be found by clicking on the `Install Firmware` option in the `Tools` menu in the GUI. <summary><h3>🔠 Do I need to install shared fonts? Where I can get them?</h3></summary>
<pre>If you are getting an error about shared fonts, just install a Switch firmware<br>
From a game or from one you've dumped from your Switch with "Goldleaf" through our "Firmware Installer".<br>
Which can be found by clicking on the "Install Firmware" option in the "Tools" menu in the GUI.
</pre>
</details>
* ### Where can I find a game's save files?<br> <details>
Once you have set a games folder and your Switch keys properly, just right click on a game and select `Open Save Directory` or `Open Device Save Directory`.<br> <summary><h3>💾 Where can I find a game's save files?</h3></summary>
<pre>Once you have set a games folder and your Switch keys properly<br>
just right click on a game and select "Open Save Directory" or "Open Device Save Directory".<br>
You can then copy the save files in the opened folder and paste them somewhere else. You can then copy the save files in the opened folder and paste them somewhere else.
</pre>
</details>
* ### I'm getting a `SoundIOSharp.SoundIOException` error or 'No valid channel configuration found!'. What should I do?<br> <details>
It's due to a bad implementation of our audio backend.<br> <summary><h3>🔈 I'm getting a "SoundIOSharp.SoundIOException" error or "No valid channel configuration found!". What should I do?</h3></summary>
You can fix it by installing OpenAL, which can be found here: https://www.openal.org/downloads/oalinst.zip and then selecting OpenAL as the audio backend in Options > Settings > System tab. <pre>It's due to a bad implementation of our audio backend.<br>
You can fix it by using SDL2 backend OR installing OpenAL, which can be found here: <a href="https://www.openal.org/downloads/oalinst.zip" target="_blank">oalinst.zip</a><br>
Then selecting SDL2 OR OpenAL as the audio backend in "Options" > "Settings" > "System" tab.
</pre>
</details>
* ### I'm getting slow FPS, how can I increase it?<br> <details>
If your game is slow, you may need to get a better PC or wait for emulator optimizations. Also ensure that you have not mistakenly enabled opengl logging or debug logging in Options > Settings > Logging tab. Make sure those are disabled! <summary><h3>🐢 I'm getting slow FPS, how can I increase it?</h3></summary>
<pre>It's a normal behavior, so you don't have to worry about it. It's just an internal error of the emulator.
</pre>
</details>
* ### I get the error Process initialization returned error `InvalidMemRange`. What should I do?<br> <details>
It's a normal behavior, so you don't have to worry about it. It's just an internal error of the emulator. <summary><h3>⚠ I get the error Process initialization returned error "InvalidMemRange". What should I do?</h3></summary>
<pre>If your game is slow, you may need to get a better PC or wait for emulator optimizations.<br>
Also ensure that you have not mistakenly enabled OpenGL logging or Debug logging in "Options" > "Settings" > "Logging" tab. Make sure those are disabled!
</pre>
</details>
* ### My game is not looking good, and it's all glitched!<br> <details>
If you have an onboard Intel GPU, many 3D games exhibit graphical issues. Update your drivers from Intel or use another GPU in your PC if possible. <summary><h3>⚠ My game is not looking good, and it's all glitched!</h3></summary>
<pre>If you have an onboard Intel GPU, many 3D games exhibit graphical issues.<br>
Update your drivers from Intel or use another GPU in your PC if possible.
</pre>
</details>
* ### I get the error "returned error PortRemoteClosed". What should I do?<br> <details>
It's a normal behavior, so you don't have to worry about it. It's just an internal error of the emulator. <summary><h3>⚠ I get the error "returned error PortRemoteClosed". What should I do?</h3></summary>
<pre>It's a normal behavior, so you don't have to worry about it.<br>
It's just an internal error of the emulator.
</pre>
</details>
* ### I have no idea what I'm doing. How do I Ryujinx?<br> <details>
Follow the Ryujinx Setup & Configuration Guide: https://github.com/Ryujinx/Ryujinx/wiki/Ryujinx-Setup-&-Configuration-Guide or see the Readme: https://github.com/Ryujinx/Ryujinx/blob/master/README.md . If you are still having trouble, please come to #support on our Discord Server and we will be happy to assist. <summary><h3>💡 I have no idea what I'm doing. How do I Ryujinx?</h3></summary>
<pre>Follow the Ryujinx Setup & Configuration Guide: <a href="https://github.com/Ryujinx/Ryujinx/wiki/Ryujinx-Setup-&-Configuration-Guide" target="_blank">Ryujinx-Setup-&-Configuration-Guide</a> or see the Readme: <a href="https://github.com/Ryujinx/Ryujinx/blob/master/README.md" target="_blank">README.md</a>.<br>
If you are still having trouble, please come to #support on our Discord Server and we will be happy to assist.
</pre>
</details>
* ### Ryujinx crashes with an error about "NAX0 key derivation failed".<br> <details>
Delete everything in `(your user folder)\appdata\roaming\ryujinx\sdcard\nintendo\save` <summary><h3>⚠ Ryujinx crashes with an error about "NAX0 key derivation failed".</h3></summary>
<pre>Delete everything in "(your user folder)\appdata\roaming\ryujinx\sdcard\nintendo\save".
</pre>
</details>
* ### What is needed to use the new Multiplayer function?<br> <details>
See the Multiplayer Guide here: https://github.com/Ryujinx/Ryujinx/wiki/Multiplayer-(LDN-Local-Wireless)-Guide and the New Horizons Renamer guide (only necessary if you still have the default player name/town name from our Patreon save file) here: https://github.com/Ryujinx/Ryujinx/wiki/How-to-Change-Your-Player-Name-and-Town-Name-with-Animal-Crossing:-New-Horizons-Renamer <summary><h3>👥 What is needed to use the new Multiplayer function?</h3></summary>
<pre>See the Multiplayer Guide here: <a href="https://github.com/Ryujinx/Ryujinx/wiki/Multiplayer-(LDN-Local-Wireless)-Guide" target="_blank">Multiplayer-(LDN-Local-Wireless)-Guide</a>.
</pre>
</details>
* ### Can I use Ryujinx in portable mode?<br> <details>
Yes! See the portable mode quick reference guide here: https://github.com/Ryujinx/Ryujinx/wiki/Ryujinx-Setup-&-Configuration-Guide#portable-mode <summary><h3>💼 Can I use Ryujinx in portable mode?</h3></summary>
<pre>Yes! See the portable mode quick reference guide here: <a href="https://github.com/Ryujinx/Ryujinx/wiki/Ryujinx-Setup-&-Configuration-Guide#portable-mode" target="_blank">Ryujinx-Setup-&-Configuration-Guide#portable-mode</a>.
*** </pre>
</details>
* ### ACNH - I am stuck on the loading screen of the game!<br>
Either wait 10 minutes for the game to load, or restart the emulator and see if it gets fixed. If not, be sure you use the provided save file and that it's well extracted.<br>
Read the Patreon post at: https://www.patreon.com/posts/animal-crossing-35196813 for more info!
* ### ACNH - My game shows the loading screen with the island and then crashes!<br>
Read the Patreon post at: https://www.patreon.com/posts/animal-crossing-35196813
* ### ACNH - How can I rename my character when using a save file?<br>
You can use a save file editor or the [New Horizons Renamer](https://github.com/Ryujinx/Ryujinx/wiki/How-to-Change-Your-Player-Name-and-Town-Name-with-Animal-Crossing:-New-Horizons-Renamer) if your game version is 1.4.2 or earlier. Alternately, you can try starting the game without the provided save file but as stated above, a crash may occur.