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 02:06:02 +02:00
<!--
2025-04-12 16:18:43 +00:00
# SPDX-FileCopyrightText: 2018 yuzu Emulator Project
# SPDX-License-Identifier: GPL-2.0-or-later
# SPDX-FileCopyrightText: 2025 EDEN Emulator Project
# SPDX-License-Identifier: GPL-3.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 02:06:02 +02:00
-->
2021-06-23 23:32:41 -07:00
< h1 align = "center" >
< br >
2025-04-12 16:18:43 +00:00
< a href = "https://git.eden-emu.dev/eden-emu/eden" > < img src = "https://git.eden-emu.dev/eden-emu/eden/raw/commit/6ed4bcea0ddb70fe95cb03547eee8e5e70325859/dist/yuzu.svg" alt = "Eden" width = "200" > < / a >
2021-06-23 23:32:41 -07:00
< br >
2025-04-12 16:18:43 +00:00
< b > Eden< / b >
2021-06-23 23:32:41 -07:00
< br >
< / h1 >
2018-01-14 21:53:58 -05:00
2025-04-12 17:05:56 +00:00
< h4 align = "center" > < b > Eden< / b > is the world's most popular, open-source, Nintendo Switch emulator forked from Yuzu emulator — started by the former Citron developer Camille LeVey and the Eden team< / a > .
2021-06-23 23:32:41 -07:00
< br >
2023-06-03 16:29:26 +02:00
It is written in C++ with portability in mind, and we actively maintain builds for Windows, Linux and Android.
2021-06-23 23:32:41 -07:00
< / h4 >
2016-01-15 23:30:22 -08:00
2021-06-23 23:32:41 -07:00
< p align = "center" >
< / a >
2025-04-12 16:18:43 +00:00
Discord is not yet public.
2021-06-23 23:32:41 -07:00
< / a >
< / p >
2014-04-28 12:21:41 -04:00
2021-06-23 23:32:41 -07: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-21 23:37:21 +02:00
2021-06-23 23:32:41 -07:00
## Compatibility
2014-12-16 02:34:44 +01:00
2025-04-12 16:18:43 +00:00
The emulator is capable of running most commercial games at full speed, provided you meet the necessary hardware requirements.
2014-04-08 15:05:45 -04:00
2025-04-12 16:18:43 +00:00
For a list of games yuzu supports, please be patient as this will come eventually.
2016-02-25 01:42:34 -06:00
2025-04-12 16:18:43 +00:00
Check out our [website ](W.I.P ) for the latest news on exciting features, monthly progress reports, and more!
2014-04-08 15:05:45 -04:00
2021-06-23 23:32:41 -07:00
## Development
2014-04-08 15:05:45 -04:00
2025-04-12 16:18:43 +00:00
Most of the development happens on our git. It's also where [our central repository ](https://git.eden-emu.dev/eden-emu/eden ) is hosted. For development discussion, please wait join us on [Discord ](W.I.P ) once it's public.
2016-06-21 14:19:46 +02:00
2025-04-12 16:18:43 +00:00
If you want to contribute we are open to new devs and prs, please make sure your work is of a high standard and you have properly documented it.
2021-06-23 23:32:41 -07:00
You can also contact any of the developers on Discord in order to know about the current state of the emulator.
2014-04-08 15:05:45 -04:00
2021-06-23 23:32:41 -07:00
If you want to contribute to the user interface translation project, please check out the [yuzu project on transifex ](https://www.transifex.com/yuzu-emulator/yuzu ). We centralize translation work there, and periodically upstream translations.
2020-01-26 00:26:07 +01:00
2021-06-23 23:32:41 -07:00
## Building
2014-04-08 15:05:45 -04:00
2025-04-12 16:18:43 +00:00
* __Windows__: [Windows Building Guide ](W.I.P )
* __Linux__: [Linux Building Guide ](W.I.P )
* __Android__: [Android Building Guide ](W.I.P )
2014-12-15 20:01:56 -05:00
2021-06-23 23:32:41 -07:00
## Download
2014-12-15 20:01:56 -05:00
2025-04-12 16:18:43 +00:00
You can download the latest releases from [here ](https://git.eden-emu.dev/eden-emu/eden/releases ) once public.
2021-06-23 23:32:41 -07:00
## Support
2025-04-12 16:18:43 +00:00
If you enjoy the project and want to support us financially, check out Camille's donations page!
< br >
< br >
Donations are not available yet.
2021-06-23 23:32:41 -07:00
< / a >
Any donations received will go towards things like:
2018-01-13 17:28:52 -05: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
* Software licenses (e.g. Visual Studio, IDA Pro, etc.)
* Additional hardware (e.g. GPUs as-needed to improve rendering support, other peripherals to add support for, etc.)
2025-04-12 16:18:43 +00:00
If you wish to support us a different way, please join our [Discord ](W.I.P ), once public, and talk to Camille.
2021-06-23 23:32:41 -07:00
## License
2025-04-12 16:18:43 +00: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.
