OpenPunk/citra
1
0
Fork 0
mirror of https://github.com/citra-emu/citra.git synced 2024-11-26 03:10:05 +00:00
Code Issues Projects Releases Wiki Activity

Updated FAQ (markdown)

bunnei 2016-02-25 15:12:02 -05:00
parent ee1b985672
commit f08190489f
1 changed files with 70 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

109
FAQ.md

@ -1,10 +1,60 @@
## About Citra
#### What is Citra?
Citra is a work-in-progress Nintendo 3DS emulator started in early 2014. Citra can currently emulate, with varying degrees of success, a wide variety of different homebrew programs and commercial software.
#### What is Citra's License?
Citra is an open-source project, licensed under the GPLv2 (or any later version). Refer to the [license document](https://github.com/citra-emu/citra/blob/master/license.txt) for more information.
#### Who made Citra?
Citra has an active team of open-source developers. Over 50 people have worked hard on the project since its founding in 2014! The list of contributors can be found [on GitHub](https://github.com/citra-emu/citra/graphs/contributors).
Citra is not affiliated with Nintendo in any way.
## Running games in Citra
#### Where can I download games to use with Citra?
Short answer: You don't. Buy games and dump them with a Nintendo 3DS.
Long answer: Downloading commercial games is illegal and thus strongly frowned upon by the Citra developers. To prevent legal issues, this includes gray areas like downloading games which you purchased earlier. You don't necessarily need to own a gaming console by yourself because you can buy a game cartridges and dump them with a friend's console. On the other hand, copying a friend's game dump is considered illegal again. Please note that any mention or discussion of piracy on our discussion forum or IRC channels will result in being banned from our community.
Please refer to [[Dumping Game Cartridges]] for guidance on how to dump games for use with Citra.
#### I want to run backups of retail titles that I own, how can I do that?
Refer to [[Dumping Game Cartridges]].
#### Does this mean I can play \<insert retail game here\> on my PC?
Citra can, ostensibly, "play" many different games, including The Legend of Zelda: Ocarina of Time and Animal Crossing.
Many games, however, will not load at all, only showing a black screen. Many other games will only show the title screen and then freeze, or crash.
You can expect many games to run slowly, though, and to exhibit many gameplay and graphical glitches.
If you're interested in 3DS emulation as an experiment, you may gain something out of trying Citra, but if you're simply looking to play games then stick to your 3DS handheld.
#### Can Citra run Pokémon games? #### Can Citra run Pokémon games?
Not at the moment. Not at the moment. While you may have seen screenshots or videos of Citra running Pokemon games, these have been made with non-official builds. Pokemon games do not currently run with our [nightly releases](https://citra-emu.org/page/download).
#### Can Citra run \<game\>? ## System requirements and common issues
Maybe. Assuming it isn't fully playable, however, is a good assumption to make for the time being. #### Which platforms does Citra support?
We're pleased to say that Citra works on all three major desktop OSs!
Citra is actively tested and supported on 64-bit versions of Windows (7 and up), Linux and OS X. Other platforms may work, but aren't tested by developers. In the far future, mobile platforms may be targeted as well. We have no plans to support 32-bit operating systems.
#### What kind of specs do I need to run Citra?
At this point, Citra is simply not fast enough to run most commercial games at full speed, even if your computer can run the most demanding of PC games just fine.
The only _hard_ requirements for Citra is a graphics chip that supports **at least OpenGL 3.3** and a **64-bit OS**, but you definitely want a processor with the highest possible performance per core.
#### When I try to start any game, Citra immediatelly crashes! #### When I try to start any game, Citra immediatelly crashes!
@ -18,43 +68,6 @@ First, if you've downloaded any DLL files from the Internet and placed them in t
Games need to be decrypted on a 3DS before being usable in Citra. This is a technical limitation and it is unlikely that it can be removed in the foreseeable future. To decrypt your games, you will need to have a 3DS system running firmware 9.2 or lower and follow the [[Dumping Game Cartridges]] guide. Games need to be decrypted on a 3DS before being usable in Citra. This is a technical limitation and it is unlikely that it can be removed in the foreseeable future. To decrypt your games, you will need to have a 3DS system running firmware 9.2 or lower and follow the [[Dumping Game Cartridges]] guide.
#### I'd like to make a patch/develop/contribute to the project.
If you're interested in contributing, fork the project here in GitHub, and then create a Pull Request when you're ready to submit your contribution. Unless your change is trivial, however, it is heavily recommended that you join our development channel (#citra-dev @ Freenode) to coordinate with the developers beforehand. Make sure to review our [coding guidelines](https://github.com/citra-emu/citra/blob/master/CONTRIBUTING.md) and ensure your changes follow them. If you're looking for ideas on things to work on, try checking the [TODO list](https://docs.google.com/document/d/1SWIop0uBI9IW8VGg97TAtoT_CHNoP42FzYmvG1F4QDA) for inspiration.
#### I want to run Pokemon/Zelda/Mario/etc. but I can't figure out how!
Currently, no retail games/software are fully playable on Citra. The few games that do run are slow and can suffer from glitches or bugs. Sooner or later, games will come to playable state. Check back regularly for more updates.
#### I want to run backups of retail titles that I own, how can I do that?
Refer to [[Dumping Game Cartridges]].
#### I'd like to be a beta tester, how can I help?
If you try some games and run into issues like graphical glitches, freezes and especially regressions from previous versions, you can try reporting them in our issue tracker, accompanied by logs from the emulator if possible. Do *not* report an issue if a game simply fails to boot entirely.
We're not looking for any "full-time" dedicated testers at this time. The devs already have plenty on their plates to work with!
#### What operating systems are supported?
Citra is actively tested and supported on 64-bit versions of Windows (7 and up), Linux and OS X. Other platforms may work, but aren't tested by developers.
#### What are the hardware requirements?
There are no specific hardware requirements for Citra - any modern x86-64 system should be fine. Currently, Citra only includes a rather slow pure interpreter CPU core, so performance will suffer regardless of your system power. Graphics requirements are modest, but a video card and drivers supporting OpenGL 3.3 are required.
#### I think what you guys are doing is awesome! I am not a developer, but still want to support the project. What can I do?
That's awesome! Such support is what motivates us to keep working :) Stick around and keep motivating our work! If you're interested in donating, please join our IRC channel (#citra @ [Freenode](https://webchat.freenode.net/)) and contact a developer. Donations will be used to buy systems and games to test with, as well as paying for infrastructure and web costs.
#### What to do if I get an error saying something like "GetConfigInfoBlock: Config block 0xXXXXX with flags X and size X was not found"? #### What to do if I get an error saying something like "GetConfigInfoBlock: Config block 0xXXXXX with flags X and size X was not found"?
Sometimes a game will freeze and you'll get an error which looks like this in the log, usually followed by a "Fatal Error": Sometimes a game will freeze and you'll get an error which looks like this in the log, usually followed by a "Fatal Error":
@ -64,3 +77,19 @@ Service.CFG <Error> core\hle\service\cfg\cfg.cpp:Service::CFG::GetConfigInfoBloc
``` ```
In this case, try deleting the file at `user/nand/data/00000000000000000000000000000000/sysdata/00010017/00000000/config` and running the latest version of Citra. If this does not work, then note the config block number (`0xA0001` in the example) and file a bug report. In this case, try deleting the file at `user/nand/data/00000000000000000000000000000000/sysdata/00010017/00000000/config` and running the latest version of Citra. If this does not work, then note the config block number (`0xA0001` in the example) and file a bug report.
## Development and contributions
#### How can I develop or contribute to the project?
If you're interested in contributing, fork the project here in GitHub, and then create a Pull Request when you're ready to submit your contribution. Unless your change is trivial, however, it is strongly recommended that you join our development channel (#citra-dev @ [Freenode](https://webchat.freenode.net/) to coordinate with the developers beforehand. Make sure to review our [coding guidelines](https://github.com/citra-emu/citra/blob/master/CONTRIBUTING.md) and ensure your changes follow them. If you're looking for ideas on things to work on, try checking the [TODO list](https://docs.google.com/document/d/1SWIop0uBI9IW8VGg97TAtoT_CHNoP42FzYmvG1F4QDA) for inspiration.
#### I'd like to be a beta tester, how can I help?
If you try some games and run into issues like graphical glitches, freezes and especially regressions from previous versions, you can try reporting them in our issue tracker, accompanied by logs from the emulator if possible. Do *not* report an issue if a game simply fails to boot entirely.
#### I think what you guys are doing is awesome! I am not a developer, but still want to support the project. What can I do?
That's awesome! Such support is what motivates us to keep working! Stick around and keep motivating our work!
If you're interested in donating, we would gladly accept used hardware, games for testing, or money for development/infrastructure costs. Please see our [donations page](https://citra-emu.org/page/donate) for more information, or join our IRC channel (#citra @ [Freenode](https://webchat.freenode.net/)) and contact a developer.