1. Project Overview & Quickstart (RetroPie/RetroPie-Setup)
RetroPie-Setup
General Usage
Shell script to setup the Raspberry Pi, Vero4K, ODroid-C1 or a PC running Ubuntu with many emulators and games, using EmulationStation as the graphical front end. Bootable pre-made images for the Raspberry Pi are available for those that want a ready-to-go system, downloadable from the releases section of GitHub or via our website at https://retropie.org.uk.
This script is designed for use on Raspberry Pi OS (previously called Raspbian) on the Raspberry Pi, OSMC on the Vero4K or Ubuntu on the ODroid-C1 or a PC.
To run the RetroPie Setup Script make sure that your APT repositories are up-to-date and that Git is installed:
sudo apt-get update
sudo apt-get dist-upgrade
sudo apt-get install gitThen you can download the latest RetroPie setup script with:
cd
git clone --depth=1 https://github.com/RetroPie/RetroPie-Setup.gitThe script is executed with:
cd RetroPie-Setup
sudo ./retropie_setup.shWhen you first run the script it may install some additional packages that are needed.
Binaries and Sources
On the Raspberry Pi, RetroPie Setup offers the possibility to install from binaries or source. For other supported platforms only a source install is available. Installing from binary is recommended on a Raspberry Pi as building everything from source can take a long time.
For more information, visit the site at https://retropie.org.uk or the repository at https://github.com/RetroPie/RetroPie-Setup.
Docs
You can find useful information about several components and answers to frequently asked questions in the RetroPie Docs. If you think that there is something missing, you are invited to submit a pull request to the RetroPie-Docs repository.
Thanks
This script just simplifies the usage of the great works of many other people that enjoy the spirit of retrogaming. Many thanks go to them!
2. Official Technical Reference & Guides (RetroPie/RetroPie-Docs)
File: docs/index.md
| Latest Version | 4.8 | Changelog |
|---|
What is RetroPie?
RetroPie allows you to turn your Raspberry Pi or PC into a retro-gaming machine. It builds upon Raspberry Pi OS (Raspbian), EmulationStation, RetroArch and many other projects to enable you to play your favourite Arcade, home-console, and classic PC games with the minimum set-up. For power users it also provides a large variety of configuration tools to customise the system as you want.
RetroPie sits on top of a full OS, you can install it on an existing Raspbian, or start with the RetroPie SD image and add additional software later. It's up to you.
What is an Emulator?
An emulator is software that makes a computer behave like another computer, or in the case of RetroPie a computer that behaves like a video game console such as the Super Nintendo. The RetroPie SD image comes pre-installed with many different emulators. Additional emulators may be installed from within RetroPie.
What are ROMs?
ROMs are digital versions of game cartridges. Loading up a ROM in an emulator is the equivalent of putting a cartridge in a game console.
ROMs are copyrighted content and as such are not included with RetroPie.
What is a BIOS?
A BIOS is a small piece of software that tells hardware how to work. Many emulators emulate their system's BIOS, but others require you to supply a BIOS file. If a BIOS is required, the emulator's page will say so.
BIOSs are also copyrighted and are therefore not included with RetroPie.
Getting Started
Select your system for installation instructions:
| Raspberry Pi | PC | Odroid |
|---|---|---|