You are on page 1of 18

12/10/2016

FirstInstallationRetroPie/RetroPieSetupWikiGitHub

Personal

Open source

Business

Explore

Pricing

Blog

Support

RetroPie / RetroPie-Setup
Code

Issues 31

This repository

Watch

Pull requests 2

Projects 0

Wiki

Pulse

Sign in

Search

322

Star

3,568

Sign up

Fork

446

Graphs

First Installation
dankcushions edited this page 22 days ago 100 revisions

Pages 153

Wiki Home Page


Getting Started
First Installation

Version
4.1
1. Hardware
2. Installation

WiFi
Controller Configuration
RetroArch
Transferring games ROMs
Scraping Games
Runcommand
Getting the right MAME ROMs

3. Controller Configuration

Updating RetroPie

4. EmulationStation

Using SSH

5. Configure Wifi
6. Installing Additional Emulators

Emulators
3do

https://github.com/retropie/retropiesetup/wiki/FirstInstallation

1/18

12/10/2016

FirstInstallationRetroPie/RetroPieSetupWikiGitHub

7. Transferring Roms

Amiga
Amstrad CPC

Congratulations! You have discovered the wonderful world of RetroPie your entire childhood is
within reach! RetroPie is a combination of multiple projects including RetroArch, EmulationStation,

Apple II

and many others.

Atari 5200 and 8 bit series

This page is for people just getting started on RetroPie. The easiest way to install RetroPie is the SD
image which is a ready to go system built upon top of the Raspbian OS this is the method
described in the following guide. Alternatively, advanced users can install RetroPie manually.
This guide will give you the very basics to get you up and running from a blank SD card to first
boot into EmulationStation.
If you hate reading then see this video. Otherwise read on!

Atari 2600
Atari 7800
Atari Jaguar
Atari Lynx
Atari ST/STE/TT/Falcon
CoCo
Colecovision
Commodore 64
Daphne
Dragon 32
Dreamcast
FinalBurn Alpha
GameCube
Game & Watch
Game Gear
Game Boy
Game Boy Color
Game Boy Advance
Intellivision
Macintosh
MAME
Master System
Megadrive/Genesis
MESS
MSX
Nintendo 64
Nintendo DS
Nintendo Entertainment
System
Neo Geo

Hardware Needed:

https://github.com/retropie/retropiesetup/wiki/FirstInstallation

2/18

12/10/2016

FirstInstallationRetroPie/RetroPieSetupWikiGitHub

Hardware Needed:
Raspberry Pi A, A+, B, B+, 2, Zero, or 3 for best performance use a Raspberry Pi 3 Model B
Raspberry Pi Case optional but recommended

Neo Geo Pocket


Neo Geo Pocket Color
Oric1/Atmos
PC
PC Engine/TurboGrafx16

MicroSD Card see compatible SD card list here

PSP

MicroSD Card Reader For installing retropie from your computer

PlayStation 1

HDMI cable or 4 Pole RCA to 3.5mm Cable HDMI works best


Television or Computer Monitor really any screen with HDMI or RCA ports

PlayStation 2
ResidualVM
SAM Coup

Wifi Dongle or Ethernet Cable Wifi is built into the Pi 3 see wifi dongle compatible list here

Saturn

5V 2A Micro USB Power Supply 2.5A for pi 3

ScummVM

USB Keyboard and Mouse to get things set up or you can use SSH
USB Game Controller of your choice or you can get the Control Block to use original SNES
controllers
The simplest way to get most of these components is through a kit such as the Canakit.

Sega 32X
Sega CD
Sega SG1000
Super Nintendo Entertainment
System
TI99/4A
TRS80

Installation
SD Images
There are currently two versions of RetroPie. There is one version for Raspberry Pi 0/1 Model A,
A+, B, B+ and there is a version for Raspberry Pi 2/3.
Download the SD image for your version of Raspberry Pi from the following page:
https://retropie.org.uk/download/

Vectrex
Videopac/Odyssey2
Virtual Boy
Wii
WonderSwan
WonderSwan Color
Zmachine
ZX Spectrum

Ports

If you are unsure which version of Raspberry Pi you have there is an easy way to check:

Adventure Game Studio

Rpi 0/1= 1 raspberry when the pi boots up

Cave Story

Rpi 2/3= 4 raspberries when the pi boots up


https://github.com/retropie/retropiesetup/wiki/FirstInstallation

Baldur's Gate
Commander Keen
Descent
3/18

12/10/2016

FirstInstallationRetroPie/RetroPieSetupWikiGitHub

If you get the error IllegalInstruction when it boots, you picked the wrong SD image.

Dinothawr
DOOM

Extract

Duke Nukem 3D

Once you have downloaded your SD card image you need to extract it using a program such as 7
Zip. You will extract the downloaded .gz file and the extracted file will be a .img file.

Giana's Return

