Updated Frequently Asked Questions (markdown)

MetrosexualGarbodor 2022-12-08 17:33:53 +00:00
parent 49f73aa7d7
commit d8c7fce32d

@ -1,58 +1,48 @@
<details>
<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>
<details>
<summary><h3>🕹 Do I need a Switch to use this emulator?</h3></summary>
<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>
<details>
<summary><h3>💾 Where can I download games?</h3></summary>
<pre>We do not support piracy. It is forbidden to request copyrighted content (Firmware/Games/Keys/Shaders) here or on the Ryujinx Discord.<br>
You can download games here: <a href="https://www.nintendo.com/store/games/nintendo-switch-games/" target="_blank">Nintendo eShop</a> and dump them.
</pre>
</details>
<details>
<summary><h3>🕹 Does Ryujinx support <i>X 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.
</pre>
</details>
<details>
<summary><h3>🧩 Are game mods & cheats 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>
<details>
<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>
<details>
<summary><h3>🍎 Can I run Ryujinx on macOS?</h3></summary>
<pre>Yes! See our <a href="https://ryujinx.org/download" target="_blank">main website</a> to download a build for macOS (Intel & Apple Silicon).
</pre>
</details>
<details>
<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>
<details>
<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>
@ -60,9 +50,7 @@ Someone will take a look and give you some pointers on what's going wrong.<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>
<details>
<summary><h3>❤ How can I support Ryujinx?</h3></summary>
<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>
@ -71,75 +59,54 @@ If you are a developer there are <b>Good First Issues</b> listed on the Ryujinx
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>
<details>
<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 "GShade".<br>
Additionally, be sure your GPU driver settings are set to defaults for Ryujinx.
</pre>
</details>
<details>
<summary><h3>💾 How can I dump games?</h3></summary>
<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>
<details>
<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>
<details>
<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>
<details>
<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.
</pre>
</details>
<details>
<summary><h3>🔈 I'm getting a "SoundIOException" or "No valid channel configuration found!"?</h3></summary>
<pre>It's due to a bad implementation of our audio backend.<br>
You can fix it by using SDL2 or OpenAL backend by selecting SDL2 OR OpenAL as the audio backend in "Options" > "Settings" > "System" tab.
</pre>
</details>
<details>
<summary><h3>🐢 I'm getting slow FPS, how can I increase it?</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 GPU Backend logging or Debug logging in "Options" > "Settings" > "Logging" tab.
</pre>
</details>
<details>
<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>
<details>
<summary><h3>👥 What is needed to use the 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>
<details>
<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>