A Nintendo 3DS Emulator (unofficial mirror fork)

Go to file

Pengfei Zhu df83449d21 Merge pull request #5549 from xperia64/squash_reg_warnings Silence some noisy switch case warning		2020-09-10 22:26:45 +07:00
.appveyor	appveyor: Generate PDBs for mingw build	2018-03-27 11:57:34 +07:00
.github	.github: add a new issue template	2020-06-19 11:37:48 +07:00
.travis	General: Tidy up clang-format warnings	2020-08-28 21:10:42 +07:00
CMakeModules	cmake: stop linking against QGL	2020-07-11 19:06:31 +07:00
dist	Update translations (2020-07-01)	2020-07-01 01:17:39 +07:00
externals	Merge pull request #5524 from FearlessTobi/port-4582	2020-08-28 13:30:44 +07:00
hooks	hook: remove clang-format check	2017-02-17 13:52:23 +07:00
src	Merge pull request #5549 from xperia64/squash_reg_warnings	2020-09-10 22:26:45 +07:00
.gitattributes	Meta: Add gitattributes file	2018-09-22 14:59:15 +07:00
.gitignore	Flatpak support (#4383 )	2018-11-07 21:33:36 +07:00
.gitmodules	Add ZSTD compression for precompiled cache	2020-01-15 19:58:33 +07:00
.lgtm.yml	Add LGTM static analyzer config file (#5495 )	2020-08-07 09:34:39 +07:00
.travis.yml	travis: Compile on macOS 10.13 with more up to date compiler	2020-05-02 08:50:42 +07:00
CMakeLists.txt	CMakeLists: Download Clang-Format from the Citra repo instead of yuzus (#5534 )	2020-08-29 21:58:20 +07:00
CONTRIBUTING.md	CONTRIBUTING.md: migrate to the wiki	2018-11-08 00:15:55 +07:00
Doxyfile	Remove every trailing whitespace from the project (but externals).	2015-05-29 21:59:29 +07:00
README.md	citra_qt: Backport review comments from the yuzu translation PR (#5465 )	2020-08-31 21:13:24 +07:00
appveyor.yml	update appveyor sdl	2020-04-07 11:38:12 +07:00
bitrise.yml	android: use cmake 3.10	2020-02-21 16:47:04 +07:00
keys.tar.enc	Flatpak support (#4383 )	2018-11-07 21:33:36 +07:00
license.txt	Replace non-commercial icons with free icons from icons8 (#5093 )	2020-03-26 13:40:03 +07:00

README.md

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

Citra

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 emulates a subset of 3DS hardware and therefore is useful for running/debugging homebrew applications, and it is also able to run many commercial games! Some of these do not run at a playable state, but we are working every day to advance the project forward. (Playable here means compatibility of at least "Okay" on our game compatibility list.)

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!

Need help? Check out our asking for help guide.

For development discussion, please join us on our Discord server or at #citra-dev 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 and Developer Information. You should also contact any of the developers in the forum in order to know about the current state of the emulator because the TODO list isn't maintained anymore.

If you want to contribute to the user interface translation, please check out the citra project on transifex. We centralize the translation work there, and periodically upstream translations.

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

We also more than gladly accept used 3DS consoles! If you would like to give yours away, don't hesitate to join our Discord server and talk to bunnei.