Experimental Nintendo Switch Emulator written in C#
Find a file
gdkchan 532b8cad13
Update KAddressArbiter implementation to 11.x kernel (#1851)
* Update KAddressArbiter implementation to 11.x kernel

* InsertSortedByPriority is no longer needed
2021-01-01 14:59:26 -03:00
.github infra: Migrate to .NET 5 (#1694) 2020-11-15 19:27:15 +01:00
ARMeilleure Hotfix for #1814 2020-12-24 04:44:39 +01:00
Ryujinx Enable Profiled Persistent Translation Cache (PPTC) by default (#1844) 2021-01-01 15:36:47 +01:00
Ryujinx.Audio audio: Cleanup Ryujinx.Audio and fix OpenAL issue (#1746) 2020-11-27 20:55:00 +01:00
Ryujinx.Audio.Renderer amadeus: Update copyright year 2021-01-01 00:12:32 +01:00
Ryujinx.Common Enable Profiled Persistent Translation Cache (PPTC) by default (#1844) 2021-01-01 15:36:47 +01:00
Ryujinx.Cpu Clear JIT cache on exit (#1518) 2020-12-16 17:07:42 -03:00
Ryujinx.Graphics.Device infra: Migrate to .NET 5 (#1694) 2020-11-15 19:27:15 +01:00
Ryujinx.Graphics.GAL gui/gpu: Implement setting and toggle for Aspect Ratio (#1777) 2020-12-15 23:19:07 -03:00
Ryujinx.Graphics.Gpu Interrupt GPU command processing when a frame's fence is reached. (#1741) 2020-12-17 19:39:52 +01:00
Ryujinx.Graphics.Host1x infra: Migrate to .NET 5 (#1694) 2020-11-15 19:27:15 +01:00
Ryujinx.Graphics.Nvdec infra: Migrate to .NET 5 (#1694) 2020-11-15 19:27:15 +01:00
Ryujinx.Graphics.Nvdec.H264 infra: Migrate to .NET 5 (#1694) 2020-11-15 19:27:15 +01:00
Ryujinx.Graphics.Nvdec.Vp9 Remove some warnings and cleaning code (#1736) 2020-11-27 18:57:20 +01:00
Ryujinx.Graphics.OpenGL gui/gpu: Implement setting and toggle for Aspect Ratio (#1777) 2020-12-15 23:19:07 -03:00
Ryujinx.Graphics.Shader Implement Force Early Z Register (#1755) 2020-12-02 00:13:27 +01:00
Ryujinx.Graphics.Texture Perform Compressed<->Uncompressed copies using Pixel Buffer Objects (#1732) 2020-11-20 13:30:59 -03:00
Ryujinx.Graphics.Vic infra: Migrate to .NET 5 (#1694) 2020-11-15 19:27:15 +01:00
Ryujinx.Graphics.Video infra: Migrate to .NET 5 (#1694) 2020-11-15 19:27:15 +01:00
Ryujinx.HLE Update KAddressArbiter implementation to 11.x kernel (#1851) 2021-01-01 14:59:26 -03:00
Ryujinx.Memory Update InvalidMemoryRegionException.cs to abide by English rules. (#1834) 2020-12-25 04:09:02 +01:00
Ryujinx.Memory.Tests Signal memory tracking before/after mapping into another process (#1785) 2020-12-07 21:42:17 -03:00
Ryujinx.ShaderTools infra: Migrate to .NET 5 (#1694) 2020-11-15 19:27:15 +01:00
Ryujinx.Tests Fix Vnmls_S fast path (F64: losing input d value). Fix Vnmla_S & Vnmls_S slow paths (using fused inst.s). Fix Vfma_V slow path not using StandardFPSCRValue(). (#1775) 2020-12-17 20:43:41 +01:00
Ryujinx.Tests.Unicorn infra: Migrate to .NET 5 (#1694) 2020-11-15 19:27:15 +01:00
.editorconfig Adding .editorconfig so code style can be consistent and localized (#1131) 2020-05-03 00:58:58 +02:00
.gitattributes aloha 2018-02-04 20:08:20 -03:00
.gitignore Implement ContentManager and related services (#438) 2018-11-18 17:37:41 -02:00
appveyor.yml infra: Migrate to .NET 5 (#1694) 2020-11-15 19:27:15 +01:00
global.json infra: Migrate to .NET 5 (#1694) 2020-11-15 19:27:15 +01:00
LICENSE.txt Update license (#788) 2019-10-12 23:48:31 -03:00
README.md Distribute with OpenAL Soft on Windows (#1847) 2020-12-31 09:08:09 +11:00
Ryujinx.sln Support 3D BC4 and BC5 compressed textures (#1655) 2020-11-01 15:32:53 -03:00
Ryujinx.sln.DotSettings Add features to GUI (#757) 2019-11-29 15:32:51 +11:00

Ryujinx

An experimental Switch emulator written in C#

As of November 2020, Ryujinx has been tested to go past menus to in-game on approximately 1,900 commercial titles. Of those, over 1,000 are considered playable. See the compatibility list here.

Usage

To run this emulator, we recommend that your PC have at least 8GB of RAM; less than this amount can result in unpredictable behavior and may cause crashes or unacceptable performance.

See our Setup & Configuration Guide on how to set up the emulator.

Latest build

These builds are compiled automatically for each commit on the master branch. While we strive to ensure optimal stability and performance prior to pushing an update, our automated builds may be unstable or completely broken.

The latest automatic build for Windows, macOS, and Linux can be found on the Official Website.

Building

If you wish to build the emulator yourself you will need to:

Step one: Install the X64 version of .NET 5.0 (or higher) SDK.

Step two (choose one):
(Variant one)

After the installation of the .NET SDK is done; go ahead and copy the Clone link from GitHub from here (via Clone or Download --> Copy HTTPS Link. You can Git Clone the repo by using Git Bash or Git CMD.

(Variant two):

Download the ZIP Tarball. Then extract it to a directory of your choice.

Step three:

Build the App using a Command prompt in the project directory. You can quickly access it by holding shift in explorer (in the Ryujinx directory) then right clicking, and typing the following command:
Run dotnet build -c Release inside the Ryujinx project folder to build Ryujinx binaries.

Ryujinx system files are stored in the Ryujinx folder. This folder is located in the user folder, which can be accessed by clicking Open Ryujinx Folder under the File menu in the GUI.

Features

  • Audio

    Audio output is entirely supported, audio input (microphone) isn't supported. We use C# wrappers for OpenAL, and libsoundio as the fallback.

  • CPU

    The CPU emulator, ARMeilleure, emulates an ARMv8 CPU and currently has support for most 64-bit ARMv8 and some of the ARMv7 (and older) instructions, including partial 32-bit support. It translates the ARM code to a custom IR, performs a few optimizations, and turns that into x86 code.
    Ryujinx also features an optional Profiled Persistent Translation Cache, which essentially caches translated functions so that they do not need to be translated every time the game loads. The net result is a significant reduction in load times (the amount of time between launching a game and arriving at the title screen) for nearly every game. NOTE: this feature is disabled by default and must be enabled in the Options menu > System tab. You must launch the game at least twice to the title screen or beyond before performance improvements are unlocked on the third launch! These improvements are permanent and do not require any extra launches going forward.

  • GPU

    The GPU emulator emulates the Switch's Maxwell GPU using the OpenGL API (version 4.4 minimum) through a custom build of OpenTK. There are currently two graphics enhancements available to the end user in Ryujinx: resolution scaling and anisotropic filtering. These can both be adjusted in the GUI.

  • Input

    We currently have support for keyboard, mouse, touch input, JoyCon input support emulated through the keyboard, and most controllers. Controller support varies by operating system, as outlined below.
    Windows: Xinput-compatible controllers are supported natively; other controllers can be supported with the help of Xinput wrappers such as x360ce.
    Linux: most modern controllers are supported.
    In either case, you can set up everything inside the input configuration menu.

  • DLC & Modifications

    Ryujinx is able to manage add-on content/downloadable content through the GUI. Mods (romfs and exefs) are also supported and the GUI contains a shortcut to open the respective mods folder for a particular game.

  • Configuration

    The emulator has settings for 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, found in the user folder which can be accessed by clicking Open Ryujinx Folder under the File menu in the GUI.

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 are having problems launching homebrew or a particular game marked status-playable or status-ingame in our compatibility list, you can contact us through our Discord server. We'll take note of whatever is causing the app/game to not work, put it 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.

License

This software is licensed under the terms of the MIT license. The Ryujinx.Audio.Renderer project is licensed under the terms of the LGPLv3 license. This project makes use of code authored by the libvpx project, licensed under BSD and the ffmpeg project, licensed under LGPLv3. See LICENSE.txt and THIRDPARTY.md for more details.