mirror of https://github.com/RetroPie/RetroPie-Setup.git synced 2025-04-02 10:51:41 -04:00

Shell script to set up a Raspberry Pi/Odroid/PC with RetroArch emulator and various cores

Find a file

Jools Wills 6b2b569201 workaround for installing samba in chroot due to service restart (left samba working, but technically half installed)		2016-06-21 22:07:22 +01:00
.github	change issue text to say to post to the forum first - to try and filter out many "bugs" which are in fact configuration issues.	2016-04-12 00:36:40 +01:00
scriptmodules	workaround for installing samba in chroot due to service restart (left samba working, but technically half installed)	2016-06-21 22:07:22 +01:00
tools	removed old/unused scripts	2015-12-05 03:39:09 +00:00
.gitignore	Add logs and tmp folders in the root to gitignore	2015-12-15 13:18:18 +00:00
AUTHORS	CHG: Updated copyright information.	2015-10-11 21:03:16 +02:00
CONTRIBUTING.md	update RetroPie urls in README.md, CONTRIBUTING and bashwelcometweak to new site	2016-04-06 12:41:19 +01:00
COPYRIGHT.md	fix markdown	2016-04-23 00:41:31 +01:00
LICENSE.md	update RetroPie urls in README.md, CONTRIBUTING and bashwelcometweak to new site	2016-04-06 12:41:19 +01:00
platforms.cfg	platforms.cfg - remove .bin extension from playstation	2016-06-16 03:06:34 +01:00
README.md	update RetroPie urls in README.md, CONTRIBUTING and bashwelcometweak to new site	2016-04-06 12:41:19 +01:00
retropie_packages.sh	bumped version to 4.0-beta2	2016-06-21 19:33:57 +01:00
retropie_setup.sh	Initial rewrite of the setup menu, including per package/module management	2016-06-06 22:08:36 +01:00

README.md

RetroPie-Setup

General Usage

Shell script to setup the Raspberry Pi 1 / 2 / 3 with several emulators, various cores, and EmulationStation as graphical front end. Bootable pre-made images 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 Raspbian Jessie and Wheezy for the Raspberry Pi. Before using the script, please **make sure that you have run the raspi-config script to extend your root file system **. You can run the script with

sudo raspi-config

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 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. Note that you might need to reboot your Raspberry, if your firmware was updated during the installation process.

Binaries and Sources

RetroPie Setup offers the possibility to install from binaries or build from source. For most users installing from binary should suffice - but for the very latest versions of some software building from source may be preferred. Building from source can take more than a day on a Raspberry Pi.

For more information visit the blog at https://retropie.org.uk or the repository at https://github.com/RetroPie/RetroPie-Setup. A forum thread about the RetroPie Setup script in the official Raspberry Pi forum can be found at http://www.raspberrypi.org/phpBB3/viewtopic.php?f=35&t=13600.

Wiki

You can find useful information about several components or for several frequently asked questions in the wiki of the RetroPie Script. If you think that there is something missing, you are invited to add it to the wiki.

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!