Add updated versions of the info removed in #10431

Zopolis4 2022-02-03 14:52:52 +11:00
parent d135f8a913
commit 1c07516003
1 changed files with 80 additions and 0 deletions

80
User-and-Data-Folders.md Normal file

@ -0,0 +1,80 @@
## Sys Files
* `wiitdb-*.txt`: Gamecube and Wii language-specific title databases from [GameTDB](https://www.gametdb.com/)
* `totaldb.dsy`: Database of symbols (for devs only)
* `GC/font_western.bin`: font dumps
* `GC/font_japanese.bin`: font dumps
* `GC/dsp_coef.bin`: DSP dumps
* `GC/dsp_rom.bin`: DSP dumps
The DSP dumps included with Dolphin have been written from scratch and do not
contain any copyrighted material. They should work for most purposes, however
some games implement copy protection by checksumming the dumps. You will need
to dump the DSP files from a console and replace the default dumps if you want
to fix those issues.
Wii network certificates must be extracted from a Wii IOS. A guide for that can be found [here](https://wiki.dolphin-emu.org/index.php?title=Wii_Network_Guide).
## Folder Structure
These folders are installed read-only and should not be changed:
* `GameSettings`: per-game default settings database
* `GC`: DSP and font dumps
* `Maps`: symbol tables (dev only)
* `Shaders`: post-processing shaders
* `Themes`: icon themes for GUI
* `Resources`: icons that are theme-agnostic
* `Wii`: default Wii NAND contents
## Packaging and udev
The Data folder contains a udev rule file for the official GameCube controller
adapter and the Mayflash DolphinBar. Package maintainers can use that file in their packages for Dolphin.
Users compiling Dolphin on Linux can also just copy the file to their udev
rules folder.
## User Folder Structure
A number of user writeable directories are created for caching purposes or for
allowing the user to edit their contents. On macOS and Linux these folders are
stored in `~/Library/Application Support/Dolphin/` and `~/.dolphin-emu`
respectively, but can be overwritten by setting the environment variable
`DOLPHIN_EMU_USERPATH`. On Windows the user directory is stored in the `My Documents`
folder by default, but there are various way to override this behavior:
* Creating a file called `portable.txt` next to the Dolphin executable will
store the user directory in a local directory called "User" next to the
Dolphin executable.
* If the registry string value `LocalUserConfig` exists in
`HKEY_CURRENT_USER/Software/Dolphin Emulator` and has the value **1**,
Dolphin will always start in portable mode.
* If the registry string value `UserConfigPath` exists in
`HKEY_CURRENT_USER/Software/Dolphin Emulator`, the user folders will be
stored in the directory given by that string. The other two methods will be
prioritized over this setting.
List of user folders:
* `Cache`: used to cache the ISO list
* `Config`: configuration files
* `Dump`: anything dumped from Dolphin
* `GameSettings`: additional settings to be applied per-game
* `GBA`: GBA saves
* `GC`: memory cards and system BIOS
* `Load`: custom textures
* `Logs`: logs, if enabled
* `Maps`: Symbol maps generated by Dolphin
* `ResourcePacks`: A way of managing custom textures, separate from the Load directory
* `ScreenShots`: screenshots taken via Dolphin
* `Shaders`: post-processing shaders
* `StateSaves`: save states
* `Styles`: color themes for GUI
* `Themes`: icon themes for GUI
* `Wii`: Wii NAND contents
## Custom Textures (Not Resource Packs)
Custom textures have to be placed in the user directory under
`Load/Textures/[GameID]/`. You can find the Game ID by right-clicking a game
in the ISO list and selecting "ISO Properties".