mirror of
https://github.com/citra-emu/citra.git
synced 2024-12-23 20:40:05 +00:00
45 lines
3.6 KiB
Markdown
45 lines
3.6 KiB
Markdown
**BEFORE FILING AN ISSUE, READ THE RELEVANT SECTION IN THE [CONTRIBUTING](https://github.com/citra-emu/citra/wiki/Contributing#reporting-issues) FILE!!!**
|
|
|
|
Citra
|
|
==============
|
|
[](https://travis-ci.org/citra-emu/citra)
|
|
[](https://ci.appveyor.com/project/bunnei/citra)
|
|
[](https://app.bitrise.io/app/4ccd8e5720f0d13b)
|
|
|
|
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](https://citra-emu.org/game).)
|
|
|
|
Citra is licensed under the GPLv2 (or any later version). Refer to the license.txt file included. Please read the [FAQ](https://citra-emu.org/wiki/faq/) before getting started with the project.
|
|
|
|
Check out our [website](https://citra-emu.org/)!
|
|
|
|
Need help? Check out our [asking for help](https://citra-emu.org/help/reference/asking/) guide.
|
|
|
|
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](https://github.com/citra-emu/citra) is hosted.
|
|
|
|
If you want to contribute please take a look at the [Contributor's Guide](https://github.com/citra-emu/citra/wiki/Contributing) and [Developer Information](https://github.com/citra-emu/citra/wiki/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](https://docs.google.com/document/d/1SWIop0uBI9IW8VGg97TAtoT_CHNoP42FzYmvG1F4QDA) isn't maintained anymore.
|
|
|
|
If you want to contribute to the user interface translation, please checkout [citra project on transifex](https://www.transifex.com/citra/citra). We centralize the translation work there, and periodically upstream translation.
|
|
|
|
### Building
|
|
|
|
* __Windows__: [Windows Build](https://github.com/citra-emu/citra/wiki/Building-For-Windows)
|
|
* __Linux__: [Linux Build](https://github.com/citra-emu/citra/wiki/Building-For-Linux)
|
|
* __macOS__: [macOS Build](https://github.com/citra-emu/citra/wiki/Building-for-macOS)
|
|
|
|
|
|
### Support
|
|
We happily accept monetary donations or donated games and hardware. Please see our [donations page](https://citra-emu.org/donate/) 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](http://webchat.freenode.net/?channels=citra) 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.
|