mirror of
https://github.com/Ryujinx/Ryujinx.git
synced 2024-08-19 21:52:22 +00: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
This commit is contained in:
parent
33e7c89822
commit
2534a7f10c
50
CONFIG.md
50
CONFIG.md
|
@ -116,6 +116,56 @@
|
||||||
Controls_Right_JoyConController_Button_ZR (String)
|
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
|
- Valid Button Mappings
|
||||||
- A = The A / Cross Button
|
- A = The A / Cross Button
|
||||||
- B = The B / Circle Button
|
- B = The B / Circle Button
|
||||||
|
|
81
README.md
81
README.md
|
@ -3,98 +3,45 @@
|
||||||
|
|
||||||
Experimental Switch emulator written in C#
|
Experimental Switch emulator written in C#
|
||||||
|
|
||||||
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.
|
Many games boot, only a handful are playable, see the compatiblity list [here](https://github.com/Ryujinx/Ryujinx-Games-List/issues).
|
||||||
Contributions are always welcome.
|
|
||||||
|
|
||||||
**Building**
|
**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/)
|
||||||
In release builds, memory checks are disabled to improve performances.
|
or just drag'n'drop the homebrew *.NRO / *.NSO or the game *.NSP / *.XCI on the executable if you have a pre-built version.
|
||||||
|
|
||||||
Or just drag'n'drop the *.NRO / *.NSO or the game folder on the executable if you have a pre-build version.
|
|
||||||
|
|
||||||
**Features**
|
**Features**
|
||||||
|
|
||||||
- Audio is partially supported (glitched) on Windows but you need to install the OpenAL Core SDK.
|
- Audio is partially supported.
|
||||||
https://openal.org/downloads/OpenAL11CoreSDK.zip
|
|
||||||
|
|
||||||
- Keyboard Input is partially supported:
|
- Keyboard Input is supported, see [CONFIG.md](CONFIG.md)
|
||||||
- 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:
|
- Controller Input is supported, see [CONFIG.md](CONFIG.md)
|
||||||
- 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 partially 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)
|
|
||||||
|
|
||||||
- Config File: `Ryujinx.conf` should be present in executable folder.
|
- Config File: `Ryujinx.conf` should be present in executable folder.
|
||||||
For more information [you can go here](CONFIG.md).
|
For more information [you can go here](CONFIG.md).
|
||||||
|
|
||||||
**Help**
|
**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**
|
**Contact**
|
||||||
|
|
||||||
For help, support, suggestions, or if you just want to get in touch with the team; join our Discord server!
|
For help, support, suggestions, or if you just want to get in touch with the team; join our [Discord server](https://discord.gg/N2FmfVc)!
|
||||||
https://discord.gg/VkQYXAZ
|
|
||||||
|
|
||||||
For donation support, please take a look at our Patreon: https://www.patreon.com/ryujinx
|
For donation support, please take a look at our [Patreon](https://www.patreon.com/ryujinx).
|
||||||
|
|
||||||
**Running**
|
**Running**
|
||||||
|
|
||||||
To run this emulator, you need the .NET Core 2.1 (or higher) SDK *and* the OpenAL 11 Core SDK.
|
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_exefs_and_romfs_folder` to run official games (they need to be decrypted and extracted first!)
|
Run `dotnet run -c Release -- path\to\game.nsp/xci` to run official games.
|
||||||
|
|
||||||
**Compatibility**
|
**Compatibility**
|
||||||
|
|
||||||
You can check out the compatibility list within the Wiki. Only a handful of games actually work.
|
You can check out the compatibility list [here](https://github.com/Ryujinx/Ryujinx-Games-List/issues).
|
||||||
|
|
||||||
**Latest build**
|
**Latest build**
|
||||||
|
|
||||||
These builds are compiled automatically for each commit on the master branch. They may be unstable or might not work at all.
|
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).
|
The latest automatic build for Windows, Mac, and Linux can be found on the [official website](https://ryujinx.org/#/Build).
|
||||||
|
|
Loading…
Reference in a new issue