From 235937f16f193fb58fb019548ab69a8ec0d128c0 Mon Sep 17 00:00:00 2001 From: jlachniet <31355828+jlachniet@users.noreply.github.com> Date: Thu, 14 Jun 2018 23:17:22 -0400 Subject: [PATCH 1/5] Update readme at bit --- README.md | 30 ++++++++++++++---------------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 3efd347a85..7bd3ef70fa 100644 --- a/README.md +++ b/README.md @@ -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. From c812f8fab89e2d8e7184c8c11f2e0ebe331792a0 Mon Sep 17 00:00:00 2001 From: jlachniet <31355828+jlachniet@users.noreply.github.com> Date: Thu, 14 Jun 2018 23:26:30 -0400 Subject: [PATCH 2/5] Idiocy --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7bd3ef70fa..855d6d18b5 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ In release builds, memory checks are disabled to improve performance. - 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. The default controls are: + - Keyboard input and XInput are partially supported. The default controls are: - Left Joycon: - Stick Up = W - Stick Down = S @@ -72,4 +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 lis.t](https://ryujinx.org/#/Compatibility) Only a handful of games actually work. +You can check out the [compatibility list](https://ryujinx.org/#/Compatibility) Only a handful of games actually work. From 813803c3f0b1afa27418fee8b2b810295c836f8d Mon Sep 17 00:00:00 2001 From: jlachniet <31355828+jlachniet@users.noreply.github.com> Date: Fri, 15 Jun 2018 10:19:28 -0400 Subject: [PATCH 3/5] Idiocy the sequel --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 855d6d18b5..ce05ea9972 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ In release builds, memory checks are disabled to improve performance. - Audio is partially supported on Windows, but you need to install the [OpenAL Core SDK.](https://openal.org/downloads/OpenAL11CoreSDK.zip) - - Keyboard input and XInput are partially supported. The default controls are: + - 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 From ba7a19ab1af05dccedac8f376bf8f0f0b28fa36e Mon Sep 17 00:00:00 2001 From: jlachniet <31355828+jlachniet@users.noreply.github.com> Date: Fri, 15 Jun 2018 10:21:07 -0400 Subject: [PATCH 4/5] Idiocy 2: Electric Boogaloo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ce05ea9972..a5236c261f 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ This emulator only boots a small selection of homebrew and commercial games. To Contributions are always welcome. -**Latest build** +**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. From 53fe89210c0267822ecae19e7fa2a7f56fb3eaca Mon Sep 17 00:00:00 2001 From: jlachniet <31355828+jlachniet@users.noreply.github.com> Date: Sun, 17 Jun 2018 18:34:04 -0400 Subject: [PATCH 5/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a5236c261f..3c534c723a 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ In release builds, memory checks are disabled to improve performance. - 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. XInput is partially supported, but hardcoded and unfinished. The default controls are: + - Keyboard input is partially supported. The default controls are: - Left Joycon: - Stick Up = W - Stick Down = S