LogoLogo
Retrobat WebsiteForumGithub
English
English
  • Welcome!
  • Get Started
    • Prerequisites
    • Installation & First Startup
    • RetroBat Folder Structure
    • Adding a game
    • Running a game
    • Adding BIOS files
  • NAVIGATION
    • Navigation Keys
    • Hotkeys
    • System View and Game View
    • Main Menu
    • View Options
    • Game Options
    • Configuration of systems and games
    • Scraping & Metadata
    • Game Collections
  • Systems & Emulators
    • Arcade Guide
    • Supported Game Systems
      • Game Consoles
        • 3DO
        • Actionmax
        • Adventure Vision
        • Amstrad GX4000
        • APF MP-1000
        • Arcadia 2001
        • Atari (consoles)
          • Atari 2600
          • Atari 5200
          • Atari 7800
          • Atari XEGS
          • Jaguar
          • Jaguar CD
        • Bally Astrocade
        • Casio Loopy
        • Channel F
        • ColecoVision
        • Commodore (game consoles)
          • Amiga CDTV
          • Amiga CD32
        • Intellivision
        • Lowres NX
        • Microsoft (consoles)
          • Xbox
          • Xbox 360
        • NEC (consoles)
          • PC Engine/TurboGrafx-16
          • PC Engine CD-ROM/TurboGrafx-CD
          • SuperGrafx
          • PC-FX
        • Nintendo (game consoles)
          • Nintendo Entertainment System - Family Computer
          • Family Computer Disk System
          • NES 3D
          • Super Nintendo Entertainment System - Super Famicom
          • Satellaview
          • SuFami Turbo
          • Super NES MSU-1
          • Super Game Boy
          • Nintendo 64
          • Nintendo 64 Disk Drive
          • GameCube
          • Wii
          • WiiU
          • Switch
        • Philips CD-i
        • Odyssey²
        • Othello Multivision
        • PV-1000
        • Sega (game consoles)
          • SG-1000
          • Master System - Mark III
          • Megadrive - Genesis
          • Megadrive - Genesis (MSU)
          • Mega-CD - Sega-CD
          • Sega 32X
          • Saturn
          • Dreamcast
        • SNK (game consoles)
          • Neo Geo
          • Neo Geo CD
        • Sony (game consoles)
          • PlayStation
          • PlayStation 2
          • Playstation 3
          • Playstation 4
        • Super Cassette Vision
        • Super A'Can
        • Uzebox
        • VC4000
        • Vectrex
        • Vircon32
        • VTech
          • CreatiVision
          • V.Smile
      • Portable Game Consoles
        • Arduboy
        • Atari (portable game consoles)
          • Lynx
        • Gamate
        • Game.com
        • Game Pocket Computer
        • Game Master
        • Game & Watch
        • GP 32
        • LCD Games
        • Mega Duck
        • Nintendo (portable game consoles)
          • Game Boy
          • Game Boy MSU
          • Game Boy 2 players
          • Virtual Boy
          • Game Boy Color
          • Game Boy Color 2 players
          • Game Boy Advance
          • Game Boy Advance 2 players
          • Nintendo DS
          • Pokémon Mini
          • Nintendo 3DS
        • Nokia
          • N-Gage & Symbian
        • Sega (portable game consoles)
          • Game Gear
        • SNK (portable game consoles)
          • Neo Geo Pocket
          • Neo Geo Pocket Color
        • Sony (portable game consoles)
          • PlayStation Portable
          • PlayStation Vita
        • Supervision
        • Wonderswan
          • WonderSwan
          • WonderSwan Color
      • Home Computer
        • Acorn Computers
          • Archimedes
          • ATOM
          • BBC Micro
          • Electron
        • Amstrad CPC
        • Apple
          • Apple II
          • Apple IIGS
        • Atari (computers)
          • Atari 800
          • Atari ST
        • Camputers Lynx
        • Coleco Adam
        • Pegasus
        • Commodore (computers)
          • Commodore PET
          • Commodore VIC-20
          • Commodore 64
          • Commodore Plus/4
          • Commodore 128
          • Amiga 500
          • Amiga 1200
          • Amiga 4000
        • Dragon 32/64
        • Fujitsu
          • FM-7
          • FM-TOWNS
        • Mattel
          • Aquarius
        • Microsoft (computers)
          • MSX
          • MSX2
          • MSX2+
          • MSX turbo R
        • NEC (computers)
          • NEC PC-8800
          • NEC PC-9800
        • Oric Atmos
        • Philips
          • P2000t
          • VG5000µ
        • Sam Coupé
        • Sharp
          • Sharp X1
          • Sharp X68000
        • Sinclair Research
          • ZX 81
          • ZX Spectrum
        • SpectraVideo (SV-318)
        • Thomson - MO/TO
        • TI-99/4A
        • Tomy Tutor
        • TRS-80 Color Computer
      • Arcade
        • Atomiswave
        • Capcom Play Systems
          • CPS I
          • CPS II
          • CPS III
        • Cave CV1000
        • Final Burn Neo
        • Gaelco
        • HomeBrew MAME
        • Hyper Neo Geo 64
        • LaserDisc
        • MAME
        • Namco 246/256
        • SEGA
          • Sega Model 2
          • Sega Titan-Video
          • Sega Model 3
          • Sega NAOMI
          • Sega NAOMI 2
          • Sega Hikaru
          • Triforce
          • Sega Chihiro
        • TeknoParrot
        • Zinc
      • Game Engines
        • EasyRPG
        • GemRB
        • IKEMEN
        • Löve
        • Lutro
        • MUGEN
        • Open Beats Of Rage
        • Singe
        • Solarus
      • Pinball
        • Future Pinball
        • Pinball FX
        • Pinball FX2
        • Pinball FX3
        • Pinball M
        • Visual Pinball
        • Zaccaria Pinball
      • Others
        • Cannonball
        • Cave Story
        • CDogs
        • Commander Genius
        • DevilutionX
        • Dinothawr
        • Doom III
        • DOS
        • Duke Nukem 3D
        • Flash
        • GzDoom
        • Java ME
        • Karaoke
        • OpenGOAL
        • OpenJazz
        • Perfect Dark
        • Pico-8
        • Ports
        • PrBoom
        • Quake
        • Quake 2
        • Raze
        • REminiscence
        • Ship Of Harkinian
        • Starship
        • Sonic 3 AIR
        • Sonic Mania
        • Sonic Retro
        • Super Mario War
        • ScummVM
        • The Force Engine
        • Theme Hospital
        • TIC-80
        • Tomb Raider
        • TV Games
        • WASM-4
        • Windows
        • Wolfenstein 3D
  • Controllers
    • Supported Controllers
      • 🎮Gamepads
        • Special controllers
      • 🕹️Arcade Sticks
      • 🔫Lightguns
        • WiimoteGun
      • 🛞Wheels
      • ⌨️Keyboard
    • Controllers Configuration
    • Gun controls
    • Emulator specific controls mapping
      • Dolphin controller mapping
      • MAME64 controller mapping
      • Model2 controller mapping
      • RetroArch controller mapping
      • Teknoparrot controller mapping
    • Pad2Key
  • Advanced Features
    • Decorations (bezels)
    • Updates & Content Download
    • Kiosk and Kid mode
    • Save States
    • Retroachievements
    • Netplay
    • AI Translation Service
    • Batgui
    • retrobat.ini
    • Latency and blur reduction
    • Softpatching
  • TUTORIALS
    • Know issues & fixes
    • Symbolic links
    • Adding RetroArch Shader Sets to Retrobat
    • Customize Mega-Bezels
