mirror of https://github.com/PabloMK7/citra.git synced 2024-11-24 16:34:24 +00:00

A Nintendo 3DS Emulator

Find a file

Weiyi Wang 2c0bd0f2a1 travis/transifex: use HEREDOC for initializing config (#5109 ) It seems that in recent bash update in CI doesn't correctly interpret the quote string any more.		2020-02-29 19:52:34 +01:00
.appveyor	appveyor: Generate PDBs for mingw build	2018-03-27 11:57:34 +01:00
.github	.github: Create FUNDING.yml	2019-06-08 20:09:03 +02:00
.travis	travis/transifex: use HEREDOC for initializing config (#5109 )	2020-02-29 19:52:34 +01:00
CMakeModules	Fix title bar	2020-01-15 23:52:41 -07:00
dist	dark themes refinements and cleanup	2020-02-03 14:55:20 +01:00
externals	HTTP_C::Implement Context::MakeRequest (#4754 )	2020-02-21 19:04:04 +01:00
hooks	hook: remove clang-format check	2017-02-17 13:52:23 +02:00
src	core: Add support for N3DS memory mappings (#5103 )	2020-02-29 19:48:27 +01: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	Add ZSTD compression for precompiled cache	2020-01-15 19:58:33 -07:00
.travis.yml	travis: Update the frozen build to be a flagless Debug build	2019-08-14 09:27:06 +08:00
appveyor.yml	CMake: separate options for FFmpeg decoder/dumper	2019-08-20 14:45:39 +08:00
bitrise.yml	android: use cmake 3.10	2020-02-21 16:47:04 -06:00
CMakeLists.txt	Implements fdk_aac decoder (#4764 )	2020-02-23 11:01:21 +01: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
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	Update README.md (#5097 )	2020-02-29 11:13:28 -06: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 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

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.