mirror of
https://git.eden-emu.dev/eden-emu/eden.git
synced 2026-08-19 06:31:29 +00:00
lizzie
0465292a81
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>
91 lines
2.7 KiB
Markdown
91 lines
2.7 KiB
Markdown
<!--
|
|
# SPDX-FileCopyrightText: Copyright 2025 Eden Emulator Project
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
# SPDX-FileCopyrightText: 2018 yuzu Emulator Project
|
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
|
-->
|
|
<!-- lang: en-GB -->
|
|
|
|
<h1 align="center">
|
|
<br>
|
|
<a href="https://git.eden-emu.dev/eden-emu/eden"><img src="./dist/qt_themes/default/icons/256x256/eden.png" alt="Eden" width="200"></a>
|
|
<br>
|
|
<b>Eden</b>
|
|
<br>
|
|
</h1>
|
|
|
|
<h4 align="center"><b>Eden</b> is a free and opensource (FOSS) Switch 1 emulator started by developer Camille LaVey.
|
|
<br>
|
|
Written in C++, with builds for Windows, Linux, macOS, Android, FreeBSD and more.
|
|
</h4>
|
|
|
|
<p align="center">
|
|
</a>
|
|
<a href="https://discord.gg/HstXbPch7X">
|
|
<img src="https://img.shields.io/discord/1367654015269339267?color=5865F2&label=Eden&logo=discord&logoColor=white"
|
|
alt="Discord">
|
|
</a>
|
|
<a href="https://stt.gg/qKgFEAbH">
|
|
<img src="https://img.shields.io/revolt/invite/qKgFEAbH?color=d61f3a&label=Stoat"
|
|
alt="Stoat">
|
|
</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="#compatibility">Compatibility</a> |
|
|
<a href="#development">Development</a> |
|
|
<a href="#building">Building</a> |
|
|
<a href="#download">Download</a> |
|
|
<a href="#support">Support</a> |
|
|
<a href="#license">License</a>
|
|
</p>
|
|
|
|
## 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](https://eden-emu.dev) for the latest news on exciting features, monthly progress reports, and more!
|
|
|
|
[](https://repology.org/project/eden-emulator/versions)
|
|
|
|
## Contribute
|
|
|
|
To contribute to Eden; be it financially, code, bug reports, or otherwise, see our [Contributing guidelines](./CONTRIBUTING.md).
|
|
|
|
## Documentation
|
|
|
|
We have a user manual! See our [User Handbook](./docs/user/README.md).
|
|
|
|
## Building
|
|
|
|
See the [General Build Guide](docs/Build.md)
|
|
|
|
For information on provided development tooling, see the [Tools directory](./tools)
|
|
|
|
## Download
|
|
|
|
You can download the latest releases from [our release page](https://git.eden-emu.dev/eden-emu/eden/releases).
|
|
|
|
Save us some bandwidth! We have [mirrors available](./docs/user/ThirdParty.md#mirrors) as well.
|
|
|
|
## License
|
|
|
|
Eden is licensed under the GPLv3 (or any later version). Refer to the [LICENSE.txt](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/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
|