Experimental Nintendo Switch Emulator written in C#
Find a file
gdkchan f77694e4f7
Implement a new physical memory manager and replace DeviceMemory (#856)
* Implement a new physical memory manager and replace DeviceMemory

* Proper generic constraints

* Fix debug build

* Add memory tests

* New CPU memory manager and general code cleanup

* Remove host memory management from CPU project, use Ryujinx.Memory instead

* Fix tests

* Document exceptions on MemoryBlock

* Fix leak on unix memory allocation

* Proper disposal of some objects on tests

* Fix JitCache not being set as initialized

* GetRef without checks for 8-bits and 16-bits CAS

* Add MemoryBlock destructor

* Throw in separate method to improve codegen

* Address PR feedback

* QueryModified improvements

* Fix memory write tracking not marking all pages as modified in some cases

* Simplify MarkRegionAsModified

* Remove XML doc for ghost param

* Add back optimization to avoid useless buffer updates

* Add Ryujinx.Cpu project, move MemoryManager there and remove MemoryBlockWrapper

* Some nits

* Do not perform address translation when size is 0

* Address PR feedback and format NativeInterface class

* Remove ghost parameter description

* Update Ryujinx.Cpu to .NET Core 3.1

* Address PR feedback

* Fix build

* Return a well defined value for GetPhysicalAddress with invalid VA, and do not return unmapped ranges as modified

* Typo
2020-05-04 08:54:50 +10:00
.github Also use Github Actions as a CI" (#847) 2019-12-23 06:36:24 +11:00
ARMeilleure Implement a new physical memory manager and replace DeviceMemory (#856) 2020-05-04 08:54:50 +10:00
Ryujinx Fix issues causing keyboard profiles to throw errors on load. (#1206) 2020-05-03 20:42:17 +02:00
Ryujinx.Audio Update .NET Core to 3.1, and update NuGet Packages (#1121) 2020-04-22 14:13:41 +10:00
Ryujinx.Common system: Make index 0 of keyboards in configuration 'all keyboards' 2020-05-03 15:00:29 +02:00
Ryujinx.Cpu Implement a new physical memory manager and replace DeviceMemory (#856) 2020-05-04 08:54:50 +10:00
Ryujinx.Debugger Use the official JSON parser (#1151) 2020-04-30 14:07:41 +02:00
Ryujinx.Graphics.GAL Fix depth clamp enable bit, unit scale for polygon offset. (#1178) 2020-04-30 11:47:24 +10:00
Ryujinx.Graphics.Gpu Implement a new physical memory manager and replace DeviceMemory (#856) 2020-05-04 08:54:50 +10:00
Ryujinx.Graphics.Nvdec Update .NET Core to 3.1, and update NuGet Packages (#1121) 2020-04-22 14:13:41 +10:00
Ryujinx.Graphics.OpenGL Fix depth clamp enable bit, unit scale for polygon offset. (#1178) 2020-04-30 11:47:24 +10:00
Ryujinx.Graphics.Shader Fix mode and Reg08.H1 decoding on XMAD instruction (#1156) 2020-04-25 23:40:29 +10:00
Ryujinx.Graphics.Texture Fix texture level offset/size calculation when sparse tile width is > 1 (#1142) 2020-04-25 23:40:20 +10:00
Ryujinx.HLE Implement a new physical memory manager and replace DeviceMemory (#856) 2020-05-04 08:54:50 +10:00
Ryujinx.LLE Update .NET Core to 3.1, and update NuGet Packages (#1121) 2020-04-22 14:13:41 +10:00
Ryujinx.Memory Implement a new physical memory manager and replace DeviceMemory (#856) 2020-05-04 08:54:50 +10:00
Ryujinx.Memory.Tests Implement a new physical memory manager and replace DeviceMemory (#856) 2020-05-04 08:54:50 +10:00
Ryujinx.ShaderTools Update .NET Core to 3.1, and update NuGet Packages (#1121) 2020-04-22 14:13:41 +10:00
Ryujinx.Tests Implement a new physical memory manager and replace DeviceMemory (#856) 2020-05-04 08:54:50 +10:00
Ryujinx.Tests.Unicorn Update .NET Core to 3.1, and update NuGet Packages (#1121) 2020-04-22 14:13:41 +10:00
.editorconfig Adding .editorconfig so code style can be consistent and localized (#1131) 2020-05-03 00:58:58 +02:00
.gitattributes aloha 2018-02-04 20:08:20 -03:00
.gitignore Implement ContentManager and related services (#438) 2018-11-18 17:37:41 -02:00
.travis.yml Update .NET Core to 3.1, and update NuGet Packages (#1121) 2020-04-22 14:13:41 +10:00
appveyor.yml Update .NET Core to 3.1, and update NuGet Packages (#1121) 2020-04-22 14:13:41 +10:00
CONFIG.md Use the Joystick interface for game controller input. (#737) 2019-08-05 20:58:27 +02:00
KEYS.md Rename "RyuFs" directory to "Ryujinx" and use the same savedata system the Switch uses (#801) 2020-01-05 12:49:44 +01:00
LICENSE.txt Update license (#788) 2019-10-12 23:48:31 -03:00
README.md Update .NET Core to 3.1, and update NuGet Packages (#1121) 2020-04-22 14:13:41 +10:00
Ryujinx.sln Implement a new physical memory manager and replace DeviceMemory (#856) 2020-05-04 08:54:50 +10:00
Ryujinx.sln.DotSettings Add features to GUI (#757) 2019-11-29 15:32:51 +11:00

Ryujinx

An Experimental Switch emulator written in C#

A lot of games boot, but only some are playable. See the compatiblity list here.

Usage

To run this emulator, you need the .NET Core 3.1 (or higher) SDK.

If you use a pre-built version, you can use the graphical interface to run your games and homebrew.

If you build it yourself you will need to: 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.

Every file related to Ryujinx is stored in the Ryujinx folder. Located in C:\Users\USERNAME\AppData\Roaming\ for Windows, /home/USERNAME/.config for Linux or /Users/USERNAME/Library/Application Support/ for macOS. It can also be accessed by clicking Open Ryujinx Folder under the File menu in the GUI.

Latest build

These builds are compiled automatically for each commit on the master branch, and may be unstable or completely broken.

The latest automatic build for Windows, macOS, and Linux can be found on the Official Website.

Requirements

  • Switch Keys

    Everything on the Switch is encrypted, so if you want to run anything other than homebrew, you have to dump encryption keys from your console. To get more information please take a look at our Keys Documentation.

  • System Titles

    Some of our System Module implementations, like time, require System Data Archives. You can install them by mounting your nand partition using HacDiskMount and copying the content to Ryujinx/bis/system.

  • Executables

    Ryujinx is able to run both official games and homebrew.

    Homebrew is available on many websites, such as the Switch Appstore.

    A hacked Nintendo Switch is needed to dump games, which you can learn how to do here. Once you have hacked your Nintendo Switch, you will need to dump your own games with NxDumpTool to get an XCI or NSP dump.

Features

  • Audio

    Everything for audio is partially supported. We currently use a C# wrapper for libsoundio, and we support OpenAL (installation needed) too as a fallback. Our current Opus implementation is pretty incomplete.

  • CPU

    The CPU emulator, ARMeilleure, emulates an ARMv8 CPU, and currently only has support for the new 64-bit ARMv8 instructions (with a few instructions still missing). It translates the ARM code to a custom IR, performs a few optimizations, and turns that into x86 code. To handle that, we use our own JIT called ARMeilleure, which uses the custom IR and compiles the code to x86.

  • GPU

    The GPU emulator emulates the Switch's Maxwell GPU using the OpenGL API (version 4.2 minimum) through a custom build of OpenTK.

  • Input

    We currently have support for keyboard, mouse, touch input, JoyCon input support emulated through the keyboard, and some controllers too. You can set up everything inside the configuration menu.

  • Configuration

    The emulator has settings for dumping shaders, enabling or disabling some logging, remapping controllers, and more. You can configure all of them through the graphical interface or manually through the config file, Config.json.

    For more information you can go here (Outdated).

Compatibility

You can check out the compatibility list here.

Don't hesitate to open a new issue if a game isn't already on there.

Help

If you have homebrew that currently doesn't work within the emulator, you can contact us through our Discord with the .NRO/.NSO and source code, if possible. We'll take note of whatever is causing the app/game to not work, on the watch list and fix it at a later date.

If you need help with setting up Ryujinx, you can ask questions in the support channel of our Discord server.

Contact

If you have contributions, need support, have suggestions, or just want to get in touch with the team, join our Discord server!

If you'd like to donate, please take a look at our Patreon.