Archived

This repository has been archived on 2024-03-23. You can view files and clone it, but cannot push or open issues or pull requests.

Go to file

Weiyi Wang 8c354ff6b1 Merge pull request #4210 from valentinvanelslande/ipc ipc: fix typo		2018-09-13 12:53:26 -04:00
.appveyor	appveyor: Generate PDBs for mingw build	2018-03-27 11:57:34 +01:00
.github	Edit Citra URLs (#2728 )	2017-06-03 23:51:45 +03:00
.travis	Initial support for scripting (#4016 )	2018-09-11 22:00:12 +02:00
CMakeModules	travis: MinGW build on Travis CI	2018-07-12 09:33:36 +08:00
dist	Initial support for scripting (#4016 )	2018-09-11 22:00:12 +02:00
externals	Initial support for scripting (#4016 )	2018-09-11 22:00:12 +02:00
hooks	hook: remove clang-format check	2017-02-17 13:52:23 +02:00
src	ipc: fix typo	2018-09-13 11:51:08 -05:00
.gitignore	Initial support for scripting (#4016 )	2018-09-11 22:00:12 +02:00
.gitmodules	Initial support for scripting (#4016 )	2018-09-11 22:00:12 +02:00
.travis.yml	travis: change MinGW job name in build matrix	2018-07-12 09:33:41 +08:00
CMakeLists.txt	Merge pull request #4170 from FearlessTobi/port-stupid-fixes	2018-09-04 01:47:03 +03:00
CONTRIBUTING.md	Merge pull request #3466 from daniellimws/edit-contributing	2018-03-09 21:14:17 -05:00
Doxyfile	Remove every trailing whitespace from the project (but externals).	2015-05-29 21:59:29 +01:00
README.md	Update README.md to describe current condition more accurately (#3737 )	2018-05-29 23:51:25 -06:00
appveyor.yml	Add Discord Rich Presence Support (#3883 )	2018-08-20 11:20:33 +02:00
license.txt	qt_themes: replace game_list icons (#4002 )	2018-08-16 12:39:46 +02: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!

For development discussion, please join us 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 as well 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 checkout citra project on transifex. We centralize the translation work there, and periodically upstream translation.

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.