Ryujinx/docs
piplup caf0db0f52
Added Virtual Boy
it crashes to missing services but gets no further with ignore missing services hangs on a black screen ```00:00:03.223 |E| HLE.OsThread.47 Application : Unhandled exception caught: Ryujinx.HLE.Exceptions.ServiceNotImplementedException: Ryujinx.HLE.HOS.Services.Am.AppletAE.AllSystemAppletProxiesService.SystemAppletProxy.ICommonStateGetter: 130

Guest Stack Trace:
Process: Service, PID: 128
Thread ID: 47

Raw Request Data:
00000000   01 00 10 00 05 00 00 00  00 00 00 00 00 00 00 00   ················
00000010   53 46 43 49 01 00 00 00  82 00 00 00 00 00 00 00   SFCI····‚·······
00000020   00 00 00 00 00 00 00 00                            ········

   at Ryujinx.HLE.HOS.Services.IpcService.CallCmifMethod(ServiceCtx context) in /home/runner/work/src/src/src/Ryujinx.HLE/HOS/Services/IpcService.cs:line 184
   at Ryujinx.HLE.HOS.Services.ServerBase.Process(Int32 serverSessionHandle, UInt64 recvListAddr) in /home/runner/work/src/src/src/Ryujinx.HLE/HOS/Services/ServerBase.cs:line 373
   at Ryujinx.HLE.HOS.Services.ServerBase.ServerLoop() in /home/runner/work/src/src/src/Ryujinx.HLE/HOS/Services/ServerBase.cs:line 255
   at Ryujinx.HLE.HOS.Services.ServerBase.Main() in /home/runner/work/src/src/src/Ryujinx.HLE/HOS/Services/ServerBase.cs:line 173
   at Ryujinx.HLE.HOS.Kernel.Threading.KThread.ThreadStart() in /home/runner/work/src/src/src/Ryujinx.HLE/HOS/Kernel/Threading/KThread.cs:line 1296
   at System.Threading.Thread.StartCallback()00:00:03.223 |E| HLE.OsThread.47 Application : Unhandled exception caught: Ryujinx.HLE.Exceptions.ServiceNotImplementedException: Ryujinx.HLE.HOS.Services.Am.AppletAE.AllSystemAppletProxiesService.SystemAppletProxy.ICommonStateGetter: 130

Guest Stack Trace:
Process: Service, PID: 128
Thread ID: 47

Raw Request Data:
00000000   01 00 10 00 05 00 00 00  00 00 00 00 00 00 00 00   ················
00000010   53 46 43 49 01 00 00 00  82 00 00 00 00 00 00 00   SFCI····‚·······
00000020   00 00 00 00 00 00 00 00                            ········

   at Ryujinx.HLE.HOS.Services.IpcService.CallCmifMethod(ServiceCtx context) in /home/runner/work/src/src/src/Ryujinx.HLE/HOS/Services/IpcService.cs:line 184
   at Ryujinx.HLE.HOS.Services.ServerBase.Process(Int32 serverSessionHandle, UInt64 recvListAddr) in /home/runner/work/src/src/src/Ryujinx.HLE/HOS/Services/ServerBase.cs:line 373
   at Ryujinx.HLE.HOS.Services.ServerBase.ServerLoop() in /home/runner/work/src/src/src/Ryujinx.HLE/HOS/Services/ServerBase.cs:line 255
   at Ryujinx.HLE.HOS.Services.ServerBase.Main() in /home/runner/work/src/src/src/Ryujinx.HLE/HOS/Services/ServerBase.cs:line 173
   at Ryujinx.HLE.HOS.Kernel.Threading.KThread.ThreadStart() in /home/runner/work/src/src/src/Ryujinx.HLE/HOS/Kernel/Threading/KThread.cs:line 1296
   at System.Threading.Thread.StartCallback()```
2026-02-17 11:56:05 +00:00
..
coding-guidelines [INFRA] Addition of basic contributor guides and docs framework. (#5581) 2023-09-22 16:21:11 +02:00
workflow misc: chore: Link to Ryubing/Ryujinx in markdown docs 2025-01-26 14:28:55 -06:00
compatibility.csv Added Virtual Boy 2026-02-17 11:56:05 +00:00
README.md chore: SDL3 (ryubing/ryujinx!207) 2025-11-07 14:43:48 -06:00
shell.png replace shell 2025-03-17 05:51:20 +00:00

Documents Index

This repo includes several documents that explain both high-level and low-level concepts about Ryujinx and its functions. These are very useful for contributors, to get context that can be very difficult to acquire from just reading code.

Intro to Ryujinx

Ryujinx is an open-source Nintendo Switch emulator, created by gdkchan, written in C#.

  • The CPU emulator, ARMeilleure, emulates an ARMv8 CPU and currently has support for most 64-bit ARMv8 and some of the ARMv7 (and older) instructions.
  • The GPU emulator emulates the Switch's Maxwell GPU using either the OpenGL (version 4.5 minimum), Vulkan, or Metal (via MoltenVK) APIs through a custom build of OpenTK or Silk.NET respectively.
  • Audio output is entirely supported via C# wrappers for SDL3, with OpenAL & libsoundio as fallbacks.

Getting Started

Contributing (Building, testing, benchmarking, profiling, etc.)

If you want to contribute a code change to this repo, start here.

Coding Guidelines

Project Docs

To be added. Many project files will contain basic XML docs for key functions and classes in the meantime.