suyu/README.md

<!--
SPDX-FileCopyrightText: 2024 suyu emulator project
SPDX-License-Identifier: GPL v3
-->

**Note**: We do not support or condone piracy in any form. In order to use Suyu, you'll need keys from your real Switch system, and games which you have legally obtained and paid for. We do not intend to make money or profit from this project.

We are in great need of developers, join our Discord server at <a href="https://discord.gg/2gQRBp44KT">https://discord.gg/2gQRBp44KT</a>.

This repo is based on Yuzu EA 4176. Please contribute if you can!

<hr />

<h1 align="center">
  <br>
  <a href=""><img src="https://gitlab.com/suyu-emu/suyu/-/raw/master/dist/readme/suyu__Logo-Pill.svg" alt="suyu" height="128"></a>
  <br>
  <b>suyu</b>
  <br>
</h1>

<h4 align="center"><b>suyu</b>, pronounced "sue-you" (wink wink) is the continuation of the world's most popular, open-source, Nintendo Switch emulator, yuzu.
<br>
It is written in C++ with portability in mind, and we actively maintain builds for Windows, Linux and Android.
</h4>

<p align="center"><i>Logo by <a href="https://realmy.net">Realmy</a></i></p>

<p align="center">
    <a href="https://dev.azure.com/suyu-emu/suyu/">
        <img src="https://dev.azure.com/suyu-emu/suyu/_apis/build/status/suyu%20mainline?branchName=master"
            alt="Azure Mainline CI Build Status">
    </a>
</p>

<p align="center">
  <a href="compatibility.yml">Compatibility</a> |
  <a href="#development">Development</a> |
  <a href="#building">Building</a> |
  <a href="#downloads">Downloads</a> |
  <a href="#support">Support</a> |
  <a href="#license">License</a>
</p>

## Status

We are trying to get the builds working. We are in need of developers. Join our Discord to contribute.

**Note**: This README is a fork of the original project's README, most links are broken!

## Compatibility

W.I.P.

The emulator is capable of running most commercial games at full speed, provided you meet the [necessary hardware requirements](https://suyu-emu.org/help/quickstart/#hardware-requirements).

For a full list of games suyu supports, please visit our [Compatibility page](https://suyu-emu.org/game/).

Check out our [website](https://suyu-emu.org/) for the latest news on exciting features, monthly progress reports, and more!

## Development

W.I.P.

This project is completely free and open source, this project is made possible by many people who share the same interest.

Most of the development happens on GitHub. For development discussion, please join us on [Discord](https://discord.gg/2gQRBp44KT).

If you want to contribute, please take a look at the [Contributor's Guide](https://gitlab.com/suyu-emu/suyu/-/wikis/Contributing) and [Developer Information](https://gitlab.com/suyu-emu/suyu/-/wikis/Developer-Information).
You can also contact any of the developers on Discord in order to know about the current state of the emulator.

If you want to contribute to the user interface translation project, please check out the [suyu project on transifex](https://www.transifex.com/suyu-emulator/suyu). We centralize translation work there, and periodically upstream translations.

## Downloads

* __Windows__: [Legacy Artifacts](https://github.com/pineappleea/pineapple-src/releases)
* __Linux__: [Legacy Artifacts](https://github.com/pineappleea/pineapple-src/releases)

## Building

* __Windows__: W.I.P.
* __Linux__: W.I.P.



## Support

This project is completely free and open source, this project is made possible by many people who share the same interest. Please join the discord server to contribute.


## License

suyu is licensed under the free and open-source GPL v3 license.