RetroPie-Setup README

The project's README from github.com/RetroPie/RetroPie-Setup. As one markdown file: README.md.

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 git

Then you can download the latest RetroPie setup script with:

cd
git clone --depth=1 https://github.com/RetroPie/RetroPie-Setup.git

The script is executed with:

cd RetroPie-Setup
sudo ./retropie_setup.sh

When 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!

RetroPie-Setup (RetroPie/RetroPie-Setup)

Searching Database…

10.4K ·GitHub
RetroPie-Setup
What is this?RetroPie-Setup is a shell script that turns a Raspberry Pi, Vero4K, ODroid-C1, or an Ubuntu PC into a retro gaming console by installing RetroArch, many emulator cores, and the EmulationStation frontend.
Is this a standalone app or a script I run on top of an existing OS?It is a setup script, not a standalone app or OS image: you run it on an existing Raspberry Pi OS, OSMC, or Ubuntu install and it installs and configures the emulation software for you.
How do I get it running?Make sure your APT repositories are up to date and Git is installed, clone/download the latest RetroPie setup script, then execute it to open the installer menu where you choose what to install.
Do I need anything installed before running the script?You need an up-to-date APT package list and Git installed on your Raspberry Pi OS, OSMC, or Ubuntu system before downloading and running the script.
Which devices besides the Raspberry Pi does it support?It also supports the Vero4K (running OSMC), the ODroid-C1, and a generic PC running Ubuntu.
Are there ready-made disk images if I don't want to run the script myself?Yes, bootable pre-made images for the Raspberry Pi are available in the GitHub releases section or from the RetroPie website, so you can skip running the script manually.
What is EmulationStation?EmulationStation is the graphical front end RetroPie installs so you can browse your games and launch the installed emulator cores from a console-style menu.
Does RetroPie provide the games or ROMs?No, RetroPie only sets up the emulators, cores, and frontend; you still need to supply your own ROM files afterward.
What are similar projects?ProsperoEden, frank-386, exodium, mame, chinese-dos-games, Ridge-Racer-Collection, wireguard-install, romm
Which topics is it in?games, pi, retro, ubuntu, arm, emulation, script, retrogaming, emulator, bash, installer, raspberry-pi
Creator
RetroPie
Size
24 MB
Stars
10.4K
Updated
CommitOct 06Release4.8Mar 14
Age
14y
Commits · 90 Days