Ryulynx

---

Ryujinx was an HLE Switch emulator written in C# by gdkchan. It was developed from scratch and work on the project started in September of 2017. It was available on GitHub under the MIT license.

On October 1st 2024, Ryujinx was discontinued, as the creator was forced to abandon the project.

Ryulynx is a fork of Ryujinx that strives for accuracy, performance, and preservation. It achieves this by providing extra tooling for users and committing itself to accuracy, with a focus on user privacy.

Ryulynx aims to be a middle ground between GreemDev's Ryujinx fork and the original project, Ryujinx. It brings over many of the front-facing features from the aforementioned fork with additional contributions from KeatonTheBot, sh0inx, Neo, and others.

---

Compatibility

As of May 2024, Ryujinx has been tested on approximately 4,300 titles; over 4,100 boot past menus and into gameplay, with roughly 3,550 of those being considered playable.

Anyone is free to submit a new game test or update an existing game test entry; PROCEDURE PENDING. Use the search function to see if a game has been tested already!

Usage

To run this software, your PC or mobile devicec must be equipped with at least:

• 8GiB of RAM
• 6 cores
• A GPU released within the last 10 years.
• OpenGL 4.6 | Vulkan 1.4
• Windows 10 version 20H1 | macOS Big Sur (Apple Silicon) | Android 12

Failing to meet these requirements may result in a poor gameplay experience or unexpected crashes.

Latest build

Stable releases are published when a milestone is reached, a feature is fully implemented, or a quota of bugfixes has been fulfilled. Stable is designed to give users a stable, dependable experience.

Canary releases are published after any commit is made to the master branch. As a result, Canary releases may have bugs, corruptions, or game-breaking issues, but will also have the latest fixes implemented.

Documentation

If you are planning to contribute or just want to learn more about this project please read through our documentation.

Building

If you wish to build the emulator yourself, follow these steps:

Step 1

Install the .NET 10.0 (or higher) SDK. Make sure your SDK version is higher or equal to the required version specified in global.json.

Step 2

Either use git clone https://starforgejo.dev/projects/Ryulynx on the command line to clone the repository or use Code --> Download zip button to get the files. If you plan to use SSH, please make sure to copy the SSH URL from the dropdown.

Step 3

To build Ryulynx, open a command prompt inside the project directory. You can quickly access it on Windows by holding shift in File Explorer, then right clicking and selecting Open command window here.

Then, type the following command: dotnet build -c Release -o build. The built files will be found in the newly created build directory.

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 SDL3 & libsoundio as fallbacks.

• 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. There are three memory manager options available depending on the user's preference, leveraging both software-based (slower) and host-mapped modes (much faster). The fastest option (host, unchecked) is set by default. Ryulynx 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 enabled by default 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 either the OpenGL (version 4.5 minimum), Vulkan, or Metal (via MoltenVK) APIs through a custom build of OpenTK or Silk.NET respectively. There are currently six graphics enhancements available to the end user in Ryulynx: Disk Shader Caching, Resolution Scaling, Anti-Aliasing, Scaling Filters (including FSR), Anisotropic Filtering and Aspect Ratio Adjustment. These enhancements can be adjusted or toggled as desired in the GUI.

• Input

  We currently have support for keyboard, mouse, touch input, JoyCon input support, and nearly all controllers. Motion controls are natively supported in most cases; for dual-JoyCon motion support, DS4Windows or BetterJoy are currently required. In all scenarios, you can set up everything inside the input configuration menu.

• DLC & Modifications

  Ryulynx is able to manage add-on content/downloadable content through the GUI. Mods (romfs, exefs, and runtime mods such as cheats) are also supported; 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.

License

This software is licensed under the terms of the MIT 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.

Credits

• LibHac is used for our file-system.
• AmiiboAPI is used in our Amiibo emulation.
• ldn_mitm is used for one of our available multiplayer modes.
• ShellLink is used for Windows shortcut generation.