35443bac5a
* Update README.md Improve grammar, replace Switch hacking guide with one that's more up-to-date, and add a guide for shared font dumping * Update README.md * Remove shared fonts section |
||
|---|---|---|
| .github | ||
| ARMeilleure | ||
| ChocolArm64 | ||
| Ryujinx | ||
| Ryujinx.Audio | ||
| Ryujinx.Common | ||
| Ryujinx.Graphics | ||
| Ryujinx.HLE | ||
| Ryujinx.LLE | ||
| Ryujinx.Profiler | ||
| Ryujinx.ShaderTools | ||
| Ryujinx.Tests | ||
| Ryujinx.Tests.Unicorn | ||
| .gitattributes | ||
| .gitignore | ||
| .travis.yml | ||
| appveyor.yml | ||
| CONFIG.md | ||
| KEYS.md | ||
| LICENSE.txt | ||
| README.md | ||
| Ryujinx.sln | ||
| Ryujinx.sln.DotSettings | ||
Ryujinx
An Experimental Switch emulator written in C#
A lot of games boot, but only some are playable. See the compatiblity list here.
Usage
To run this emulator, you need the .NET Core 2.1 (or higher) SDK.
If you use a pre-built version, you can use the graphical interface to run your games and homebrew.
If you build it yourself you will need to:
Run dotnet run -c Release -- path\to\homebrew.nro inside the Ryujinx project folder to run homebrew apps.
Run dotnet run -c Release -- path\to\game.nsp/xci to run official games.
Every file related to Ryujinx is stored in the RyuFs folder. Located in C:\Users\USERNAME\AppData\Roaming\ for Windows, /home/USERNAME/.config for Linux or /Users/USERNAME/Library/Application Support/ for macOS. It can also be accessed by clicking Open Ryujinx Folder under the File menu in the GUI.
Latest build
These builds are compiled automatically for each commit on the master branch, and may be unstable or completely broken.
The latest automatic build for Windows, macOS, and Linux can be found on the Official Website.
Requirements
-
Switch Keys
Everything on the Switch is encrypted, so if you want to run anything other than homebrew, you have to dump encryption keys from your console. To get more information please take a look at our Keys Documentation (Outdated)
-
FFmpeg Dependencies
Ryujinx has a basic implementation of
NVDEC, a video decoder used by the Switch's GPU. Many games include videos that use it, so you need to download Zeranoe's FFmpeg Builds for Shared linking and your computer's operating system. When it's done, extract the contents of thebinfolder directly into your Ryujinx folder. -
System Titles
Some of our System Module implementations, like
time, require System Data Archives. You can install them by mounting your nand partition using HacDiskMount and copying the content toRyuFs/nand/system. -
Executables
Ryujinx is able to run both official games and homebrew.
Homebrew is available on many websites, such as the Switch Appstore.
A hacked Switch is needed to dump games, which you can learn how to do here. Once you've hacked your Switch, you need to dump your own games with NxDumpTool to get an XCI dump or SwitchSDTool to get an NSP dump.
Features
-
Audio
Everything for audio is partially supported. We currently use a C# wrapper for libsoundio, and we support OpenAL (installation needed) too as a fallback. Our current Opus implementation is pretty incomplete.
-
CPU
The CPU emulator, ARMeilleure, emulates an ARMv8 CPU, and currently only has support for the new 64-bit ARMv8 instructions (with a few instructions still missing). It translates the ARM code to a custom IR, performs a few optimizations, and turns that into x86 code. To handle that, we use our own JIT called ARMeilleure, which uses the custom IR and compiles the code to x86.
ChocolArm is the old ARM emulator which worked by translating the ARM code to .NET IL. The runtime JIT then compiles that to the platform CPU code. On .NET Core, the JIT is called RyuJIT, hence the project name, Ryujinx. It is being replaced by ARMeilleure, but can still be enabled inside the configuration menu.
-
GPU
The GPU emulator emulates the Switch's Maxwell GPU using the OpenGL API (version 4.2 minimum) through a custom build of OpenTK.
-
Input
We currently have support for keyboard, mouse, touch input, JoyCon input support emulated through the keyboard, and some controllers too. You can set up everything inside the configuration menu.
-
Configuration
The emulator has settings for dumping shaders, enabling or disabling some logging, remapping controllers, and more. You can configure all of them through the graphical interface or manually through the config file,
Config.json.For more information you can go here (Outdated).
Compatibility
You can check out the compatibility list here.
Don't hesitate to open a new issue if a game isn't already on there.
Help
If you have homebrew that currently doesn't work within the emulator, you can contact us through our Discord with the .NRO/.NSO and source code, if possible. We'll take note of whatever is causing the app/game to not work, on the watch list and fix it at a later date.
If you need help with setting up Ryujinx, you can ask questions in the support channel of our Discord server.
Contact
If you have contributions, need support, have suggestions, or just want to get in touch with the team, join our Discord server!
If you'd like to donate, please take a look at our Patreon.