Eglantine README

The project's README from github.com/Eglantine-Community/Eglantine. As one markdown file: README.md.


Eglantine
Eglantine

Eglantine is a free and opensource (FOSS) Switch 2 emulator, derived from Eden, Yuzu and Sudachi - started by developer Djihad Mahboubi. It's written in C++ with portability in mind, with builds for Windows, Linux and macOS

Discord

Compatibility | Development | Building | Download | Support | License

Compatibility

The emulator is capable of running Mario Kart World at full speed on most specs, Splatoon Raiders and OOT also run fine.

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

Development

For development discussions, please join us on Discord

If you would like to contribute, we are open to new developers and pull requests. Please ensure that your work is of a high standard and properly documented. You can also contact any of the developers on Discord or Stoat to learn more about the current state of the emulator.

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

Support

We currently do not take in any donations for the time being

If you would prefer to support us in a different way, please join our Discord

Star History

Star History Chart

License

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

Eglantine (Eglantine-Community/Eglantine)

Searching Database…

What is this?Eglantine is a free, open-source Nintendo Switch 2 emulator written in C++, derived from the Eden, Yuzu and Sudachi emulators.
How do I get it running?You can download the latest pre-built releases from the project's releases page, or build it yourself following the General Build Guide.
Does it actually run games well?The README calls it 'VERY experimental' and currently only lists Mario Kart World (decent to full speed depending on specs) and Splatoon Raiders (variable performance) as playable; a full compatibility list is not yet available.
Which platforms does it support?It has builds for Windows, Linux and macOS.
Who started this project?It was started by developer Camille LaVey.
Can I donate to support development?No, the project currently does not accept donations; you can support them by joining their Discord instead.
Size
210.2 MB
Stars
6.1K
Age
20d
Commits · 90 Days