To extract from the command line, you can type the following into a Terminal window, placing X
with version you downloaded:

KODI

GameMaker Games
Lincity
Lve
Marathon
Micropolis

gunzipretropie4.X.Xrpi2_rpi3.img.gz

Minecraft Pi Edition
OpenBOR

Install RetroPie Image on SD Card

OpenTTD

To install the RetroPie SD image on your MicroSD card. You may need a MicroSD card reader to
plug it into your computer

OutRun Engine

1. For Windows you can use a program called Win32DiskImager

OpenTyrian
Quake Series
Rick Dangerous
Prince of Persia

2. For mac you can use Apple Pi Baker

Stratagus

3. For Linux you can use dd command or Unetbootin

Super Mario War

Note RetroPie is built on top of Raspbian a linux based OS for the Raspberry Pi and as such the
partition on the SD card is EXT4 a linux filesystem which is not visible on windows systems, so the
card will show up as a smaller size than usual and you wont be able to see everything on the card,
but it is all there. You will be able to access the filesystem over the network as described in the
transferring roms section below.
If you're updating from a previous version of retropie see HERE

SuperTux
TheUrQuanMasters
Warcraft/Starcraft
Wolfenstein 3D
Zelda Engine

Advanced Configuration
EmulationStation

Configurations

Custom Splash Screens

Controller Configurations

Create Your Own Theme

https://github.com/retropie/retropiesetup/wiki/FirstInstallation

EmulationStation Themes
Take and Scrape Your Own
Screenshots
Configuration Editor
4/18

12/10/2016

FirstInstallationRetroPie/RetroPieSetupWikiGitHub

On first boot your filesystem will be expanded automatically, you will then be welcomed with the
following screen this menu will configure your controls for both Emulationstation and RetroArch
Emulators:

RetroAchievements
Netplay
Overclocking
Memory Split
Manual Installation
Odroid
Arch Linux
Ubuntu x86
Install via NOOBS
RetroPie install for OSMC with
external memory USB Drive
Favorites and Childfriendly
EmulationStation
Optimization for Nintendo 64
Running ROMs from a USB
drive
Running ROMs from a Network
Share
Smaller RetroArch Screen
Shaders and Smoothing

Controllers
Hold down any button on your keyboard or gamepad and the name will appear at the bottom and
then open up into a configuration menu:

XBox 360 Controller


PS3 controller
PS4 controller
N64 controller
Ouya controller
Bluetooth controller
8bitdo controllers
Logitech controllers
Mobile Gamepad
Smartphone Gamepad
Wiimotes

https://github.com/retropie/retropiesetup/wiki/FirstInstallation

5/18

12/10/2016

FirstInstallationRetroPie/RetroPieSetupWikiGitHub

Wii U Pro Controller Debian


jessie only
XinMo Driver
GPIO Controller Modules
Spinners and Trackballs
Xiaomi Gamepad
Universal Controller Calibration
& Mapping Using xboxdrv

Troubleshooting
Sound Issues
Speed Issues
Video Issues
FAQ

Developers
Building RetroPie Archives

Follow the onscreen instructions to configure your gamepad if you run out of buttons just hold
down a button to skip each unused button. When you get to OK press the button you have
configured as "A".

Shell Style Guide

Clone this wiki locally

https://github.com/RetroPie/RetroPieSetup.
Clone in Desktop

https://github.com/retropie/retropiesetup/wiki/FirstInstallation

6/18

12/10/2016

FirstInstallationRetroPie/RetroPieSetupWikiGitHub

If you wish to configure more than one controller, you can do so from the start menu of
emulationstation. For more details on manual controller configurations see this page Here. See also
HERE
See the following diagrams for reference:

https://github.com/retropie/retropiesetup/wiki/FirstInstallation

7/18

12/10/2016

https://github.com/retropie/retropiesetup/wiki/FirstInstallation

FirstInstallationRetroPie/RetroPieSetupWikiGitHub

8/18

12/10/2016

https://github.com/retropie/retropiesetup/wiki/FirstInstallation

FirstInstallationRetroPie/RetroPieSetupWikiGitHub

9/18

12/10/2016

FirstInstallationRetroPie/RetroPieSetupWikiGitHub

Default Hotkeys
Hotkeys enable you to press a combination of buttons to access functions such as saving, loading,
and exiting emulators. The following chart shows the default hotkey combinations. By default, the
hotkey is select so that means you hold down select while pressing another button to execute a
command. Note that hotkeys are only specific to the retroarch/libretro based emulators.
Hotkeys

Action

Select+Start

Exit

Select+Right Shoulder

Save

Select+Left Shoulder

Load

https://github.com/retropie/retropiesetup/wiki/FirstInstallation

10/18

12/10/2016

FirstInstallationRetroPie/RetroPieSetupWikiGitHub

Hotkeys

Action

Select+Right

Input State Slot Increase

Select+Left

