citra-emu
Go to file
Weiyi Wang d765a73a53 Scripting: reimplement protocol over plan UDP using boost::asio 2019-02-02 15:25:23 -05: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 Merge pull request #4567 from ykgmfq/patch-1 2019-01-26 14:23:35 -05:00
CMakeModules android: set up cmake 2018-11-20 14:24:19 -05:00
dist Scripting: reimplement protocol over plan UDP using boost::asio 2019-02-02 15:25:23 -05:00
externals Merge pull request #4490 from wwylele/teakra-new 2019-01-11 16:45:00 +01:00
hooks hook: remove clang-format check 2017-02-17 13:52:23 +02:00
src Scripting: reimplement protocol over plan UDP using boost::asio 2019-02-02 15:25:23 -05:00
.gitattributes Meta: Add gitattributes file 2018-09-22 14:59:15 -06:00
.gitignore Flatpak support (#4383) 2018-11-07 21:33:36 -05:00
.gitmodules audio_core: add teakra and lle interface 2018-12-21 20:49:18 -05:00
.travis.yml Merge pull request #4129 from ccawley2011/clang-format-docker 2018-12-02 07:57:42 +08:00
CMakeLists.txt android: set up cmake 2018-11-20 14:24:19 -05:00
CONTRIBUTING.md CONTRIBUTING.md: migrate to the wiki 2018-11-08 00:15:55 -05:00
Doxyfile Remove every trailing whitespace from the project (but externals). 2015-05-29 21:59:29 +01:00
README.md update CONTRIBUTING link 2018-12-24 19:43:35 -05:00
appveyor.yml Include imageformat dependencies with releases (appveyor) 2018-11-17 16:36:56 +01:00
bitrise.yml android: set up cmake 2018-11-20 14:24:19 -05:00
keys.tar.enc Flatpak support (#4383) 2018-11-07 21:33:36 -05:00
license.txt citra_qt/multiplayer: Add user ping support 2018-12-15 11:03:35 +08:00

README.md

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

Citra

Travis CI Build Status AppVeyor CI Build Status Bitrise CI Build Status

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

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.