mirror of https://github.com/Ryujinx/Ryujinx.git synced 2024-12-22 23:05:32 +00:00

Experimental Nintendo Switch Emulator written in C#

csharp dotnet dotnet-core emulation emulator switch

Go to file

gdkchan fba0bf8732 Refactor IPC services to have commands into separate classes, fix readme url		2018-02-25 01:34:27 -03:00
ChocolArm64	Add FABD (scalar), ADCS, SBCS instructions, update config with better default control mappings, update readme with the new mappings	2018-02-24 18:47:08 -03:00
Ryujinx	Add FABD (scalar), ADCS, SBCS instructions, update config with better default control mappings, update readme with the new mappings	2018-02-24 18:47:08 -03:00
Ryujinx.Core	Refactor IPC services to have commands into separate classes, fix readme url	2018-02-25 01:34:27 -03:00
Ryujinx.Graphics	Map heap on heap base region, fix for thread start on homebrew, add FCVTMU and FCVTPU (general) instructions, fix FMOV (higher 64 bits) encodings, improve emit code for FCVT* (general) instructions	2018-02-23 21:59:38 -03:00
Ryujinx.Tests	Update ADC test, add WZR/WSP, ADCS, SBCS test (#37 )	2018-02-24 22:50:58 -03:00
.gitattributes	aloha	2018-02-04 20:08:20 -03:00
.gitignore	aloha	2018-02-04 20:08:20 -03:00
.travis.yml	Add some tests (#18 )	2018-02-15 21:04:38 -03:00
CONFIG.md	Create CONFIG.md (#21 )	2018-02-17 21:45:53 -03:00
LICENSE.txt	aloha	2018-02-04 20:08:20 -03:00
README.md	Refactor IPC services to have commands into separate classes, fix readme url	2018-02-25 01:34:27 -03:00
Ryujinx.sln	Split main project into core,graphics and chocolarm4 subproject (#29 )	2018-02-20 17:09:23 -03:00

README.md

Ryujinx

Experimental Switch emulator written in C#

Don't expect much from this. Some homebrew apps work, and Puyo Puyo Tetris shows the intro logo (sometimes) but that's about it for now. Contributions are always welcome.

Building

To build this emulator, you need the .NET Core 2.0 (or higher) SDK. https://www.microsoft.com/net/download/ In release builds, memory checks are disabled to improve performances.

Or just drag'n'drop the *.NRO / *.NSO or the game folder on the executable if you have a pre-build version.

Features

Audio is partially supported (glitched) on Windows but you need to install the OpenAL Core SDK. https://openal.org/downloads/OpenAL11CoreSDK.zip
Keyboard Input is partially supported:
- 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.

Help

If you have some homebrew that currently don't work on the emulator, you can contact us through Discord with the compiled NRO/NSO (and source code if possible) and then we'll make changes 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.0 (or higher) 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!).

Latest build

These builds are compiled automatically for each commit on the master branch. They may be unstable or not work at all. To download the latest automatic build for Windows (64-bits), Click Here.