mirror of
https://github.com/Ryujinx-NX/Ryujinx.git
synced 2024-11-14 21:17:43 -07:00
d306115750
* Logging: Refactor log targets into Ryujinx.Common * Logger: Implement JSON Log Target * Logger: Optimize Console/File logging targets Implement a simple ObjectPool to pool up StringBuilders to avoid causing excessive GCing of gen1/2 items when large amounts of log entries are being generated. We can also pre-determine the async overflow action at initialization time, allowing for an easy optimization in the message enqueue function, avoiding a number of comparisons. * Logger: Implement LogFormatters * Config: Refactor configuration file and loading * Config: Rename to .jsonc to avoid highlighting issues in VSC and GitHub * Resolve style nits * Config: Resolve incorrect default key binding * Config: Also update key binding default in schema * Tidy up namespace imports * Config: Update CONFIG.md to reflect new Config file
48 lines
2.1 KiB
Markdown
48 lines
2.1 KiB
Markdown
|
|
# Ryujinx [](https://ci.appveyor.com/project/gdkchan/ryujinx)
|
|
|
|
Experimental Switch emulator written in C#
|
|
|
|
Many games boot, only a handful are playable, see the compatiblity list [here](https://github.com/Ryujinx/Ryujinx-Games-List/issues).
|
|
|
|
**Building**
|
|
|
|
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, see [CONFIG.md](CONFIG.md)
|
|
|
|
- Controller Input is supported, see [CONFIG.md](CONFIG.md)
|
|
|
|
- Config File: `Config.jsonc` 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 keep whatever is making app / game not work on the watch list and fix it at a later date.
|
|
|
|
**Contact**
|
|
|
|
For help, support, suggestions, or if you just want to get in touch with the team; join our [Discord server](https://discord.gg/N2FmfVc)!
|
|
|
|
For donation support, please take a look at our [Patreon](https://www.patreon.com/ryujinx).
|
|
|
|
**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 project folder to run homebrew apps.
|
|
Run `dotnet run -c Release -- path\to\game.nsp/xci` to run official games.
|
|
|
|
**Compatibility**
|
|
|
|
You can check out the compatibility list [here](https://github.com/Ryujinx/Ryujinx-Games-List/issues).
|
|
|
|
**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, Mac, and Linux can be found on the [official website](https://ryujinx.org/#/Build).
|