Embed a small logo of the console here. It can be gathered from https://github.com/fabricecaruso/es-theme-carbon/tree/master/art/logos (yes the wiki does support uploading SVGs even if it isn't mentioned in the compatible file list). For these SVGs, use &0x300.

<Full System Name Here>

Throughout this template, values enclosed in <> symbols are meant to be entirely replaced, with the <> symbols being removed as well. Text enclosed in [] brackets are optional, depending on the system. Values in tables/lists are examples that should be replaced. Low emphasis text are just notes that should be removed.

A short paragraph giving background to the system being emulated. This is where you might put trivia or a link to a really cool article about it. No need to go super in-depth or technical about it.

This system scrapes metadata for the <system platform> group(s) and loads the <system theme> set from the currently selected theme, if available.

If you'd like to see an example of a system page which has enough features to cover the majority of systems, check out the PSX page.

Here's some filler text: [Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.]

Embed a small ~250-350px image here of the system itself and center-align it inside this column. It's done like this to avoid the text-wrap breaking when the ToC folds up.

  • Emulator: If the system has exactly one emulator that has only one “core”, list its proper name here and don't create the table. Otherwise, exclude this point.
  • Folder: Syntax example: roms/<system shortname>/ Put values from the table here instead if they're the same for all emulators, and remove the column from the table. Typically, the emulators set up will share the same folder for their ROMs, but certain complex emulators may use unique folders/folder structures depending.
  • Accepted ROM formats: Syntax example: .chd .iso .bin Include here instead if shared by all emulators. Typically, different emulators accept different formats.
  • BIOS files: Syntax example: scph1001.bin scph5500.bin scph7001.bin Include here instead if shared by all emulators. Typically all emulators will require the same BIOS files, but there are exceptions. Do your research.
  • BIOS required? Syntax example: <yes, no or optional, why is it optional?> Include here instead if shared by all emulators. Typically, all emulators will either all require BIOS, or have it be optional. Mixes are an exception.
  • Configuration via: Example: EmulationStation, the respective emu-config or both.
Emulators Folder Accepted ROM formats BIOS files BIOS required? Configuration via
Emulator A roms/emuA/ .ext .zip .lol bios.bin Optional, because reasons EmulationStation
Emulator B roms/emuB/ .ext .lol bios2.bin Yes EmulationStation and emu-config

On the off chance that all the emulators share identical characteristics, don't include the table at all, and just list the emulators in a bullet list.

Info about the BIOS files, how to extract them from real hardware (not really required), and if applicable why they are optional and what the benefits of using the real BIOS is compared to the emulated one.

MD5 checksum Share file path Description
c53ca5908936d412331790f4426c6c33 bios/bios.bin Version 1
6e3735ff4c7dc899ee98981385f6f3d0 bios/bios2.bin Version 2

Place your <Full System Name Here> ROMs in /userdata/roms/short system name here/.

Info about the ROM files, what kinds of formats they can come in and any information specific to their format(s). It is also useful to note any special features that are ROM related like multi-disc playlists and how to set them up here.

[Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.]

Emulator A [is a cool emulator that focuses on X attribute. Common resources for getting info on such emulators are their own websites, wiki, forum, Github pages. You can also scour docs.libretro if it's a libretro core specifically, or that other wiki if it's infamous enough.]

What platforms should this emulator be used on? Are there any special notes or reasons why it's included in Batocera over other emulators?

Emulator A configuration

Standardized features available: system.option_A, system.option_B

ES setting name batocera.conf_key Description ⇒ ES option key_value
OPTION NAME AS IT APPEARS IN ES systemshortname.emulator_option A description of what this setting does. Try to make it as approachable as possible without being more than a paragraph long, if you need longer it might be worth adding it as its own section.
⇒ Option A value_a, Option B value_b, Option C value_c

Any special notes about configuration should go here, as well as alternative locations for editing the CFG file if applicable (most emulators won't need this).

Emulator B [is an emulator only available on X platforms due to it performing better on X boards. It is not available on the x86/x86_64 build.]

Emulator B configuration

Standardized features available: system.option_A, system.option_B

ES setting name batocera.conf_key Description ⇒ ES option key_value
OPTION NAME AS IT APPEARS IN ES systemshortname.emulator_option A description of what this setting does. Try to make it as approachable as possible without being more than a paragraph long, if you need longer it might be worth adding it as its own section.
⇒ Option A value_a, Option B value_b, Option C value_c

The default button mapping for the <system shortname>'s controls is as follows::

Embed a large image showing the controller's mapping. There should be one available for the system at https://github.com/batocera-linux/batocera-controller-overlays/tree/master/solid-4k . In case it hasn't been created yet, the controller pictures at docs.libretro for the system generally share the same layouts. It should be clear and easy to understand.

[Troubleshooting information that is applicable to only this system.]

For further troubleshooting, refer to the generic support pages.

  • playground/systems/template.txt
  • Last modified: 5 days ago
  • by atari