Input State Slot Decrease

Select+X

RGUI Menu

Select+B

Reset

EmulationStation
Where are the systems?
When you first see EmulationStation you may wonder why you don't see systems like the
SNES or Game Boy- worry not- they are installed on the system, roms just need to be added
to their respective rom folders before they will become visible. Transferring roms are
described in the following steps.

https://github.com/retropie/retropiesetup/wiki/FirstInstallation

11/18

12/10/2016

FirstInstallationRetroPie/RetroPieSetupWikiGitHub

Where are the systems?

Configuring Wifi
If you wish to use wifi to transfer roms over the network rather than a USB stick or Ethernet cable
you'll need to setup your wifi which can also be done from the Retropie menu in emulationstation:
It will open into this menu:

https://github.com/retropie/retropiesetup/wiki/FirstInstallation

12/18

12/10/2016

FirstInstallationRetroPie/RetroPieSetupWikiGitHub

Choose your SSID from a list:

https://github.com/retropie/retropiesetup/wiki/FirstInstallation

13/18

12/10/2016

FirstInstallationRetroPie/RetroPieSetupWikiGitHub

Type your Wifi Password You may need to wait a bit after you finish for the configurations to save

After it's done configuring you should see your wifi info in the original menu:

For more WiFi configuration options see this page HERE

Installing additional Emulators / Ports


On RetroPie 4.0+, not everything is installed by default. The premade images contain the best
working emulators for each system supported by the hardware. This should cover everything most
https://github.com/retropie/retropiesetup/wiki/FirstInstallation

14/18

12/10/2016

FirstInstallationRetroPie/RetroPieSetupWikiGitHub

users would be doing. Ports like quake and doom and some other emulators like ScummVM can
be installed later.
Software can be installed from the RetroPieSetup script which is accessible from the RetroPie
menu on EmulationStation. Once there you can navigate to "Manage Packages" where you will see
various sections. In each section are lists of packages that can be installed and it will show what is
currently installed. Stable additional packages are under the "Optional" section, with more
unstable packages listed under experimental. The packages are ordered first by type emulators /
libretro cores / ports, then alphabetically. By selecting a package you can choose to install it, or
remove it. Some packages also have additional configurations.

Transferring Roms
Due to the nature/complexity of Copyright/Intellectual Property Rights Law, which differs
significantly from Country to Country, ROMs cannot be provided with RetroPie and must be
provided by the user. You should only have ROMs of games that you own.
There are three main methods of transferring roms:

USB
ensure that your USB is formatted to FAT32 or NTFS
first create a folder called retropie on your USB stick
plug it into the pi and wait for it to finish blinking
pull the USB out and plug it into a computer
add the roms to their respective folders in the retropie/roms folder
plug it back into the raspberry pi
wait for it to finish blinking
refresh emulationstation by choosing restart emulationstation from the start menu
see this video for reference:
https://github.com/retropie/retropiesetup/wiki/FirstInstallation

15/18

12/10/2016

FirstInstallationRetroPie/RetroPieSetupWikiGitHub

SFTP (needs an active internet connection)


Wired needs ethernet cable
Wireless needs wifi dongle There are many SFTP programs out there, for windows many
people use WinSCP for mac you can use something like Cyberduck

https://github.com/retropie/retropiesetup/wiki/FirstInstallation

16/18

12/10/2016

FirstInstallationRetroPie/RetroPieSetupWikiGitHub

Default username: pi
Default Password: raspberry
You can also log in as root if you wish to change more files than just the roms, but you first need to
enable the root password which is explained here

Samba-Shares (needs an active internet connection)


if on windows type \\retropie into the computer folder. You can also replace retropie with
your Raspberry Pi's IP address

if on MAC OS X open finder, select "Go" menu and "Connect to Server". Type smb://retropie
and hit "Connect".

PLAY!
https://github.com/retropie/retropiesetup/wiki/FirstInstallation

17/18

12/10/2016

FirstInstallationRetroPie/RetroPieSetupWikiGitHub

After you've added your roms you need to restart emulationstation in order for them to show up.
You can restart emulationstation from the start menu, or by rebooting your pi with sudoreboot.
see the rest of the wiki for more detailed information on individual emulators, advanced
settings etc. If you still can't figure it out, the RetroPie community is very helpful on the forum.
The RetroPie Project is primarily maintained by a few developers who develop the project in
their free time. If you have found the RetroPie project useful please consider donating to
the project here. As you become more familiar with RetroPie, pay it forward by helping
others on the forum. The RetroPie Project is what it is today because of the many
contributions of the community.
THANK YOU!

The RetroPie Project


About

Forum

2016 GitHub, Inc.

Terms

SetupScript

Privacy

Security

https://github.com/retropie/retropiesetup/wiki/FirstInstallation

Status

Help

Contact GitHub

API

Training

Shop

Blog

About

18/18