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

adding a wiki article about Citra's user directory

tekas 2016-11-18 11:22:35 -06:00
parent 2661323dc1
commit e85cd66531
1 changed files with 87 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

87
User-Directory.md Normal file

@ -0,0 +1,87 @@
## The User Directory
Citra's user directory is where the emulator persists the emulated 3DS NAND, save data, extra data, and a host of other files necessary for Citra to run properly. On Windows it is the user folder in the same directory as the Citra executable. on macOS and Linux it is at `~/.local/share/citra-emu/`.
There are at least three directories within the user directory: `config`, `nand`, and `sdmc`. For users that have dumped their [[Home Folder]], there will also be a `sysdata` directory. See below for details about each directory and what data is stored within.
```
"User directory"
├── config
├── nand
│   ├── 00000000000000000000000000000000 (optional)
│   └── data
│   ├── extdata
│   └── sysdata
├── sdmc
│   └── Nintendo 3DS
│   ├── 00000000000000000000000000000000
│   | └── 00000000000000000000000000000000
│   | ├── extdata
│   | └── title
│   └── Private
└── sysdata (optional)
```
---
### config
This directory contains files containing information that tell Citra how to run. These files are in plain text and thus are fully editable and contain configurations for mapping controls, which [[CPU]] and audio engine to use, rendering and other visual options, the [[Log Filters]], which region the emulated 3DS belongs to, whether to treat the emulated 3DS as a new 3DS, and whether to insert a virtual SD card into the emulated system.
Changing these files is only to be done by advanced users because making changes at random can cause Citra not to work as expected or at all. The Citra executable has options menus that allow users to change most of the aforementioned configurations safely. If Citra has trouble running after changing a file and the user cannot remember what they changed, delete the configuration files and run the executable again so that they are regenerated automatically (albeit as though Citra is being run for the first time so any existing configurations are lost).
### nand
This directory is the emulated 3DS system NAND. It does not match an actual console's NAND exactly due to differences between Citra and a physical 3DS. This directory will contain the `data` directory and potentially also the system archives.
#### data
This directory is automatically generated by Citra and contains the system and extra data for the emulated NAND. Inside this directory is another directory, `00000000000000000000000000000000`. On a physical 3DS, the directory inside `data` would be named differently. Its name would be 32 characters long and made of hexadecimal characters (0-9 and A-F) instead of it being all 0's like Citra. This knowledge is only important if you plan on dumping any NAND system data or extra data from a physical 3DS and associating it with Citra. The `00000000000000000000000000000000` contains two folders, `extdata`, containing NAND extra data, and `sysdata`, containing NAND system save data.
##### extdata
NAND extra data always has a TID High of 00048000, so the `extdata` directory should contain a `00048000` folder, though it has been observed in Citra that there may be a `00000000` folder instead, and users have reported issues if there is both a `00000000` and `00048000` folder contained therein, so it is advised to delete the `00000000` folder if that is the case. Inside the folder may be nothing, or it may contain one or more directories named `F000000#`, where # can be the characters A-F or the numbers 0-9. Each of these folders corresponds to a TID low, which can be used to identify the type of extra data stored therein. See [3dbrew](https://www.3dbrew.org/wiki/Extdata?section=13#NAND_Shared_Extdata) for details about the different kinds of extra data stored in NAND.
At this point in time, it is possible to dump extra data from a physical 3DS's NAND using a save manager like [JKSM](https://github.com/J-D-K/JKSM) and to place it in the `extdata` directory, but doing so is entirely optional and Citra does not currently emulate NAND features that utilize most of this extra data.
##### sysdata
System save data is identified by a title ID,separated into TID High, the first 8 characters of the title ID, and TID Low, the last 8 characters of the title ID. Most system save data has a TID high of 00000000. An individual piece of system save data is stored in `sysdata/<TID Low>/<TID High>`. For details about the different kinds of system save data, see [3dbrew](https://www.3dbrew.org/wiki/System_SaveData). For first-time Citra users, there may be nothing inside the `sysdata` directory. In fact this will be the case for most Citra users, and is nothing to be alarmed about. This data will be created automatically in some cases, such as when a Mii is saved in Mii Maker. Almost none of this data is essential for Citra to run homebrew games or backups of licensed titles.
There is one notable exception to the last statement. Citra requires a dump of a physical 3DS's config savegame in order to run a small number of games. If this is correctly placed, there should be folder named `00010017` inside Citra's `sysdata` directory. The full path to the config savegame is `<User Directory>/nand/data/00000000000000000000000000000000/sysdata/00010017/00000000/config`. See the [[Home Folder]] tutorial for instructions on obtaining the config savegame from a physical 3DS console.
Other system save data aside from the config savegame can be dumped from a 3DS console by an expert user and placed in the `sysdata` folder. At this time, though, many features that read from or write to system save data have not been implemented so there is currently little value in doing so. See [this discussion topic](https://discuss.citra-emu.org/d/905-nand-sysdata) for more details about dumping system save data.
#### system archives
This folder, named `00000000000000000000000000000000`, will only exist if the system archives have been dumped from a physical 3DS. The system archives are required for some games to work with Citra. See the [[Home Folder]] tutorial for instructions on obtaining the system archives.
### sdmc
This directory is the equivalent of the SD card inserted into a physical 3DS, which stores game save and extra data and any titles installed to the SD card in encrypted format, though Citra does not currently emulate installing titles to SD and instead runs decrypted .3ds, .app, and .cxi files directly from the computer's filesystem. Inside the `sdmc` folder, just like on a real 3DS console, is a `Nintendo 3DS` directory, which contains two more directories, `Private` and `00000000000000000000000000000000`.
#### Private
The `Private` directory on a real 3DS contains camera data (in `00020400/phtcache.bin`) and sound data (in `00020500`/voice/...`). Citra will create camera data while it is running. If a user wants to copy their camera and sound data to Citra, they can do so easily by copying the `Private` folder from their SD card and overwriting Citra's, but at this time there is no value in doing so.
#### 00000000000000000000000000000000
This directory contains another directory of the same name, and inside of that is where game saves (in the `title` directory) and extra data (in the `extdata` directory) can be found. On a real SD card, there would not be two `00000000000000000000000000000000` folders, but instead the folders would be named as hexadecimal characters corresponding to a 3DS console ID. If a user wishes to extract save or extra data from their physical console, they do not need to worry about the console ID not matching Citra's `00000000000000000000000000000000` folders.
##### extdata
This directory contains all of the extra data created when playing 3DS game backups. Citra emulates a console's behavior of reading from and writing to extra data, so this data can be dumped from an SD card using a physical 3DS console and imported into Citra. See [[Dumping Extra Data from a 3DS Console]] for instructions.
##### sysdata
If any games have been saved while playing them with Citra, there should be a folder inside `sysdata` named `00040000`. This folder contains all of the save data for 3DS titles. It is entirely possible to retrieve save data from an SD card using a physical 3DS console and import it into Citra to continue a game where it was last left off on the console. See [[https://github.com/citra-emu/citra/wiki/Dumping-Save-Data-from-a-3DS-Console]] for instructions. On a real SD card, the `sysdata` folder will also contain the files required to run any 3DS titles installed to the SD card. This can be mimicked somewhat by [decrypting the .app files on the SD card](Dumping Installed Titles) and importing them into Citra's `sysdata` directory but this is unnecessary since Citra can run them from anywhere on a computer filesystem and doesn't require the accompanying .tmd and .cmd files.
On a real SD card, there may be two other directories inside `sysdata`. These directories are named `0004000e` and `0004008c` and correspond to downloaded game updates and DLC respectively. The data contained within these directories can be decrypted backed up on a computer, but at this time features have not been implemented in Citra to utilize any of it, so titles cannot be played with DLC or updates applied to them unless the user is willing to unpack their game backup, merge the updates with the game files, and then repack the game. See [this](https://discuss.citra-emu.org/d/527-smash-bros-update) and [this](https://discuss.citra-emu.org/d/818-where-are-the-updates-and-dlcs-in-the-nand-folder) relevant discussion topics.
##### other folders
If a real SD card is compared to Citra's emulated SD card, Citra may appear to be missing one or more folders present on the real SD card: `dbs`, `backups`, and `Nintendo DSiWare`. The `dbs` folder contains a 3DS console's title database. The `backups` folder contains saved data backed up via the Home Menu. The `Nintendo DSiWare` folder contains exported DSi exports. Citra does not need any of these folders so there is currently no value in dumping them.
### sysdata
This directory has only one purpose, to hold the system font in a file called `shared_font.bin`. It is necessary in order to play some games, but Citra does not create this file automatically due to copyright restrictions. It must be dumped from a physical 3DS console. See the [[Home Folder]] tutorial for instructions on obtaining the system font.