Powered by GitBook
On this page
  • bios folder
  • cheats folder
  • decorations folder
  • emulationstation folder
  • .emulationstation subfolder
  • emulators folder
  • library folder
  • records folder
  • roms folder
  • saves folder
  • screenshots folder
  • sounds folder
  • system folder
  • decorations subfolder
  • es_menu subfolder
  • loadingscreens subfolder
  • padtokey subfolder
  • resources subfolder
  • shaders subfolder
  • tattoos subfolder
  • templates subfolder

Was this helpful?

Export as PDF
  1. Get Started

RetroBat Folder Structure

PreviousInstallation & First StartupNextAdding a game

Last updated 9 months ago

Was this helpful?

Copyright The RetroBat Team 2019-2024

Once RetroBat is installed, the RetroBat installation folder contains the following folders & files:

bios folder

This folder is where (with few exceptions) all system bios & firmwares will need to be placed.

cheats folder

This folder is used to store the cheats that some emulators can load when activating the "cheats" feature.

decorations folder

This folder comes empty. It can be used to add bezel files to RetroBat, these bezels will be available in RetroBat in addition to the ones provided by default in the system\decorations folder.

emulationstation folder

This folder contains the main executables used for RetroBat interface and for the executable used to configure and run emulators. The structure is the following:

