Lichii README

The project's README from github.com/zortos293/Lichii. 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 Camille LaVey. It's written in C++ with portability in mind, with builds for Windows, Linux and macOS

Discord

[!NOTE] This is an unofficial fork of Eglantine maintained by Zortos. It carries fixes that are not in the upstream Eglantine repository. Please report problems with this build here, not to the upstream developers.

About this fork

My priority is getting every game to boot and run. Performance comes second.

Changes in this fork compared to upstream:

About this fork | Compatibility | Development | Building | Download | Support | License

Compatibility

The emulator is capable of running Mario Kart World at decent/full speed depending on specs and configurations, and Splatoon Raiders at variable performances

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

Builds of this fork are on the releases page.

Official upstream releases are 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

License

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

Lichii (zortos293/Lichii)

Searching Database…

614 ·GitHub
What is this?Eglantine is a free and open-source (FOSS) emulator for the Nintendo Switch 2, derived from the Eden, Yuzu and Sudachi emulators. This specific repository is an unofficial fork maintained by Zortos that adds fixes not yet in the upstream Eglantine project.
Is this a desktop application or a library I'd embed somewhere?It's a native desktop application written in C++ that you install and run directly on your computer, not a library or SDK.
How do I get it running?Download a prebuilt build from this fork's releases page, or build it yourself from source using the General Build Guide linked in the README.
Is this ready to play my games on?No - the project is explicitly labeled 'VERY experimental', and only a few titles like Mario Kart World and Splatoon Raiders are confirmed to run reasonably well; a full compatibility list is still being prepared.
Which operating systems does it support?It builds and runs on Windows, Linux and macOS.
What does this fork fix compared to upstream Eglantine?It fixes a memory leak that kept usage around 4-5 GB instead of climbing past 20 GB, makes more games boot (including Welcome Tour), restores normal game speed, pushes most games toward 60 FPS, and fixes several texture issues and an HDR color bug in docked mode.
Which games actually run well?Mario Kart World runs at decent to full speed depending on your hardware, and Splatoon Raiders runs at variable performance; a complete list of supported games is still being compiled.
Who started the original project behind this fork?The original Eglantine emulator was started by developer Camille LaVey; this repository is Zortos's independently maintained fork built on top of it.
Creator
zortos293
Size
251.2 MB
Stars
614
Updated
CommitNov 03
Age
3d
Commits · 90 Days