From 68c563d469cffcec21d1bd13ce317fafde4a4573 Mon Sep 17 00:00:00 2001 From: John Clemis Date: Sat, 15 Dec 2018 18:55:50 -0600 Subject: [PATCH] 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 --- CONFIG.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++ README.md | 58 +++++-------------------------------------------------- 2 files changed, 55 insertions(+), 53 deletions(-) diff --git a/CONFIG.md b/CONFIG.md index b5de9fa6dc..eef7b68d99 100644 --- a/CONFIG.md +++ b/CONFIG.md @@ -116,6 +116,56 @@ Controls_Right_JoyConController_Button_ZR (String) ``` +- Default Mapping + - Controller + - Left Joycon: + - Analog Stick = Left Analog Stick + - DPad Up = DPad Up + - DPad Down = DPad Down + - DPad Left = DPad Left + - DPad Right = DPad Right + - Minus = Select / Back / Share + - L = Left Shoulder Button + - ZL = Left Trigger + + - Right Joycon: + - Analog Stick = Right Analog Stick + - A = B / Circle + - B = A / Cross + - X = Y / Triangle + - Y = X / Square + - Plus = Start / Options + - R = Right Shoulder Button + - ZR = Right Trigger + - Keyboard + - 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 + - Valid Button Mappings - A = The A / Cross Button - B = The B / Circle Button diff --git a/README.md b/README.md index 7c253d60e6..e22186cb2f 100644 --- a/README.md +++ b/README.md @@ -7,71 +7,23 @@ Many games boot, only a handful are playable, see the compatiblity list [here](h **Building** -To build this emulator, you will need the [.NET Core 2.1 (RC1) (or higher) SDK](https://www.microsoft.com/net/download/) +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: - - 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 + - Keyboard Input is supported, see [CONFIG.md](CONFIG.md) - - 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 - - For more information on how to configure these buttons see [CONFIG.md](CONFIG.md) - - - Controller Input is supported: - - Left Joycon: - - Analog Stick = Left Analog Stick - - DPad Up = DPad Up - - DPad Down = DPad Down - - DPad Left = DPad Left - - DPad Right = DPad Right - - Minus = Select / Back / Share - - L = Left Shoulder Button - - ZL = Left Trigger - - - Right Joycon: - - Analog Stick = Right Analog Stick - - A = B / Circle - - B = A / Cross - - X = Y / Triangle - - Y = X / Square - - Plus = Start / Options - - R = Right Shoulder Button - - ZR = Right Trigger - - For more information on how to configure these buttons see [CONFIG.md](CONFIG.md) + - Controller Input is supported, see [CONFIG.md](CONFIG.md) - Config File: `Ryujinx.conf` 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 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 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** @@ -82,7 +34,7 @@ For donation support, please take a look at our [Patreon](https://www.patreon.co **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 solution folder to run homebrew apps. +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**