mirror of https://github.com/Lime3DS/Lime3DS.git synced 2024-11-24 02:29:20 +01:00

A Nintendo 3DS Emulator

Go to file

wwylele 7c4ed77e06 Service/AM: fix some headers		2018-03-02 02:53:59 +02:00
.appveyor	appveyor: Determine dlls to include in package programmatically	2017-10-26 06:02:13 +01:00
.github	Edit Citra URLs (#2728 )	2017-06-03 23:51:45 +03:00
.travis	CI: Update to C++17 and use Ubuntu 18.04 as baseline	2018-02-06 17:02:21 +00:00
CMakeModules	Installer: Address review comments	2017-09-30 09:12:07 -06:00
dist	cmake: generate translation file and add to resource for citra_qt	2017-12-16 13:11:05 +02:00
externals	externals: Update cryptopp to 6.0.0	2018-02-07 22:19:27 +00:00
hooks	hook: remove clang-format check	2017-02-17 13:52:23 +02:00
src	Service/AM: fix some headers	2018-03-02 02:53:59 +02:00
.gitignore	Add the .vs folder and the CMakeSettings.json file from Visual Studio to gitignore.	2017-09-30 11:07:57 -05:00
.gitmodules	Switch inih to It's Official Repository @ benhoyt/inih	2017-12-03 19:35:54 -06:00
.travis.yml	Merge pull request #3168 from CDAGaming/pr_Improvements	2018-01-18 18:27:23 +02:00
appveyor.yml	Merge branch 'master' into CompatibiltyReporting	2018-01-18 10:36:32 -06:00
CMakeLists.txt	CI: Update to C++17 and use Ubuntu 18.04 as baseline	2018-02-06 17:02:21 +00:00
CONTRIBUTING.md	Fixes typo on Citra forum link.	2017-03-06 08:27:59 -05: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	README: add info about translation	2018-01-04 15:26:15 +02: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.

Citra is even able to boot several 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 the same as "OK" 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 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.