The Eden Nintendo Switch Emulator
  • C++ 64%
  • cpp 25.6%
  • POV-Ray SDL 4.5%
  • Kotlin 3.6%
  • CMake 0.9%
  • Other 1.3%
Find a file
lizzie 0465292a81
Some checks are pending
tx-src / sources (push) Waiting to run
Check Strings / check-strings (push) Waiting to run
[docs] overview doc for newcomers (#4266)
Signed-off-by: lizzie <lizzie@eden-emu.dev>

- [x] I have read and followed the [Contribution Guidelines](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/CONTRIBUTING.md#code-contributions).
- [x] I have read and followed the [AI Policy](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/docs/policies/AI.md)
- [x] I have read and followed the [Coding Guidelines](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/docs/policies/Coding.md) to the best of my ability.

-------------------

documents basic stuff about the emu and "hey eden is HLE" (like most yuzu forks!)

Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/4266
Reviewed-by: CamilleLaVey <camillelavey99@gmail.com>
Reviewed-by: Maufeat <sahyno1996@gmail.com>
2026-08-18 19:00:26 +02:00
.ci [tools] refactor, use #!/bin/sh, update license files (#3998) 2026-05-22 21:15:31 +02:00
.forgejo/workflows [ci] Only update translations once a week (#4256) 2026-08-08 05:46:52 +02:00
.github [forgejo] Replace mentions of yuzu in issue templates with eden (#3842) 2026-08-10 03:55:03 +02:00
.patch [cmake] CPMUtil rewrite of the day number 852 (#4130) 2026-07-06 23:11:39 +02:00
.reuse [qt] nuke game compat list (again) (#4201) 2026-07-12 09:32:11 +02:00
.tx [cmake] feat: FFmpeg CI, allow 16kb android builds, update translations for transifex (#2543) 2025-09-23 19:38:11 +02:00
CMakeModules [cmake] Simplify DetectPlatform and normalize platform names (#4183) 2026-08-10 04:57:38 +02:00
dist [dist, android] Update translations from Transifex for Aug 17 (#4267) 2026-08-17 23:02:25 +02:00
docs [docs] overview doc for newcomers (#4266) 2026-08-18 19:00:26 +02:00
externals [cmake] Simplify DetectPlatform and normalize platform names (#4183) 2026-08-10 04:57:38 +02:00
hooks [tools] refactor, use #!/bin/sh, update license files (#3998) 2026-05-22 21:15:31 +02:00
LICENSES general: fix trailing whitespace 2024-01-08 09:34:32 -05:00
src [hle/service] stub missing homebrew services, fix NPad/caps crashes (#4264) 2026-08-18 18:11:33 +02:00
tools [fmt] use {#:x} instead of 0x{:#x} (#4170) 2026-07-25 21:47:07 +02:00
.codespellrc core: refactor emulated cpu core activation 2023-12-04 10:37:16 -05:00
.git-blame-ignore-revs Skip git blame 2023-11-04 18:26:49 +00:00
.gitattributes chore: make yuzu REUSE compliant 2022-07-27 12:53:49 +02:00
.gitignore [video_core, hle] remove redundant parent references in system structs (#3908) 2026-06-23 06:31:25 +02:00
.shellcheckrc [tools, cmake] refactor: update/hash check scripts, use tags for some more deps, proper CPMUtil separation (#2666) 2025-10-05 03:04:53 +02:00
AGENTS.md [docs] Tighten AI restrictions and switch to CONTRIBUTING.md (#4193) 2026-07-09 23:06:46 +02:00
CLAUDE.md [docs] Tighten AI restrictions and switch to CONTRIBUTING.md (#4193) 2026-07-09 23:06:46 +02:00
CMakeLists.txt [cmake] drop invalid c98 warning suppression (#4269) 2026-08-18 00:56:26 +02:00
CONTRIBUTING.md [meta] Discourage profanity usage (#4239) 2026-08-09 02:53:16 +02:00
cpmfile.json Revert "[externals] remove SPIRV-Headers and SPIRV-Tools (#3989)" (#4247) 2026-08-04 02:03:18 +02:00
Doxyfile chore: make yuzu REUSE compliant 2022-07-27 12:53:49 +02:00
LICENSE.txt chore: make yuzu REUSE compliant 2022-07-27 12:53:49 +02:00
README.md [docs] overview doc for newcomers (#4266) 2026-08-18 19:00:26 +02:00
shell.nix Revert "[externals] remove SPIRV-Headers and SPIRV-Tools (#3989)" (#4247) 2026-08-04 02:03:18 +02:00


Eden
Eden

Eden is a free and opensource (FOSS) Switch 1 emulator started by developer Camille LaVey.
Written in C++, with builds for Windows, Linux, macOS, Android, FreeBSD and more.

Discord Stoat

Compatibility | Development | Building | Download | Support | License

Compatibility

The emulator is capable of running most commercial games at full speed, provided you meet the necessary hardware requirements.

A list of supported games will be available in future. Please be patient.

Check out our website for the latest news on exciting features, monthly progress reports, and more!

Packaging status

Contribute

To contribute to Eden; be it financially, code, bug reports, or otherwise, see our Contributing guidelines.

Documentation

We have a user manual! See our User Handbook.

Building

See the General Build Guide

For information on provided development tooling, see the Tools directory

Download

You can download the latest releases from our release page.

Save us some bandwidth! We have mirrors available as well.

License

Eden is licensed under the GPLv3 (or any later version). Refer to the LICENSE.txt file.

Special thanks

Super special thanks to Cloudflare for preventing the git server from blowing up.

  • Yuzu
  • Ryujinx
  • Sudachi
  • Citron
  • Torzu
  • Suyu
  • Ryubing

And everyone who continues or had contributed to the project! <3