OpenPunk/citra
1
0
Fork 0
mirror of https://github.com/citra-emu/citra.git synced 2024-12-18 07:10:05 +00:00
Code Issues Projects Releases Wiki Activity
A Nintendo 3DS Emulator
9,293 Commits 1 Branch 0 Tags 135 MiB
cpp 65.2%
C++ 30.4%
Kotlin 3.5%
CMake 0.6%
GLSL 0.2%
b5872ea79e
Go to file
GPUCode b5872ea79e
cmake: Add SDL2 alias when using system library
2022-09-23 20:55:51 +03:00
.ci Upgrade codebase to C++ 20 + fix warnings + update submodules (#6115) 2022-09-21 18:36:12 +02:00
.github CI: dont upload macos artifacts (#6121) 2022-09-10 15:35:00 +05:30
CMakeModules Include gl_shader_util in shader cache version hash calculation 2022-09-03 14:44:40 +02:00
dist GUI: Make touchscreen more visible in Midnight theme (#6100) 2022-08-22 20:48:55 +05:30
externals Upgrade codebase to C++ 20 + fix warnings + update submodules (#6115) 2022-09-21 18:36:12 +02:00
hooks hook: remove clang-format check 2017-02-17 13:52:23 +02:00
src Upgrade codebase to C++ 20 + fix warnings + update submodules (#6115) 2022-09-21 18:36:12 +02:00
.gitattributes Meta: Add gitattributes file 2018-09-22 14:59:15 -06:00
.gitignore Upgrade codebase to C++ 20 + fix warnings + update submodules (#6115) 2022-09-21 18:36:12 +02:00
.gitmodules Upgrade codebase to C++ 20 + fix warnings + update submodules (#6115) 2022-09-21 18:36:12 +02:00
.lgtm.yml Add LGTM static analyzer config file (#5495) 2020-08-07 09:34:39 +08:00
bitrise.yml Fix Bitrise CI 2022-04-14 20:44:59 +05:30
CMakeLists.txt cmake: Add SDL2 alias when using system library 2022-09-23 20:55:51 +03: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 Replace non-commercial icons with free icons from icons8 (#5093) 2020-03-26 13:40:03 -05:00
README.md Update README.md (#5855) 2021-10-02 23:15:48 +05:30

README.md

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

Citra

GitHub Actions Build Status Bitrise CI Build Status Discord

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 libera.

Releases

Citra has two main release channels: Nightly and Canary.

The Nightly build is based on the master branch, and contains already reviewed and tested features.

The Canary build is based on the master branch, but with additional features still under review. PRs tagged canary-merge are merged only into the Canary builds.

Both builds can be installed with the installer provided on the website, but those looking for specific versions or standalone releases can find them in the release tabs of the Nightly and Canary repositories.

Currently, development and releases of the Android version are in a separate repository.

A Flatpak for Citra is available on Flathub. Details on the build process can be found in our Flathub repository.

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

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.