| Both sides previous revision Previous revision Next revision | Previous revision |
| notable_files [2022/07/01 05:09] – [Batocera-specific data/meta information] added batocera-boot atari | notable_files [2023/01/09 15:51] (current) – [Batocera bundled content] lbrpdx |
|---|
| |
| ^ File purpose ^ Github source location ^ Final image location (x86_64) ^ Notes ^ | ^ File purpose ^ Github source location ^ Final image location (x86_64) ^ Notes ^ |
| | Config generators (emulator defaults) | https://github.com/batocera-linux/batocera.linux/tree/master/package/batocera/core/batocera-configgen/configgen/configgen/generators | ''/usr/lib/python3.9/site-packages/configgen/generators/'' | The infamous Python configuration generators, bane of the end-user who's used to modifying INI and XML files directly. These are what create the necessary configuration files, controller profiles and any other necessary INI/CFG file an emulator uses upon launching an emulator. Used in conjunction with [[#emulationstation_options|ES advanced per-system options]] to make these generated configs based on the options the user has set in ES. If creating a new one, don't forget to [[#batocera-specific_data_meta_information|define it]] as well. | | | Config generators (emulator defaults) | https://github.com/batocera-linux/batocera.linux/tree/master/package/batocera/core/batocera-configgen/configgen/configgen/generators | ''/usr/lib/python#.#/site-packages/configgen/generators/'' | The infamous Python configuration generators, bane of the end-user who's used to modifying INI and XML files directly. These are what create the necessary configuration files, controller profiles and any other necessary INI/CFG file an emulator uses upon launching an emulator. Used in conjunction with [[#emulationstation_options|ES advanced per-system options]] to make these generated configs based on the options the user has set in ES. If creating a new one, don't forget to [[#batocera-specific_data_meta_information|define it]] as well. | |
| | Emulator launch command array generator | https://github.com/batocera-linux/batocera.linux/blob/master/package/batocera/emulationstation/batocera-es-system/batocera-es-system.py | Generates ''/usr/share/emulationstation/es_systems.cfg'' and ''es_features.cfg'' | This one generates the run command (command array) that is written to ''/usr/share/emulationstation/es_systems.cfg'' in the final image. | | | Emulator launch command array generator | https://github.com/batocera-linux/batocera.linux/blob/master/package/batocera/emulationstation/batocera-es-system/batocera-es-system.py | Generates ''/usr/share/emulationstation/es_systems.cfg'' and ''es_features.cfg'' | This one generates the run command (command array) that is written to ''/usr/share/emulationstation/es_systems.cfg'' in the final image. | |
| | Emulator config generator | https://github.com/batocera-linux/batocera.linux/tree/master/package/batocera/core/batocera-configgen/configgen/configgen/generators followed by /<system name>/<system name>Generator.py | ''/usr/lib/python3.9/site-packages/configgen/generators/<system name>/<system name>Generator.py'' | The "main" generator script for an emulator. This is the file that is specified by the [[#batocera-specific_data_meta_information|emulator launcher specifier]]. This script can be separated into multiple scripts that call upon each other to separate and better organize the code. | | | Emulator config generator | https://github.com/batocera-linux/batocera.linux/tree/master/package/batocera/core/batocera-configgen/configgen/configgen/generators followed by /<system name>/<system name>Generator.py | ''/usr/lib/python3.9/site-packages/configgen/generators/<system name>/<system name>Generator.py'' | The "main" generator script for an emulator. This is the file that is specified by the [[#batocera-specific_data_meta_information|emulator launcher specifier]]. This script can be separated into multiple scripts that call upon each other to separate and better organize the code. | |
| | ROM directory bundled files | https://github.com/batocera-linux/batocera.linux/tree/master/package/batocera/emulationstation/batocera-es-system/roms | ''/usr/share/batocera/data/roms'' (formerly ''/usr/share/batocera/datainit/roms''), which is copied to ''/userdata/roms/'' on drive initialization | These are all the bundled ROMs with their metadata/images included with a freshly-flashed Batocera install. Also includes additional readme files that weren't generated by ''es_systems.yml''. Emulators that fail to create their own directory can instead have it created here. | | | ROM directory bundled files | https://github.com/batocera-linux/batocera.linux/tree/master/package/batocera/emulationstation/batocera-es-system/roms | ''/usr/share/batocera/data/roms'' (formerly ''/usr/share/batocera/datainit/roms''), which is copied to ''/userdata/roms/'' on drive initialization | These are all the bundled ROMs with their metadata/images included with a freshly-flashed Batocera install. Also includes additional readme files that weren't generated by ''es_systems.yml''. Emulators that fail to create their own directory can instead have it created here. | |
| | ES themes | Theme has its own repo, https://github.com/fabricecaruso/es-theme-carbon which is called from at https://github.com/batocera-linux/batocera.linux/blob/master/package/batocera/emulationstation/es-theme-carbon/es-theme-carbon.mk | ''/usr/share/emulationstation/themes/'', user can append more themes by adding them to ''/userdata/themes/'' | Themes included with Batocera. Right now, only es-theme-carbon is included: https://github.com/fabricecaruso/es-theme-carbon | | | ES themes | Theme has its own repo, https://github.com/fabricecaruso/es-theme-carbon which is called from at https://github.com/batocera-linux/batocera.linux/blob/master/package/batocera/emulationstation/es-theme-carbon/es-theme-carbon.mk | ''/usr/share/emulationstation/themes/'', user can append more themes by adding them to ''/userdata/themes/'' | Themes included with Batocera. Right now, only es-theme-carbon is included: https://github.com/fabricecaruso/es-theme-carbon | |
| | Downloadable themes | https://updates.batocera.org/themes.txt | The list which shows which themes can be downloaded directly from their Github repository in the Content Downloader. | | | Downloadable themes | https://batocera.org/themes.php | The list which shows which themes can be downloaded directly from their Github repository in the Content Downloader. | |
| | Batocera bezels (for RetroArch/MAME) | https://github.com/batocera-linux/batocera-bezel | ''/usr/share/batocera/data/decorations/default/systems/'' (formerly ''/usr/share/batocera/datainit/decorations/default/systems/''), where ''default/'' is symlinked to ''default_unglazed/'' | The "decorations" included and displayed in-game by default. Two files are required for a bezel, the PNG image and the respective INFO text file specifying its viewport dimensions. | | | Batocera bezels (for RetroArch/MAME) | https://github.com/batocera-linux/batocera-bezel | ''/usr/share/batocera/data/decorations/default/systems/'' (formerly ''/usr/share/batocera/datainit/decorations/default/systems/''), where ''default/'' is symlinked to ''default_unglazed/'' | The "decorations" included and displayed in-game by default. Two files are required for a bezel, the PNG image and the respective INFO text file specifying its viewport dimensions. | |
| | Batocera controller overlays | https://github.com/batocera-linux/batocera-controller-overlays | ''/usr/share/batocera/controller-overlays/'' | The "system" decoration tattoos which show the current system's controls. Only one file is required for this (so far), a PNG with 225px width. | | | Batocera controller overlays | https://github.com/batocera-linux/batocera-controller-overlays | ''/usr/share/batocera/controller-overlays/'' | The "system" decoration tattoos which show the current system's controls. Only one file is required for this (so far), a PNG with 225px width. | |
| ^ File purpose ^ Github source location ^ Final image location (x86_64) ^ Notes ^ | ^ File purpose ^ Github source location ^ Final image location (x86_64) ^ Notes ^ |
| | Architecture boot makefiles/binaries | https://github.com/batocera-linux/batocera.linux/tree/master/package/batocera/boot | Used in compiling Batocera; if binaries are included then ''/boot/'' | These are the makefiles for building the boot partition. Usually just a manner of copying files over from the below directory, but sometimes require a bit more complex instructions. | | | Architecture boot makefiles/binaries | https://github.com/batocera-linux/batocera.linux/tree/master/package/batocera/boot | Used in compiling Batocera; if binaries are included then ''/boot/'' | These are the makefiles for building the boot partition. Usually just a manner of copying files over from the below directory, but sometimes require a bit more complex instructions. | |
| | Boot partition patches | https://github.com/batocera-linux/batocera.linux/tree/master/board/batocera | Usually in boot, but patches can be applied to any location as needed | These are the patches made on a per-platform basis. Most of the time, they're just the simple files required to boot the system, but can also include special patches/configuration files needed to have particular components work on a particular platform. ''fsoverlay'' contains the files copied over to the boot partition. Try to keep this as small as possible, only the minimum required to boot the device, and handle the rest with packages. | | | Boot and userdata partition patches | https://github.com/batocera-linux/batocera.linux/tree/master/board/batocera | Usually in boot, but patches can be applied to any location as needed | These are the patches made on a per-platform basis. Most of the time, they're just the simple files required to boot the system, but can also include special patches/configuration files needed to have particular components work on a particular platform. ''boot'' contains the files copied over to the boot partition, while ''fsoverlay'' contains the files to be copied over to the userdata partition. Try to keep this as small as possible, only the minimum required to boot the device, and handle the rest with packages. | |
| | Build flags | https://github.com/batocera-linux/batocera.linux/tree/master/configs | N/A, only used in compiling Batocera | Boot flags, which define what components will be built with your image depending on your chose architecture. If you're trying to port Batocera to a new architecture (device, platform, new bit mode, etc.) this is the file you'll need to edit. More information on [[batocera.linux_buildroot_modifications#define_your_configuration|the build configuration section on the buildroot compiling page]]. | | | Build flags | https://github.com/batocera-linux/batocera.linux/tree/master/configs | N/A, only used in compiling Batocera | Boot flags, which define what components will be built with your image depending on your chose architecture. If you're trying to port Batocera to a new architecture (device, platform, new bit mode, etc.) this is the file you'll need to edit. More information on [[batocera.linux_buildroot_modifications#define_your_configuration|the build configuration section on the buildroot compiling page]]. | |
| | Included emulators config file | https://github.com/batocera-linux/batocera.linux/blob/master/package/batocera/core/batocera-system/Config.in | N/A, used during compilation | This decides which emulators are included in which platform images. If your platform doesn't support a particular emulator or the system performs too poorly to be usable in any aspect, this is where you would go to disable it. | | | Included emulators config file | https://github.com/batocera-linux/batocera.linux/blob/master/package/batocera/core/batocera-system/Config.in | N/A, used during compilation | This decides which emulators are included in which platform images. If your platform doesn't support a particular emulator or the system performs too poorly to be usable in any aspect, this is where you would go to disable it. | |
| | Boot scripts | Mixture of packages from https://github.com/batocera-linux/batocera.linux/tree/master/package/batocera/core and https://github.com/batocera-linux/batocera.linux/tree/master/package/batocera/core/batocera-scripts/scripts | ''/etc/init.d/'' | All the init.d scripts that run at boot time. This can be helpful in diagnosing what order Batocera is initializing modules/files in. | | | Boot scripts | Mixture of packages from https://github.com/batocera-linux/batocera.linux/tree/master/package/batocera/core and https://github.com/batocera-linux/batocera.linux/tree/master/package/batocera/core/batocera-scripts/scripts | ''/etc/init.d/'' | All the init.d scripts that run at boot time. This can be helpful in diagnosing what order Batocera is initializing modules/files in. | |
| |