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

Updating user directory page in preparation to replace the home folder page

tekas 2016-11-29 11:10:09 -06:00
parent 31f98cdf1b
commit a64cb58cd2
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
User-Directory.md

@ -2,7 +2,7 @@
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.
There are at least three directories within the user directory: `config`, `nand`, and `sdmc`. For users that have dumped the shared fonts from a 3DS console, there will also be a `sysdata` directory. See below for details about each directory and what data is stored within.
```
"User directory"
@ -22,6 +22,16 @@ There are at least three directories within the user directory: `config`, `nand`
└── sysdata (optional)
```
### Dumping files from a 3DS
Included in this guide are instructions on how to dump various files from a 3DS console to put into the Citra user directory. These files are optional in terms of Citra's ability to run, but depending on certain circumstances some may be required in order to run a particular game or get past a certain point in the game. In general, dumping files from a 3DS will require an SD card reader or some way to use wireless file transfer from a 3DS to a computer and that the 3DS being dumped from has [Homebrew Launcher](http://smealum.github.io/3ds/) access. More advanced users will also have [custom firmware](https://3ds.guide/) and [Decrypt9WIP](https://github.com/d0k3/Decrypt9WIP) installed to their 3DS.
If the below articles are too wordy, consult the below tutorials for obtaining optional files to improve the Citra experience:
* [[Dumping System Archives and the Shared Fonts from a 3DS Console]]
* [[Dumping Config Savegame from a 3DS Console]]
* [[Dumping Save Data from a 3DS Console]]
* [[Dumping Extra Data from a 3DS Console]]
---
### config
@ -48,13 +58,13 @@ At this point in time, it is possible to dump extra data from a physical 3DS's N
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.
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 you are playing a game and encounter an error similar to `Service.CFG <Error> core/hle/service/cfg/cfg.cpp:GetConfigInfoBlock:197: Config block 0xB0001 with flags 2 and size 2048 was not found`, then a dumped config savegame is needed. Follow the instructions located at [[Dumping Config Savegame from a 3DS Console]] to obtain the config savegame from a 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.
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. To obtain the system archives, follow the instructions located at [[Dumping System Archives and the Shared Fonts from a 3DS Console]].
### sdmc
@ -84,4 +94,4 @@ If a real SD card is compared to Citra's emulated SD card, Citra may appear to b
### 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.
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. To obtain the file, follow the instructions located at [[Dumping System Archives and the Shared Fonts from a 3DS Console]].