RetroBat configuration files (es_systems.cfg, es_input.cfg, ...) as well as program logs are located in this folder and its subfolders.

.emulationstation subfolder

collections

music

RetroBat allow the use of .mp3 ,.ogg ,.wavand .flac audio files, and also some others less used format. A song can be skipped by pushing the left stick[L3]button, or from the Quick Access menu. While in the system list, press [SELECT] button on your controller to open the Quick Access menu, then choose SKIP TO THE NEXT SONG.

Audio files added in the /music folder will be played randomly.

It is also possible to use per-system folders, in order to play specific music while browsing a particular system. For this, you have to create a folder named exactly as the roms system folder (that you can find in es-systems.cfg), and put audio files in it.

NB : enabling the "ONLY PLAY SYSTEM-SPECIFIC MUSIC FOLDER" option allows RetroBat to play all songs located in a system folder (eg. /music/3do/) while browing the games available in this specific system list, but not the songs located in others subfolders.

The files that are present in /music/ will be picked up randomly for any system (whether you have system-specific songs option enabled or not).

If you disable "ONLY PLAY SYSTEM-SPECIFIC MUSIC FOLDER", RetroBat will play randomly a song in /music/ directory and any of its sub-folders.

scripts

EmulationStation supports calling external scripts and executables on certain program events.

themes

The themes downloaded with the content downloader are stored in this folder. You can also place themes manually there.

themesettings

Here you will find the per-theme settings. When a theme is selected, and customization are done using the theme menu, settings are saved in this folder.

video

emulators folder

This is the folder where the emulators are installed.

Retroarch is provided by default when installing RetroBat, all other standalone emulators will be downloaded when running a game for the first time or when launching them from the RetroBat menu.

Some emulators are not automatically provided with RetroBat automatic download capability, the following list of emulators have to be downloaded manually:

  • Yuzu (& early-access)

  • Ryujinx

  • PICO-8

  • 3DSen

  • TeknoParrot

library folder

This folder can be used to store magazines, these will appear in RetroBat in a "Library" system and can be viewed within RetroBat using the imageviewer libretro core.

records folder

This folder can be used to store the recording files generated by some emulators when using the screen video recording to record the gameplay.

roms folder

This is the folder where the games rom need to be copied, each game has to be placed in the correct system subfolder and must have an extension that is accepted by the emulator.

saves folder

This folder contains game saves, whenever you are using the save function in an emulator to save a game's progress.

screenshots folder

This folder contains all screenshots one takes during gameplay.

If you notice that a save or a screenshot is not recorded in the right folder, please contact the RetroBat team that will fix it if possible.

sounds folder

Copy in this folder the .ogg sound files to be used as RetroAchievements unlock sound. They will be picked up by RetroBat and appear as a choice in the Retroachievement sound unlock feature:

Sound files need to be in .ogg format.

system folder

This folder contains several RetroBat configuration files as well as default "assets" provided with RetroBat (shaders, bezels, ...), the subfolder structure is as follows:

decorations subfolder

The subfolder contains the standard bezels provided with RetroBat.

es_menu subfolder

The subfolder contains the different links to the emulators that are used in the "RetroBat" systems.

loadingscreens subfolder

This subfolder can be used to copy short loading videos (.mp4) that can be played by RetroBat when launching a game (instead of the standard zoom effect on the game image).

You can set a video per system by naming the video file with the system name (e.g. gamecube.mp4). Example of loading videos can be found in \system\templates\loadingscreen.

padtokey subfolder

resources subfolder

The "inputmapping" subfolder contains files used to autoconfigure games for few emulators.

shaders subfolder

The subfolder contains the standard shaders provided with RetroBat.

tattoos subfolder

The subfolder contains the controller layout images for several systems.

templates subfolder

This folder contains all RetroBat template files as they are upon RetroBat installation, if a file has been deleted or altered, the original version of the file can be found here and copied again in the destination folder of the file to replace.

More on bios files can be found in each .

Here you will find the file created by ES when you create an . This file, named as the collection created, with a .cfg extension, contains the differents games of the created collection, with their paths.

In this folder you can place videos to be use as intro ("splash screen"), before RetroBat starts. You can use to configure these easily.

More information can be found in each .

The subfolder contains the standard files provided with RetroBat.

system individual pages
editable game collection
BatGui
system individual pages
padtokey