Files
2026-11-08 21:37:46 +01:00
..
2026-11-08 21:33:04 +01:00
2026-11-08 21:36:49 +01:00
2026-11-08 21:33:04 +01:00
2026-11-08 21:37:46 +01:00
2026-11-08 21:36:49 +01:00
2026-11-08 21:33:04 +01:00
2026-11-08 21:33:04 +01:00
2026-11-08 18:05:37 +01:00
2026-11-08 21:37:46 +01:00
2026-11-08 21:33:04 +01:00
2026-11-08 21:33:04 +01:00
2026-11-08 21:33:04 +01:00
2026-11-08 21:33:04 +01:00
2026-11-08 21:33:04 +01:00
2026-11-08 21:33:04 +01:00
2026-11-08 21:33:04 +01:00

---
title: Eglantine Documentation
description: Developer documentation for the Eglantine Switch 2 emulator
---

# Eglantine Documentation

Are you just a casual user? Take a look at our [User Handbook](./user) then!

If you want to register/signup as a contributor, take a gander at [CONTRIBUTING.md](https://github.com/Eglantine-Community/Eglantine/blob/master/CONTRIBUTING.md).

This contains documentation created by developers, build instructions, guidelines, instructions/layouts for [cool stuff we made](./CPMUtil.mdx), and more.

* **[General Build Instructions](./Build.mdx)**
* **[CMake Options](./Options.mdx)**
* **[Cross Compiling](./CrossCompile.mdx)**
* **[Development Guidelines](./Development.mdx)**
* **[Dependencies](./Deps.mdx)**
* **[Debug Guidelines](./Debug.mdx)**
  * **[RenderDoc](./Debug.mdx#renderdoc)**
* **[CPM - CMake Package Manager](./CPMUtil.mdx)**
* **[Platform-Specific Caveats](./Caveats.mdx)**
* **[The NVIDIA SM86 (Maxwell) GPU](./NvidiaGpu.mdx)**
* **[Driver Bugs](./DriverBugs.mdx)**
* **[Building Older Commits](./build/OlderCommits.mdx)**
* **Subsystems:**
  * **[Design Overview](./DesignOverview.mdx)**
  * **[Dynarmic](./dynarmic/README.mdx)**
  * **[HOS Kernel](./HosKernel.mdx)**
  * **[Settings](./Settings.mdx)**

## Policies

Policies and information on development.

* **[AI and LLM Usage](./policies/AI.mdx)**
* **[Coding guidelines](./policies/Coding.mdx)**
* **[Contributing](https://github.com/Eglantine-Community/Eglantine/blob/master/CONTRIBUTING.md)**

## Externals

Other useful resources in general, take a quick read if you need.

* **[SwitchBrew](https://switchbrew.org/wiki/Main_Page)**
* **[IPS file format](https://zerosoft.zophar.net/ips.php)**
* **[IPSwitch file format](https://github.com/3096/ipswitch)**