rjx-mirror/README.md

104 lines
3.5 KiB
Markdown
Raw Normal View History

2018-05-15 16:57:22 +00:00
![](https://ryujinx.github.io/static/img/Ryujinx_logo_128.png)
2018-02-10 19:51:07 +00:00
# Ryujinx [![Build status](https://ci.appveyor.com/api/projects/status/ssg4jwu6ve3k594s?svg=true)](https://ci.appveyor.com/project/gdkchan/ryujinx)
2018-02-04 23:11:01 +00:00
Experimental Switch emulator written in C#
2018-04-25 00:06:49 +00:00
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.
2018-02-04 23:11:01 +00:00
Contributions are always welcome.
2018-02-05 00:39:03 +00:00
2018-02-10 19:51:07 +00:00
**Building**
To build this emulator, you will need the .NET Core 2.1 (RC1) (or higher) SDK. https://www.microsoft.com/net/download/
2018-02-10 19:51:07 +00:00
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.
2018-02-10 19:51:07 +00:00
**Features**
- Audio is partially supported (glitched) on Windows but you need to install the OpenAL Core SDK.
https://openal.org/downloads/OpenAL11CoreSDK.zip
- Keyboard Input is partially 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
- 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 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)
2018-02-18 00:46:29 +00:00
- Config File: `Ryujinx.conf` should be present in executable folder.
For more information [you can go here](CONFIG.md).
2018-05-11 23:17:43 +00:00
2018-04-05 02:02:21 +00:00
- If you are a Windows user, you can configure your keys, the logs, install OpenAL, etc... with Ryujinx-Setting.
[Download it, right here](https://github.com/AcK77/Ryujinx-Settings)
2018-02-10 19:51:07 +00:00
**Help**
2018-04-25 00:06:49 +00: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 make changes in order to make the requested app / game work.
2018-02-10 19:51:07 +00:00
**Contact**
2018-06-10 23:44:48 +00:00
For help, support, suggestions, or if you just want to get in touch with the team; join our Discord server!
2018-02-10 19:51:07 +00:00
https://discord.gg/VkQYXAZ
2018-07-11 22:08:20 +00:00
For donation support, please take a look at our Patreon: https://www.patreon.com/ryujinx
2018-02-05 00:39:03 +00:00
**Running**
2018-06-10 23:44:48 +00:00
To run this emulator, you need the .NET Core 2.1 (or higher) SDK *and* the OpenAL 11 Core SDK.
Run `dotnet run -c Release -- path\to\homebrew.nro` inside the Ryujinx solution folder to run homebrew apps.
2018-04-25 00:06:49 +00:00
Run `dotnet run -c Release -- path\to\game_exefs_and_romfs_folder` to run official games (they need to be decrypted and extracted first!)
2018-05-11 23:17:43 +00:00
**Compatibility**
2018-07-11 22:08:20 +00:00
2018-05-11 23:17:43 +00:00
You can check out the compatibility list within the Wiki. Only a handful of games actually work.
**Latest build**
2018-02-10 19:51:07 +00:00
2018-06-10 23:44:48 +00:00
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).