2018-05-15 17:57:22 +01:00
2018-02-10 19:51:07 +00:00
# Ryujinx [](https://ci.appveyor.com/project/gdkchan/ryujinx)
2018-02-04 23:11:01 +00:00
Experimental Switch emulator written in C#
2018-12-18 00:34:23 +00:00
Many games boot, only a handful are playable, see the compatiblity list [here ](https://github.com/Ryujinx/Ryujinx-Games-List/issues ).
2018-02-05 00:39:03 +00:00
2018-02-10 19:51:07 +00:00
**Building**
2018-12-18 00:34:23 +00:00
To build this emulator, you will need the [.NET Core 2.1 (or higher) SDK ](https://www.microsoft.com/net/download/ )
or just drag'n'drop the homebrew *.NRO / * .NSO or the game *.NSP / * .XCI on the executable if you have a pre-built version.
2018-02-10 19:51:07 +00:00
**Features**
2018-12-18 00:34:23 +00:00
- Audio is partially supported.
- Keyboard Input is supported, see [CONFIG.md ](CONFIG.md )
- Controller Input is supported, see [CONFIG.md ](CONFIG.md )
2018-02-18 00:46:29 +00:00
- Config File: `Ryujinx.conf` should be present in executable folder.
2018-07-02 23:08:54 +01:00
For more information [you can go here ](CONFIG.md ).
2018-05-12 00:17:43 +01:00
2018-02-10 19:51:07 +00:00
**Help**
2018-12-18 00:34:23 +00:00
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 keep whatever is making app / game not work on the watch list and fix it at a later date.
2018-02-10 19:51:07 +00:00
**Contact**
2018-12-18 00:34:23 +00:00
For help, support, suggestions, or if you just want to get in touch with the team; join our [Discord server ](https://discord.gg/N2FmfVc )!
2018-02-10 19:51:07 +00:00
2018-12-18 00:34:23 +00:00
For donation support, please take a look at our [Patreon ](https://www.patreon.com/ryujinx ).
2018-07-11 23:08:20 +01:00
2018-02-05 00:39:03 +00:00
**Running**
2018-12-18 00:34:23 +00:00
To run this emulator, you need the .NET Core 2.1 (or higher) SDK.
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.
2018-04-25 01:06:49 +01:00
2018-05-12 00:17:43 +01:00
**Compatibility**
2018-07-11 23:08:20 +01:00
2018-12-18 00:34:23 +00:00
You can check out the compatibility list [here ](https://github.com/Ryujinx/Ryujinx-Games-List/issues ).
2018-02-08 16:52:02 +00:00
2018-02-20 20:10:03 +00:00
**Latest build**
2018-02-10 19:51:07 +00:00
2018-06-11 00:44:48 +01:00
These builds are compiled automatically for each commit on the master branch. They may be unstable or might not work at all.
2018-12-18 00:34:23 +00:00
The latest automatic build for Windows, Mac, and Linux can be found on the [official website ](https://ryujinx.org/#/Build ).
