Ryujinx/README.md

![](https://ryujinx.github.io/static/img/Ryujinx_logo_128.png)
# Ryujinx [![Build status](https://ci.appveyor.com/api/projects/status/ssg4jwu6ve3k594s?svg=true)](https://ci.appveyor.com/project/gdkchan/ryujinx)

Experimental Switch emulator written in C#

Many games boot, only a handful are playable, see the compatiblity list [here](https://github.com/Ryujinx/Ryujinx-Games-List/issues).

**Building**

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.

**Features**

 - Audio is partially supported.

 - Keyboard Input is supported, see [CONFIG.md](CONFIG.md)

 - Controller Input is supported, see [CONFIG.md](CONFIG.md)

 - Config File: `Config.jsonc` should be present in executable folder.
   For more information [you can go here](CONFIG.md).

**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 keep whatever is making app / game not work on the watch list and fix it at a later date.

**Contact**

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

For donation support, please take a look at our [Patreon](https://www.patreon.com/ryujinx).

**Running**

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.

**Compatibility**

You can check out the compatibility list [here](https://github.com/Ryujinx/Ryujinx-Games-List/issues).

**Latest build**

These builds are compiled automatically for each commit on the master branch. They may be unstable or might not work at all.  
The latest automatic build for Windows, Mac, and Linux can be found on the [official website](https://ryujinx.org/#/Build).
Update README.md 2018-05-15 12:57:22 -04:00			`![](https://ryujinx.github.io/static/img/Ryujinx_logo_128.png)`
Update README.md 2018-02-10 14:51:07 -05:00			`# Ryujinx [![Build status](https://ci.appveyor.com/api/projects/status/ssg4jwu6ve3k594s?svg=true)](https://ci.appveyor.com/project/gdkchan/ryujinx)`

Create README.md 2018-02-04 18:11:01 -05:00			`Experimental Switch emulator written in C#`

Update the Readme (#546) * Update the Readme (finally) * Address Feedback Move default button mappings to CONFIG.MD Change "Ryujinx solution folder" to "Ryujinx project folder" Re-word the help section Get rid of "(RC1)" on the .NET Core download link * Update discord link 2018-12-17 19:34:23 -05:00			`Many games boot, only a handful are playable, see the compatiblity list [here](https://github.com/Ryujinx/Ryujinx-Games-List/issues).`
Update README.md 2018-02-04 19:39:03 -05:00
Update README.md 2018-02-10 14:51:07 -05:00			`Building`

Update the Readme (#546) * Update the Readme (finally) * Address Feedback Move default button mappings to CONFIG.MD Change "Ryujinx solution folder" to "Ryujinx project folder" Re-word the help section Get rid of "(RC1)" on the .NET Core download link * Update discord link 2018-12-17 19:34:23 -05: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.`
Update README.md 2018-02-10 14:51:07 -05:00
			`Features`

Update the Readme (#546) * Update the Readme (finally) * Address Feedback Move default button mappings to CONFIG.MD Change "Ryujinx solution folder" to "Ryujinx project folder" Re-word the help section Get rid of "(RC1)" on the .NET Core download link * Update discord link 2018-12-17 19:34:23 -05:00			`- Audio is partially supported.`

			`- Keyboard Input is supported, see [CONFIG.md](CONFIG.md)`

			`- Controller Input is supported, see [CONFIG.md](CONFIG.md)`
Update README.md (#22) 2018-02-17 19:46:29 -05:00
Logger and Configuration Refactoring (#573) * Logging: Refactor log targets into Ryujinx.Common * Logger: Implement JSON Log Target * Logger: Optimize Console/File logging targets Implement a simple ObjectPool to pool up StringBuilders to avoid causing excessive GCing of gen1/2 items when large amounts of log entries are being generated. We can also pre-determine the async overflow action at initialization time, allowing for an easy optimization in the message enqueue function, avoiding a number of comparisons. * Logger: Implement LogFormatters * Config: Refactor configuration file and loading * Config: Rename to .jsonc to avoid highlighting issues in VSC and GitHub * Resolve style nits * Config: Resolve incorrect default key binding * Config: Also update key binding default in schema * Tidy up namespace imports * Config: Update CONFIG.md to reflect new Config file 2019-02-11 07:00:32 -05:00			- Config File: `Config.jsonc` should be present in executable folder.
Add Controller Support (#196) * Added Basic Controller Support * Added Extra Configuration Options Added a GamePad_Enable option and GamePad_Index option * Revert "Added Extra Configuration Options" This reverts commit 6cc56bfe7ed473fedf8dfe79c7a888bbe7cfe147. * Revert "Revert "Added Extra Configuration Options"" This reverts commit 4809e5effe7f54cdb67bc5e2b4f01315ae34efc5. * Forgot to change the Gamepad Index * Added Configuration for the A B X Y Buttons * Added Button Configuration for all other Buttons * Added Basic Joystick Configuration * Fixed Joystick Axis Problems Fixed Joystick Axis Problems when switching around the Joysticks (Left Stick is Right and Right stick is Left) * Refactored all of the button mapping code * Changes in compliance with review * Changes in compliance with review * Fixed problems in the configuration file with different regions * Changes in compliance with review 2018-07-02 18:08:54 -04:00			`For more information [you can go here](CONFIG.md).`
Update min sdk version on readme 2018-05-11 19:17:43 -04:00
Update README.md 2018-02-10 14:51:07 -05:00			`Help`

Update the Readme (#546) * Update the Readme (finally) * Address Feedback Move default button mappings to CONFIG.MD Change "Ryujinx solution folder" to "Ryujinx project folder" Re-word the help section Get rid of "(RC1)" on the .NET Core download link * Update discord link 2018-12-17 19:34:23 -05: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.`
Update README.md 2018-02-10 14:51:07 -05:00
			`Contact`

Update the Readme (#546) * Update the Readme (finally) * Address Feedback Move default button mappings to CONFIG.MD Change "Ryujinx solution folder" to "Ryujinx project folder" Re-word the help section Get rid of "(RC1)" on the .NET Core download link * Update discord link 2018-12-17 19:34:23 -05: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)!`
Update README.md 2018-02-10 14:51:07 -05:00
Update the Readme (#546) * Update the Readme (finally) * Address Feedback Move default button mappings to CONFIG.MD Change "Ryujinx solution folder" to "Ryujinx project folder" Re-word the help section Get rid of "(RC1)" on the .NET Core download link * Update discord link 2018-12-17 19:34:23 -05:00			`For donation support, please take a look at our [Patreon](https://www.patreon.com/ryujinx).`
Update README.md 2018-07-11 18:08:20 -04:00
Update README.md 2018-02-04 19:39:03 -05:00			`Running`

Update the Readme (#546) * Update the Readme (finally) * Address Feedback Move default button mappings to CONFIG.MD Change "Ryujinx solution folder" to "Ryujinx project folder" Re-word the help section Get rid of "(RC1)" on the .NET Core download link * Update discord link 2018-12-17 19:34:23 -05: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.
Update README.md 2018-04-24 20:06:49 -04:00
Update min sdk version on readme 2018-05-11 19:17:43 -04:00			`Compatibility`
Update README.md 2018-07-11 18:08:20 -04:00
Update the Readme (#546) * Update the Readme (finally) * Address Feedback Move default button mappings to CONFIG.MD Change "Ryujinx solution folder" to "Ryujinx project folder" Re-word the help section Get rid of "(RC1)" on the .NET Core download link * Update discord link 2018-12-17 19:34:23 -05:00			`You can check out the compatibility list [here](https://github.com/Ryujinx/Ryujinx-Games-List/issues).`
Basic audio support Implement IAudioOut. Small corrections on AudIAudioRenderer. Add glitched audio playback support through OpenAL. 2018-02-08 11:52:02 -05:00
Fix various typos in the Readme (#31) * Fix some typos * Fix even more typos 2018-02-20 15:10:03 -05:00			`Latest build`
Update README.md 2018-02-10 14:51:07 -05:00
Update README file (#143) 2018-06-10 19:44:48 -04:00			`These builds are compiled automatically for each commit on the master branch. They may be unstable or might not work at all.`
Update the Readme (#546) * Update the Readme (finally) * Address Feedback Move default button mappings to CONFIG.MD Change "Ryujinx solution folder" to "Ryujinx project folder" Re-word the help section Get rid of "(RC1)" on the .NET Core download link * Update discord link 2018-12-17 19:34:23 -05:00			`The latest automatic build for Windows, Mac, and Linux can be found on the [official website](https://ryujinx.org/#/Build).`