Contributing Guide β’ Building Guide
Sumi is an experimental multiplatform emulator that focuses on ARMv8 Androidβ’ devices and emulates the functionality of a Nintendo Switchβ’ system, licensed under GNU General Public License v3.0 or later
Welcome to Sumi, a cutting-edge Nintendo Homebrew emulator designed to deliver an optimized experience for playing your favorite games and exploring new ones. Sumi is a high-performance and easy-to-use emulator, tailored for enthusiasts and developers alike.
Disclaimer: Sumi is intended strictly for legal homebrew use and is not affiliated with or endorsed by Nintendo. Use of Sumi for pirated or unauthorized copies of games is strictly prohibited. Please respect game developers and support them by purchasing legitimate copies of their games.
Ready to experience Sumi?
To get the latest version of Sumi emulator, reach our releases page:
https://github.com/ovsky/sumi-emu/releases
- Latest Technologies: Consistently updated tech stack.
- Best Performance: The best efficiency solutions were implemented.
- User-Friendly: Clean and intuitive interface.
- Cross-Platform: Available on multiple platforms.
- Homebrew Support: Fully supports legal homebrew games and applications.
- Ongoing Development: Stay tuned for frequent updates as Sumi evolves!
To achieve best performance, download the best driver for your device and apply it in Sumi
Mesa / Adreno - Sources
[The most universal drivers]
GitHub Releases - K11MCH1/AdrenoToolsDrivers
Mesa / Adreno - Sources:
[Especially for old Android Devices]
GitHub Releases - XForYouX/Turnip
Mesa / Adreno - Sources:
[These drivers are better performing on some devices]
GitHub Releases - Tiago/Turnip
*Anbernic / Retroid / AYN (Snapdragon Versions):
[The probably best drivers for Anbernic, especially for Snapdragon 865 handhelds]
GitHub Sources - MrPurple/Freedreno
Mali GPU:
[Mali GPUs unfortunately have poor driver support.
So, we have prepared our own, Sumi's universal one, for Mali and 8 Elite. If you can, please try to find better one for your device!]
GitHub Sources - Sumi/Sumi Universal Driver W1
Snapdragon 8 Elite / Adreno 830:
Unfortunately, Mesa do not provide support for 8 Elite, and to not have defined plans about supporting it:
https://gitlab.freedesktop.org/mesa/mesa/-/issues/12066.
Due to this, it is well known and do not suggested to use this SoC for emulation process. K11MCH1's Mesa sources and fixed are closed, so it is not easy in any way.
Good information is that we are trying out best to support every user snd every device - so, we have started our internal process for porting drivers for 8 Elite. The development process of drivers for new SoC is really demanding and long. We hope, that we or anyone else will be able to provide the best Switch emulation drivers for 8 Elite users.
~ Suni Team :)
We found that DLC installing of DLCs stopped in many titles. So, we have suggestion. You can install our last version on which all DLCs works properly, install every DLC you want and then reinstalling the latest version. I know, it's not a perfect solution, but we are consistently working on bringing back DLC support.
If you want to test it: https://github.com/ovsky/sumi-emu/releases/tag/v0.3.0
- Download and Install: Head over to the downloads page to grab the latest release.
- Add Homebrew Games: Sumi is built to play homebrew games. Add them to your game directory and enjoy!
- Configure Your Settings: Customize your emulator settings to suit your performance needs.
Sumi is an open-source project. You can find the source code on our official Git repository:
We welcome contributions! Check out the repository and feel free to submit issues or pull requests to help improve Sumi.
Sumi is a homebrew emulator designed to support legally created and distributed homebrew software. It does not support piracy, nor is it intended for illegal purposes. Using Sumi to play pirated copies of games is a violation of copyright law. Sumi is not affiliated with or endorsed by Nintendo, and all Nintendo trademarks and copyrights are the property of their respective owners.
We highly encourage users to respect intellectual property rights and to only use Sumi with legal, homebrew content.
Sumi is licensed under the GPL License. See the full license in the LICENSE file for more details.
We are always looking for developers, testers, and enthusiasts to contribute to Sumi. Whether you want to submit a pull request, report an issue, or suggest new features, all contributions are welcome. Please follow our contributing guidelines to get started.
[WIP] For any inquiries or to follow Sumi's development journey, reach out to us:
- Official Website: https://sumi-emu.org
- Source Code: https://github.com/ovsky/sumi-emu/
- Twitter: @SumiEmu
Huge thanks to Sudachi Emulator team for providing an amazing database and especially to Citron Team for his huge contribution to emulator development and continuous amazing work. Without you this project would not exist!
Made with full love β€οΈ for Citron and Sudachi
- Nintendo Switch is a trademark of Nintendo Co., Ltd
- Android is a trademark of Google LLC