Ryujinx/README.md
2018-06-15 10:19:28 -04:00

2.9 KiB

Ryujinx Build status

Ryujinx is an experimental Nintendo Switch emulator written in C#

This emulator only boots a small selection of homebrew and commercial games. To see if a game if compatible, please check the compatibility list.

Contributions are always welcome.

Latest build

The latest automatic build for Windows (64-bit) can be found on the official website. These builds are compiled automatically for each commit on the master branch. They may be unstable or might not work at all.

Building

To build this emulator, you will need the .NET Core 2.1 (RC1) (or higher) SDK. In release builds, memory checks are disabled to improve performance.

Features

  • Audio is partially supported on Windows, but you need to install the OpenAL Core SDK.

  • Keyboard input is partially supported. XInput is partially supported, but hardcoded and unfinished. The default controls are:

    • Left Joycon:

      • Stick Up = W
      • Stick Down = S
      • Stick Left = A
      • Stick Right = D
      • Stick Button = F
      • DPad Up = Up
      • DPad Down = Down
      • DPad Left = Left
      • DPad Right = Right
      • Minus = -
      • L = E
      • ZL = Q
    • Right Joycon:

      • Stick Up = I
      • Stick Down = K
      • Stick Left = J
      • Stick Right = L
      • Stick Button = H
      • A = Z
      • B = X
      • X = C
      • Y = V
      • Plus = +
      • R = U
      • ZR = O
  • Config File: Ryujinx.conf should be present in executable folder. For more informations you can go here.

  • If you are a Windows user, you can configure your keys, the logs, install OpenAL, etc... with Ryujinx-Setting. Download it, right here

Help

If you have some homebrew that currently doesn't work within the emulator, you can contact us through our Discord with the compiled NRO/NSO (and source code if possible) and then we'll make changes in order to make the requested app / game work.

Contact

For help, support, suggestions, or if you just want to get in touch with the team; join our Discord server!
https://discord.gg/VkQYXAZ

Running

To run this emulator, you need the .NET Core 2.1 (or higher) SDK and the OpenAL 11 Core SDK.
Run dotnet run -c Release -- path\to\homebrew.nro inside the Ryujinx solution folder to run homebrew apps.
Run dotnet run -c Release -- path\to\game_exefs_and_romfs_folder to run official games (they need to be decrypted and extracted first!)

Compatibility You can check out the compatibility list Only a handful of games actually work.