--- Pseudo Saturn Kai Settings File ---
Text-based settings for use with Gamer's Cartridge or Satiator ODE.
 https://ppcenter.webou.net/pskai/


1. Overview
==========================================
Pseudo Saturn Kai main settings are saved in Saturn internal backup memory.

In addition to these settings, it is possible to specify additional settings
by using `pskai.ini' file located in SD card root folder.
This setting method supports the following devices :
 - Gamer's Cartridge : https://ppcenter.webou.net/satcart/#gamers
 - Satiator ODE      : https://www.satiator.net/

Usage of `pskai.ini' settings file is intended for fine tuning and consequently
optional.
When the file is not found, Pseudo Saturn Kai uses recommended settings.

 1a. Settings File Structure
------------------------------------------
Settings file is separated into several sections and these sections can contain
several keys and a value can be set to a key by using equal `=' sign.
Additionally, comments can be set by typing a semicolon `;' sign at the
beginning of a line.

Maximum allowed settings file size is 8000 bytes.
Maximum allowed length for a row is 200 bytes.

Supported text encoding is ASCII.
Usage of European or Asian characters in comments is possible if text encoding
is backward compatible with ASCII. In that case, usage of UTF-8 is recommended.


2. Settings Details
==========================================
 2a. Save Data Extra Export
------------------------------------------
When exporting individual save files using "Export Save(s) from Memory
Device(s)" or "Export Save(s) from Action Replay", save data is always exported
in BUP format with an associated text report.

Example : BIOPDATA_SS -> /SAVES/20220926/BRAM_001/BIOPDATA_SS.BUP
                      -> /SAVES/20220926/BRAM_001/BIOPDATA_SS.TXT

This setting allows to enable save data export in optional type or location.

[Common]
; Extra save data export :
;  - 0 : recommended settings for target device
;          Gamer's Cartridge : 2 when language is set to Japanese, 1 else
;          Satiator          : 4 when language is set to Japanese, 3 else
;  - 1 : no extra export (fastest setting)
;  - 2 : also export in SSF format
;  - 3 : also export into SAVES -> LATEST folder
;  - 4 : also export in SSF format and into SAVES -> LATEST folder
ExtraExport=0

Please note that if ExtraExport is set to (3) or (4), individual save files will
also be exported in BUP format into SAVES/LATEST folder when using :
 - Export Saturn Backup RAM
 - Export Cartridge Backup RAM
 - Export Cartridge Boot ROM

 2b. Export path type
------------------------------------------
Select the kind of path where save data files are exported.

[Common]
; Export path type :
;  - 0 (default) : export to /SAVES/YYYY/YYYYMMDD folder
;  - 1 : export to /SAVES/YYYYMMDD folder
;  - 2 : export to /SAVES/YYYY/MMDD folder
ExportPathType=0

 2c. Simple Loader Usage Switch
------------------------------------------
Simple Loader shows "Load Homebrew" menu on startup, thus allows to load an
executable or a disc image file without being encumbered by advanced features
available in normal disc image selection menu.

For example, it is faster to list up the contents of a folder, it always show
root folder contents on startup and also always generate disc image descriptor
file so that it is possible to overwrite a disc image and load it even if its
structure is different from the previous version.

This feature doesn't supports long file names, cheat codes, file sorting and as
a consequence this feature is not recommended for normal usage of Satiator ODE
or Gamer's Cartridge.

[Common]
; Simple loader usage switch :
;  - 0 : normal behavior = show disc image selection or game start menu
;  - 1 : show "Load Homebrew" menu on startup
SimpleLoader=0

 2d. Folder naming for Per-Game Saves
------------------------------------------
This setting can disable usage of region code in folder names if you are aware
of something in your personal setup that would negate this protection.

[Common]
;  - 0 : Folders are named according to the product ID only.
;  - 1 : Folders are named according to the product ID and region code.
PerGameRegion=1

Why using game region code in per-game saves folders ?
Because even if game and save name are the same, saves may be be incompatible
from a region to another. This for example concerns Scorcher and to prevent
incompatibility the saves should be stored in the following folders :
    Scorcher (Europe)  -> /SAVES/BRAM/MK-81214[E]
    Scorcher (USA)     -> /SAVES/BRAM/MK-81214[UT]
Details about this issue : https://github.com/retrohead/satiator-rings/issues/10

Then, why allowing to disable usage of region code in save folders names ?
Because some ODEs do on-the-fly region patching of the disc image, which makes
impossible on Pseudo Saturn Kai side to identify its region.
Similarly, disc images whose region code is patched can't be identified by
Pseudo Saturn Kai; this happens when using patcher utilities for modchip or
Satiator Rings (for Satiator ODE) that modifies region code directly on disc
image in order to bypass region protection.

Examples of appropriate setting according to Saturn setup :
 - Original CD-ROM                                : PerGameRegion=1
 - Original CD-ROM copied as-is                   : PerGameRegion=1
 - Satiator ODE and clean disc image files        : PerGameRegion=1
 - Satiator ODE and prior usage of Satiator Rings : PerGameRegion=0

Please note that it's not possible to add region code to folder names when using
per-game saves on Gamer's Cartridge in conjunction with Fenrir and Rhea/Phoebe,
as both ODEs perform on-the-fly region patching.

 2e. Satiator Wait Times
------------------------------------------
These settings allow to tune the time (in milliseconds) before Pseudo Saturn Kai
interacts with Satiator ODE.

These settings are for beta testing or troubleshooting. Please tune them only
when you know what you are doing.

[Satiator]
;  - Small wait  : interval between transfer of two data blocks
;  - Middle wait : interval between read and write operations
;  - Extra wait  : interval before folder listing and during disc image selection menu
SmallWait=0
MiddleWait=0
ExtraWait=0

 2f. Satiator Loader Debug Mode
------------------------------------------
This setting allows to enable an experimental mode when loading a disc image.
Purpose of this experimental mode is to allow the export or loading of custom
cheat codes from/to Satiator SD card.
"Experimental" means it doesn't works. So enable this only if you know what you
are doing !

[Satiator]
; Experimental (debug) loader :
;  - 0 : normal (safe) loader
;  - 1 : experimental (buggy) loader
CdpMode=0

 2g. Satiator version check skip
------------------------------------------
This setting allows to skip Satiator firmware version check before displaying
disc image selection menu.
If usage of an old firmware is required (for testing, or if latest version
doesn't works etc) then this setting should be set to 1.

[Satiator]
; Skip Satiator firmware version check.
;  - 0 : prevent from displaying disc image selection if ODE firmware is not recent enough
;  - 1 : show disc image selection menu whatever the firmware version may be
SkipVerCheck=0

 2h. Soft reset type for Satiator ODE
------------------------------------------
This setting allows to select the soft reset patch to use when A+B+C+Start key
combo is pushed from game title screen.
Faster type doesn't shows Saturn boot animation but isn't compatible with some
few games. Enable it only if you know what you are doing.

[Satiator]
; Soft reset type :
;  - 0 : Slower reset that goes through the Saturn boot animation, 
;        but compatible with more games
;  - 1 : Faster reset that goes straight to the multiplayer menu, 
;        but incompatible with some games
SoftReset=0
