Differences

This shows you the differences between two versions of the page.

--- batocera_conf_syntax [2022/02/18 02:35] – replaced square brackets with round brackets to be less confusing, add colouration too, updated with per folder syntax as well (thanks TVsIan) atari
+++ batocera_conf_syntax [2022/09/06 11:28] (current) – SSH command too atari
@@ Line 13: / Line 13: @@
 ===== batocera.conf option keys and values =====
-''/userdata/system/batocera.conf'' is the main user-configuration file in Batocera. This will contain all the settings you may have set in **GAME SETTINGS**, **ADVANCED PER SYSTEM OPTIONS** and a few other places.
+''/userdata/system/batocera.conf'' is the main user-configuration file in Batocera, it can be [[:add_games_bios#while_batocera_is_running|accessed from the network share or the file manager]] or [[:access_the_batocera_via_ssh|via SSH]] with the following:
+<code bash>
+nano /userdata/system/batocera.conf
+</code>
+This will contain all the settings you may have set in **GAME SETTINGS**, **ADVANCED PER SYSTEM OPTIONS** and a few other places.
 <WRAP center round info>
@@ Line 23: / Line 29: @@
 </WRAP>
-''batocera.conf'' uses the following syntax (objects in ''<''''>'' are required and have to be replaced, including the ''<''''>'' symbols themselves, and objects in ''('''')'' are optional):
+''batocera.conf'' uses the following syntax (objects in ''<''''>'' are required and have to be replaced, including the ''<''''>'' symbols themselves, objects in ''('''')'' are optional and objects separated by a pipe ''|'' indicate exclusive or):
 <code bash>
-(<system>(["<ROM filename>.<ROM extension>"].))(folder["<path>"].)<key name>(.<subkey 1 name> ...)=<value>
+(<system>(["<ROM filename>.<ROM extension>"].)|folder["<path>"].)<key name>(.<subkey 1 name> ...)=<value>
 </code>
@@ Line 65: / Line 71: @@
 This will change the **EXTERNAL PALETTE** option for the [[systems:c64|Commodore 64]] game "Arkanoid - Revenge of Doh" to use the "vice" palette. Here, the system is "c64", the ROM filename and extension is "Arkanoid - Revenge of Doh (USA, Europe).zip", the key name is "external_palette" and the value is "vice". No ''<subkey # name>'' is used.
-**Folder-specific option**
+**Folder-specific option** (introduced in **v34**)
 Here's an example of setting an option for games launched from a certain folder:
@@ Line 74: / Line 80: @@
 This will set the shader set used for all NES games in the ''/userdata/roms/nes/Japan'' folder to use the night variant of the Famicom decoration (''Mega-Bezel-Community-JP-Night'').
+<WRAP center round important>
+Game-specific and folder-specific setting syntaxes conflict with one another. A key using both at the same time will be invalid and ignored.
+</WRAP>
 Key names, systems and values are not locale-specific, they will be the same regardless of which language you are using. The option names themselves are only translated on ES itself when in the menu, the internal key names stay the same.
@@ Line 103: / Line 113: @@
 However, if you'd like to find the keys manually, you have to change your approach depending on which keys you are after:
-  * To find the global keys (ones that can be applied to //most// systems) manually, look through the code and figure out its logic in the launcher script (in the ''/usr/lib/python3.9/site-packages/configgen/'' folder).
+  * To find the global keys (ones that can be applied to //most// systems) manually, look through the code and figure out its logic in the launcher script (in the ''/usr/lib/python#.#/site-packages/configgen/'' folder).
-  * To find the emulator keys (of which apply to all systems that emulator supports, usually) manually, look through the code and figure out its logic in its [[modify_the_system_while_it_s_running#editing_system_files|configuration generator]] (most of which are in ''/usr/lib/python3.9/site-packages/configgen/generators/'').
+  * To find the emulator keys (of which apply to all systems that emulator supports, usually) manually, look through the code and figure out its logic in its [[modify_the_system_while_it_s_running#editing_system_files|configuration generator]] (most of which are in ''/usr/lib/python#.#/site-packages/configgen/generators/'').
   * To see system-specific keys, look at the ''/usr/share/emulationstation/es_features.cfg'' file. The ''features'' tag shows which "global" keys can be applied to your system, while the rest of the system-specific keys are specified in their own core option section.
@@ Line 134: / Line 144: @@
 <code bash>
-<system>(["<ROM filename>.<ROM extension>"].)(folder["<path>"].)retroarch.<RetroArch setting name>=<value>
+<system>(["<ROM filename>.<ROM extension>"]|folder["<path>"]).retroarch.<RetroArch setting name>=<value>
 </code>