Difference between revisions of "Citra"

From Emulation General Wiki
Jump to navigation Jump to search
m (Protected "Citra" ([Edit=Allow only autoconfirmed users] (indefinite) [Move=Allow only autoconfirmed users] (indefinite)))
(Is this 2014? No.)
(32 intermediate revisions by 21 users not shown)
Line 1: Line 1:
 
{{Infobox emulator
 
{{Infobox emulator
|logo = citra.svg
+
|logo = Citra.png
 
|logowidth = 153
 
|logowidth = 153
 
|active = Yes
 
|active = Yes
|platform = Windows, Linux, macOS
+
|platform = [[Emulators on Windows|Windows]]<br/>[[Emulators on Linux|Linux]]<br/>[[Emulators on macOS|macOS]]<br/>[[Emulators on Android|Android]]
 
|target = [[Nintendo 3DS emulators|Nintendo 3DS]]
 
|target = [[Nintendo 3DS emulators|Nintendo 3DS]]
 
|developer = [https://github.com/citra-emu/citra/graphs/contributors Citra Team]
 
|developer = [https://github.com/citra-emu/citra/graphs/contributors Citra Team]
Line 9: Line 9:
 
|website = [http://citra-emu.org/ Citra-emu.org]
 
|website = [http://citra-emu.org/ Citra-emu.org]
 
|support = [https://www.patreon.com/citraemu Patreon]
 
|support = [https://www.patreon.com/citraemu Patreon]
|source = [https://github.com/citra-emu/citra/ GitHub]
+
|compatibility = [https://citra-emu.org/game/ Official List]
 +
|source = [https://github.com/citra-emu/citra GitHub]
 +
|license = GNU GPLv2
 +
|bios = [[Emulator_Files#Nintendo_3DS|Required for some games and decryption]]
 
}}
 
}}
'''[[wikipedia:Citra (emulator)|Citra]]''' is an open-source [[Nintendo 3DS emulators|Nintendo 3DS]] emulator/debugger written in C++. It's currently able to run quite a few games well, though very few can run at full speed on existing hardware, and most titles have sound issues. It is also available as a [[libretro]] core.
 
  
Due to its preliminary state, it has not yet had a stable release.
+
'''[[wikipedia:Citra (emulator)|Citra]]''' is an open-source [[Nintendo 3DS emulators|Nintendo 3DS]] emulator/debugger written in C++. It is also available as a [[libretro]] core.
  
==Downloads==
+
==Overview==
* [https://citra-emu.org/download/ Latest nightly and canary builds] (Windows, Linux, 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. On May 23, 2020, an [https://citra-emu.org/entry/announcing-citra-android/ official Android release] for Citra came out. The minimum requirements are Android 8 (64-bit) and OpenGL ES 3.2 support. Many games achieve playable framerates on a variety of hardware, though the developers recommend an Android device with a Snapdragon 835 chip or better.
 +
 
 +
==Download==
 +
{| cellpadding="4"
 +
|-
 +
|align=center|{{Icon|Win|Lin|Mac}}
 +
|'''[https://citra-emu.org/download/ Latest Nightly and Canary builds]'''
 +
|-
 +
|align=center|{{Icon|Android-big}}
 +
|'''[https://play.google.com/store/apps/details?id=org.citra.citra_emu Beta 15]<br>[https://github.com/citra-emu/citra-android/releases Official]'''
 +
|-
 +
|align=center|{{Icon|Android-big}}
 +
|'''[https://github.com/weihuoya/citra/releases Unofficial]'''
 +
|}
  
 
==Shared data==
 
==Shared data==
Line 34: Line 49:
 
===Emulation issues===
 
===Emulation issues===
 
Emulation for various features is non-existent or not actively worked on enough to be in a usable state. This includes:
 
Emulation for various features is non-existent or not actively worked on enough to be in a usable state. This includes:
* Connectivity features relying on Wi-Fi (Wii U/3DS, Switch/3DS, 3DS Local Multiplayer, 3DS Online...), not in small part due to the setbacks hindering Wi-Fi DS emulation.
+
* Connectivity features relying on Wi-Fi (Wii U/3DS, Switch/3DS, 3DS Local Multiplayer, 3DS Online...), not in small part due to the setbacks hindering Wi-Fi DS emulation. However, Download Play is emulated.
* New 3DS mode. Throws a fatal error or tries to emulate in old 3DS mode. Even when the source is modified to allow for New 3DS mode, it's still too buggy and crash-prone to be usable.
+
* New 3DS mode. It is now in a playable state, but some games may still crash with it enabled.
* Stereoscopic 3D visual effect. Was worked on briefly before being abandoned.
 
  
===Game Image Format===
+
===Game image format===
 
Citra accepts games in '''.3ds, .cia or .cxi format'''. Furthermore, in Summer 2017, chances are your existing dumps tailor-made for Citra most probably made with the officially recommended tool braindump, which were missing some data yet could be emulated on Citra, have had their compatibility broken as a design choice with no options provided to fix those dumps. You'll have to get new dumps.
 
Citra accepts games in '''.3ds, .cia or .cxi format'''. Furthermore, in Summer 2017, chances are your existing dumps tailor-made for Citra most probably made with the officially recommended tool braindump, which were missing some data yet could be emulated on Citra, have had their compatibility broken as a design choice with no options provided to fix those dumps. You'll have to get new dumps.
  
Furthermore, while the latest sighax exploit allows for dumping decryption keys to convert (and possibly load) encrypted games in either .3ds or .cia format, development for a solution to allow for this Citra, even one requiring keys from your console, isn't actively pursued ''as a design choice''. Tools on 3DS and PC exist to convert those to decrypted .3ds format for the time being, and a guide can be found [[Nintendo 3DS emulators#Encryption|here]].
+
While the latest sighax exploit allows for dumping decryption keys to convert (and possibly load) encrypted games in either .3ds or .cia format, development for a solution to allow for this Citra, even one requiring keys from your console, was formerly not actively pursued ''as a design choice''. Tools on 3DS and PC exist to convert those to decrypted .3ds format, and a guide can be found [[Nintendo 3DS emulators#Encryption|here]]. However, Citra now allows loading/installing encrypted 3ds/CIA files if the necessary AES keys are provided. The required keys are provided with the 3DS Shared Data downloadable above.
  
 
===Telemetry===
 
===Telemetry===
 
Citra developers decided to implement a telemetry feature uploading to them through Internet connection detailed logs and data about your computer specs and the games you're playing. When booting Citra for the first time, you get asked if you want to enable it.
 
Citra developers decided to implement a telemetry feature uploading to them through Internet connection detailed logs and data about your computer specs and the games you're playing. When booting Citra for the first time, you get asked if you want to enable it.
  
==Playing Citra on your phone==
 
[https://github.com/uberhalit/CitraTouchControl This] program allows you to control Citra with touch controls on your phone.
 
It is, therefore, possible to use a [https://play.google.com/store/apps/details?id=com.microsoft.rdc.android.beta remote desktop client] via your phone, to emulate with Citra and stream from your PC to your phone.
 
See gif.
 
 
[[File:Citra_Remote.gif|thumb|right|Example of remote phone play on Citra. (Click to play)]]
 
 
An [https://github.com/SachinVin/citra_android unofficial frontend software] for running Citra on [[Android emulators|Android devices]] has been created by SachinVin, and its first binary release came out on [https://github.com/SachinVin/citra_android/releases/tag/v0.1.0-pre-alpha May 23, 2018]. It was based off the [[Dolphin]] frontend for Android. It is in continuous development with newer releases as of late 2018. It is slow and possibly with no sound, and its compatibility level is low.
 
  
 
==External links==
 
==External links==
 
* [https://citra-emu.org/game/ Official compatibility list]
 
* [https://citra-emu.org/game/ Official compatibility list]
* [https://www.ziperto.com/nintendo/3ds-roms/decrypted-3ds-roms/ Playable Decrypted ROM's Collection]
+
* [https://citra-emu.org/discord/ Official Discord server]
* [https://citra-emu.org/discord/ Discord channel]
 
 
* [https://community.citra-emu.org/ Official Citra forum]
 
* [https://community.citra-emu.org/ Official Citra forum]
 
* [https://www.youtube.com/channel/UC_dcdgzuapBtAY4ol3x-90Q Official YouTube channel]
 
* [https://www.youtube.com/channel/UC_dcdgzuapBtAY4ol3x-90Q Official YouTube channel]
  
 +
[[Category:Emulators]]
 +
[[Category:Console emulators]]
 +
[[Category:Handheld console emulators]]
 
[[Category:Nintendo 3DS emulators]]
 
[[Category:Nintendo 3DS emulators]]
[[Category:Emulators]]
 
 
[[Category:Windows emulation software]]
 
[[Category:Windows emulation software]]
 
[[Category:Linux emulation software]]
 
[[Category:Linux emulation software]]
 
[[Category:macOS emulation software]]
 
[[Category:macOS emulation software]]
 +
[[Category:Android emulation software]]

Revision as of 17:16, 18 March 2022

Citra
Citra.png
Developer(s) Citra Team
Latest version N/A
Active Yes
Platform(s) Windows
Linux
macOS
Android
Emulates Nintendo 3DS
Compatibility Official List
Website Citra-emu.org
Support ($) Patreon
Programmed in C++
License GNU GPLv2
Source code GitHub
BIOS/Keys Required for some games and decryption

Citra is an open-source Nintendo 3DS emulator/debugger written in C++. It is also available as a libretro core.

Overview

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. On May 23, 2020, an official Android release for Citra came out. The minimum requirements are Android 8 (64-bit) and OpenGL ES 3.2 support. Many games achieve playable framerates on a variety of hardware, though the developers recommend an Android device with a Snapdragon 835 chip or better.

Download

Windows Linux macOS Latest Nightly and Canary builds
Android Beta 15
Official
Android Unofficial

Shared data

Some 3DS games make use of shared files from the console's system software. These games will not boot in Citra if said files are not present in the user folder.

These files are not provided by the Citra developers for legal reasons, so they can be downloaded from the Emulator Files page.

Importing saves

Some games require this to bypass bugs in title screens.

  1. Get the Title ID for the game version you have from here. For example, we'll try with the European version of Zelda: ALBW. Its full Title ID is 00040000000EC400.
  2. Take the last 8 digits of the Title ID. (in our example, 000EC400) In case this method fails later, take 00000000 instead, or make sure the save file and the ROM image are from the same region.
  3. Make an empty folder named as that partial Title ID (000EC400). Put inside it another folder named "data", then inside that one put another folder named 00000001, then inside that one put the actual save data files.
  4. Move the folder with the title ID and put it here:
    \user\sdmc\Nintendo 3DS\00000000000000000000000000000000\00000000000000000000000000000000\title\00040000

Issues

Emulation issues

Emulation for various features is non-existent or not actively worked on enough to be in a usable state. This includes:

  • Connectivity features relying on Wi-Fi (Wii U/3DS, Switch/3DS, 3DS Local Multiplayer, 3DS Online...), not in small part due to the setbacks hindering Wi-Fi DS emulation. However, Download Play is emulated.
  • New 3DS mode. It is now in a playable state, but some games may still crash with it enabled.

Game image format

Citra accepts games in .3ds, .cia or .cxi format. Furthermore, in Summer 2017, chances are your existing dumps tailor-made for Citra most probably made with the officially recommended tool braindump, which were missing some data yet could be emulated on Citra, have had their compatibility broken as a design choice with no options provided to fix those dumps. You'll have to get new dumps.

While the latest sighax exploit allows for dumping decryption keys to convert (and possibly load) encrypted games in either .3ds or .cia format, development for a solution to allow for this Citra, even one requiring keys from your console, was formerly not actively pursued as a design choice. Tools on 3DS and PC exist to convert those to decrypted .3ds format, and a guide can be found here. However, Citra now allows loading/installing encrypted 3ds/CIA files if the necessary AES keys are provided. The required keys are provided with the 3DS Shared Data downloadable above.

Telemetry

Citra developers decided to implement a telemetry feature uploading to them through Internet connection detailed logs and data about your computer specs and the games you're playing. When booting Citra for the first time, you get asked if you want to enable it.


External links