glebm / batocera.linux

batocera.linux

🎮🐧 Batocera Linux 🎮🐧

Batocera Linux is an open-source and completely free retro-gaming distribution that can be copied to a USB stick or an SD card with the aim of turning any computer/nano computer into a gaming console during a game or permanently. Batocera Linux does not require any modification on your computer. It supports many emulators and game engines out of the box.

Get information on the project

• 🌐 Browse our website for general information and get access to all the latest downloads
• 📝 Documentation is available on our wiki and frequently updated
• 💬 Discuss any topic with the community on our Discord Server

Do you need help with Batocera?

• 🆘 The most effective way is to join our Discord Server and go to the #help-and-support channel
• There is a Batocera subreddit that is fairly active
• Finally, we also have a forum

How can you help Batocera?

• 🔧 If you want to help with development, we accept PRs -- anyone is welcome, we embrace the Bazaar development principles
• 🎨 No need to be a developer, you can also help with translations, talk about our project on Youtube or Twitter, create themes for EmulationStation
• 💵 Finally, you can help us with a Paypal donation, it's always appreciated!

Directory navigation

• board Platform-specific build configuration. This is where to include special patches/configuration files needed to have particular components work on a particular platform. It is instead encouraged to apply patches at the location of the package itself, but this may not always be possible.
• buildroot Buildroot, the tool used to create the final compiled images. For newcomers, you can safely ignore this folder. Compilation instructions can be found on the wiki.
• configs Build 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 the build configuration section on the buildroot compiling page.
• package The "meat and potatoes" of Batocera. This is where the majority of emulator data, config generators, core packages, system utilities, etc. all go into. This is the friendliest place to start dev-work for new devs, as most of it is handled by Python and Makefile.
• scripts Various miscellanous scripts that handle aspects external to Batocera, such as the report data sent to the compatibility page or info about the Bezel Project.

A cheatsheet of notable files/folders can be found on the wiki.