mirror of https://gitlab.com/suyu-emu/suyu.git synced 2024-03-15 23:15:44 +00:00

suyu is the continuation of the world's most popular, open-source, Nintendo Switch emulator, yuzu. It is written in C++ with portability in mind, and we actively maintain builds for Windows, Linux and Android.

Go to file

James Rowe 737c8bee16 Try a different travis key		2017-01-03 20:00:26 -07:00
.github	.github: Add ISSUE_TEMPLATE.md	2016-08-26 16:18:01 +01:00
CMakeModules	Modularized Qt and SDL file copying	2016-12-13 21:05:00 +01:00
dist	Add man documentation	2016-11-26 13:48:00 +11:00
externals	arm_dynarmic: Provide MemoryReadCode callback	2016-12-22 16:07:14 +00:00
hooks	hooks: convert pre-commit to POSIX syntax	2016-10-27 23:28:29 +00:00
src	Merge pull request #2382 from mailwl/nfc	2017-01-03 12:56:02 -03:00
.gitignore	Add deploy to bintray for builds to master	2016-12-31 13:54:51 -05:00
.gitmodules	Externals: Add Xbyak	2016-12-14 20:06:08 -08:00
.travis-build.sh	Travis: Use a stable version of clang-format	2016-12-03 01:32:46 -08:00
.travis-deps.sh	Travis: Use a stable version of clang-format	2016-12-03 01:32:46 -08:00
.travis-upload.sh	Add deploy to bintray for builds to master	2016-12-31 13:54:51 -05:00
.travis.descriptor.json.in	Trying to make a consistent nightly versioning	2016-12-31 19:37:21 -05:00
.travis.yml	Try a different travis key	2017-01-03 20:00:26 -07:00
appveyor.yml	Try a different encrypted bintray api key for travis. Change appveyor to upload to a long git hash (since travis is stuck uploading to the full hash name)	2016-12-31 23:38:15 -05:00
CMakeLists.txt	Add deploy to bintray for builds to master	2016-12-31 13:54:51 -05:00
CONTRIBUTING.md	Update CONTRIBUTING.md	2016-11-05 00:33:36 -04:00
Doxyfile	Remove every trailing whitespace from the project (but externals).	2015-05-29 21:59:29 +01:00
license.txt	added license txt file	2014-04-08 19:03:00 -04:00
README.md	Change "OS X" to "macOS" in the Readme	2016-11-14 09:16:11 -08:00

README.md

BEFORE FILING AN ISSUE, READ THE RELEVANT SECTION IN THE CONTRIBUTING FILE!!!

Citra Emulator

Citra is an experimental open-source Nintendo 3DS emulator/debugger written in C++. It is written with portability in mind, with builds actively maintained for Windows, Linux and macOS. Citra only emulates a subset of 3DS hardware, and therefore is generally only useful for running/debugging homebrew applications. At this time, Citra is even able to boot several commercial games! Most of these do not run to a playable state, but we are working every day to advance the project forward.

Citra is licensed under the GPLv2 (or any later version). Refer to the license.txt file included. Please read the FAQ before getting started with the project.

Check out our website!

For development discussion, please join us @ #citra on freenode.

Development

Most of the development happens on GitHub. It's also where our central repository is hosted.

If you want to contribute please take a look at the Contributor's Guide, TODO list and Developer Information. You should as well contact any of the developers in the forum in order to know about the current state of the emulator.

Building

Windows: Windows Build
Linux: Linux Build
macOS: macOS Build

Support

We happily accept monetary donations, or donated games and hardware. Please see our donations page for more information on how you can contribute to Citra. Any donations received will go towards things like:

3DS consoles for developers to explore the hardware
3DS games for testing
Any equipment required for homebrew
Infrastructure setup
Eventually 3D displays to get proper 3D output working

We also more than gladly accept used 3DS consoles, preferably ones with firmware 4.5 or lower! If you would like to give yours away, don't hesitate to join our IRC channel #citra on Freenode and talk to neobrain or bunnei. Mind you, IRC is slow-paced, so it might be a while until people reply. If you're in a hurry you can just leave contact details in the channel or via private message and we'll get back to you.