stuff/Ryujinx
stuff/Ryujinx
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update readme at bit

Browse source
This commit is contained in:
jlachniet 2018-06-14 23:17:22 -04:00 committed by GitHub
parent e581abb2f5
commit 235937f16f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -1,24 +1,27 @@
![](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#
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.](https://ryujinx.org/#/Compatibility)
Don't expect much from this. Some homebrew apps work, Puyo Puyo Tetris shows the intro logo (sometimes), and a handful of games boot / work; but that's about it for now.
Contributions are always welcome.
**Latest build**
The latest automatic build for Windows (64-bit) can be found on the [official website](https://ryujinx.org/#/Build).
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. 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.
To build this emulator, you will need the [.NET Core 2.1 (RC1) (or higher) SDK.](https://www.microsoft.com/net/download/)
In release builds, memory checks are disabled to improve performance.
**Features**
- Audio is partially supported (glitched) on Windows but you need to install the OpenAL Core SDK.
https://openal.org/downloads/OpenAL11CoreSDK.zip
- Audio is partially supported on Windows, but you need to install the [OpenAL Core SDK.](https://openal.org/downloads/OpenAL11CoreSDK.zip)
- Keyboard Input is partially supported:
- Keyboard input is partially supported. The default controls are:
- Left Joycon:
- Stick Up = W
- Stick Down = S
@ -55,7 +58,7 @@ https://openal.org/downloads/OpenAL11CoreSDK.zip
**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.
If you have some homebrew that currently doesn't work within the emulator, you can contact us through our [Discord](https://discord.gg/VkQYXAZ) 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**
@ -69,9 +72,4 @@ Run `dotnet run -c Release -- path\to\homebrew.nro` inside the Ryujinx solution
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 within the Wiki. Only a handful of games actually work.
**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 (64-bit) can be found on the [official website](https://ryujinx.org/#/Build).
You can check out the [compatibility lis.t](https://ryujinx.org/#/Compatibility) Only a handful of games actually work.