chore: make yuzu REUSE compliant
[REUSE] is a specification that aims at making file copyright
information consistent, so that it can be both human and machine
readable. It basically requires that all files have a header containing
copyright and licensing information. When this isn't possible, like
when dealing with binary assets, generated files or embedded third-party
dependencies, it is permitted to insert copyright information in the
`.reuse/dep5` file.
Oh, and it also requires that all the licenses used in the project are
present in the `LICENSES` folder, that's why the diff is so huge.
This can be done automatically with `reuse download --all`.
The `reuse` tool also contains a handy subcommand that analyzes the
project and tells whether or not the project is (still) compliant,
`reuse lint`.
Following REUSE has a few advantages over the current approach:
- Copyright information is easy to access for users / downstream
- Files like `dist/license.md` do not need to exist anymore, as
`.reuse/dep5` is used instead
- `reuse lint` makes it easy to ensure that copyright information of
files like binary assets / images is always accurate and up to date
To add copyright information of files that didn't have it I looked up
who committed what and when, for each file. As yuzu contributors do not
have to sign a CLA or similar I couldn't assume that copyright ownership
was of the "yuzu Emulator Project", so I used the name and/or email of
the commit author instead.
[REUSE]: https://reuse.software
Follow-up to b2eb10382941bef0914f4a0a4685b9033440aa9f
2022-05-15 08:06:02 +08:00
<!--
2025-07-07 03:49:04 +08:00
# SPDX-FileCopyrightText: Copyright 2025 Eden Emulator Project
# SPDX-License-Identifier: GPL-3.0-or-later
2025-04-13 00:18:43 +08:00
# SPDX-FileCopyrightText: 2018 yuzu Emulator Project
# SPDX-License-Identifier: GPL-2.0-or-later
chore: make yuzu REUSE compliant
[REUSE] is a specification that aims at making file copyright
information consistent, so that it can be both human and machine
readable. It basically requires that all files have a header containing
copyright and licensing information. When this isn't possible, like
when dealing with binary assets, generated files or embedded third-party
dependencies, it is permitted to insert copyright information in the
`.reuse/dep5` file.
Oh, and it also requires that all the licenses used in the project are
present in the `LICENSES` folder, that's why the diff is so huge.
This can be done automatically with `reuse download --all`.
The `reuse` tool also contains a handy subcommand that analyzes the
project and tells whether or not the project is (still) compliant,
`reuse lint`.
Following REUSE has a few advantages over the current approach:
- Copyright information is easy to access for users / downstream
- Files like `dist/license.md` do not need to exist anymore, as
`.reuse/dep5` is used instead
- `reuse lint` makes it easy to ensure that copyright information of
files like binary assets / images is always accurate and up to date
To add copyright information of files that didn't have it I looked up
who committed what and when, for each file. As yuzu contributors do not
have to sign a CLA or similar I couldn't assume that copyright ownership
was of the "yuzu Emulator Project", so I used the name and/or email of
the commit author instead.
[REUSE]: https://reuse.software
Follow-up to b2eb10382941bef0914f4a0a4685b9033440aa9f
2022-05-15 08:06:02 +08:00
-->
2025-04-27 03:07:48 +08:00
<!-- lang: en - GB -->
chore: make yuzu REUSE compliant
[REUSE] is a specification that aims at making file copyright
information consistent, so that it can be both human and machine
readable. It basically requires that all files have a header containing
copyright and licensing information. When this isn't possible, like
when dealing with binary assets, generated files or embedded third-party
dependencies, it is permitted to insert copyright information in the
`.reuse/dep5` file.
Oh, and it also requires that all the licenses used in the project are
present in the `LICENSES` folder, that's why the diff is so huge.
This can be done automatically with `reuse download --all`.
The `reuse` tool also contains a handy subcommand that analyzes the
project and tells whether or not the project is (still) compliant,
`reuse lint`.
Following REUSE has a few advantages over the current approach:
- Copyright information is easy to access for users / downstream
- Files like `dist/license.md` do not need to exist anymore, as
`.reuse/dep5` is used instead
- `reuse lint` makes it easy to ensure that copyright information of
files like binary assets / images is always accurate and up to date
To add copyright information of files that didn't have it I looked up
who committed what and when, for each file. As yuzu contributors do not
have to sign a CLA or similar I couldn't assume that copyright ownership
was of the "yuzu Emulator Project", so I used the name and/or email of
the commit author instead.
[REUSE]: https://reuse.software
Follow-up to b2eb10382941bef0914f4a0a4685b9033440aa9f
2022-05-15 08:06:02 +08:00
2021-06-24 14:32:41 +08:00
< h1 align = "center" >
< br >
2025-07-10 04:51:15 +08:00
< a href = "https://git.eden-emu.dev/eden-emu/eden" > < img src = "https://git.eden-emu.dev/eden-emu/eden/raw/branch/master/dist/qt_themes/default/icons/256x256/eden_named.png" alt = "Eden" width = "200" > < / a >
2021-06-24 14:32:41 +08:00
< br >
2025-04-13 00:18:43 +08:00
< b > Eden< / b >
2021-06-24 14:32:41 +08:00
< br >
< / h1 >
2018-01-15 10:53:58 +08:00
2025-04-27 03:07:48 +08:00
< h4 align = "center" > < b > Eden< / b > is the world's most popular open-source Nintendo Switch emulator, forked from the Yuzu emulator — started by former Citron developer Camille LaVey and the Eden team.
2021-06-24 14:32:41 +08:00
< br >
2023-06-03 22:29:26 +08:00
It is written in C++ with portability in mind, and we actively maintain builds for Windows, Linux and Android.
2021-06-24 14:32:41 +08:00
< / h4 >
2016-01-16 15:30:22 +08:00
2021-06-24 14:32:41 +08:00
< p align = "center" >
2025-05-11 00:53:03 +08:00
< / a >
< a href = "https://discord.gg/kXAmGCXBGD" >
< img src = "https://img.shields.io/discord/1317386222229917696?color=5865F2&label=Eden&logo=discord&logoColor=white"
alt="Discord">
< / a >
2021-06-24 14:32:41 +08:00
< / p >
2014-04-29 00:21:41 +08:00
2021-06-24 14:32:41 +08:00
< 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 >
2019-09-22 05:37:21 +08:00
2021-06-24 14:32:41 +08:00
## Compatibility
2014-12-16 09:34:44 +08:00
2025-04-13 00:18:43 +08:00
The emulator is capable of running most commercial games at full speed, provided you meet the necessary hardware requirements.
2014-04-09 03:05:45 +08:00
2025-04-27 03:07:48 +08:00
A list of supported games will be available in future. Please be patient.
2016-02-25 15:42:34 +08:00
2025-07-10 04:51:15 +08:00
Check out our [website ](https://eden-emu.dev ) for the latest news on exciting features, monthly progress reports, and more!
2014-04-09 03:05:45 +08:00
2021-06-24 14:32:41 +08:00
## Development
2014-04-09 03:05:45 +08:00
2025-07-10 04:51:15 +08:00
Most of the development happens on our Git server. It is also where [our central repository ](https://git.eden-emu.dev/eden-emu/eden ) is hosted. For development discussions, please join us on [Discord ](https://discord.gg/edenemu ).
2014-04-09 03:05:45 +08:00
2025-04-27 03:07:48 +08:00
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 to learn more about the current state of the emulator.
2020-01-26 07:26:07 +08:00
2021-06-24 14:32:41 +08:00
## Building
2014-04-09 03:05:45 +08:00
2025-04-27 06:32:42 +08:00
* **Windows**: [Windows Building Guide ](https://git.eden-emu.dev/eden-emu/eden/wiki/Building-for-Windows.- )
* **Linux**: [Linux Building Guide ](https://git.eden-emu.dev/eden-emu/eden/wiki/Building-for-Linux.- )
* **Android**: [Android Building Guide ](https://git.eden-emu.dev/eden-emu/eden/wiki/Building-for-Android.- )
2014-12-16 09:01:56 +08:00
2021-06-24 14:32:41 +08:00
## Download
2014-12-16 09:01:56 +08:00
2025-07-10 04:51:15 +08:00
You will be able to download the latest releases from [here ](https://github.com/eden-emulator/Releases/releases ).
2021-06-24 14:32:41 +08:00
## Support
2025-07-10 04:51:15 +08:00
If you enjoy the project and would like to support us financially, please check out our developers' [donation pages ](https://eden-emu.dev/donations.html )!
2021-06-24 14:32:41 +08:00
2025-04-27 03:07:48 +08:00
Any donations received will go towards things such as:
2018-01-14 06:28:52 +08:00
* Switch consoles to explore and reverse-engineer the hardware
* Switch games for testing, reverse-engineering, and implementing new features
* Web hosting and infrastructure setup
2025-04-27 03:07:48 +08:00
* Additional hardware (e.g. GPUs as needed to improve rendering support, other peripherals to add support for, etc.)
2025-05-10 23:38:06 +08:00
* CI Infrastructure
2018-01-14 06:28:52 +08:00
2025-07-07 03:46:49 +08:00
If you would prefer to support us in a different way, please join our [Discord ](https://discord.gg/edenemu ), once public, and talk to Camille or any of our other developers.
2021-06-24 14:32:41 +08:00
## License
2025-04-13 00:18:43 +08:00
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.
