Files
Kenji-NX/docs/README.md
T
KeatonTheBotandMaki 251b65771a Update SDL2 to SDL3
- Fix: Crash when connecting a JoyCon

- Fix: Make controller GUIDs match old SDL2 GUIDs

- Fix: Detect face button layout for gamepads

Co-authored-by: Maki <77-maki@users.noreply.git.ryujinx.app>
2026-04-14 22:13:05 -05:00

1.5 KiB

Documents Index

This repo includes several documents that explain both high-level and low-level concepts about Kenji-NX 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 Kenji-NX

Kenji-NX is an open-source Nintendo Switch emulator written in C#. It is based on Ryujinx, which was originally created by gdkchan.

  • 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.