4/13/2016

Manual(EN)recalbox/recalboxosWiki

Thisrepository

Search

Pullrequests

Issues

Gist

recalbox / recalboxos
Code

Issues 310

Watch

Pullrequests 0

Wiki

Pulse

Star

102

618

Fork

101

Graphs

Manual(EN)

Edit

NewPage

rockaddictededitedthispageonFeb396revisions

recalbox3.3.X
Manualv1.0.8

Pages

229

English
Home
Installation
Manual
Manual3.2.x(old)
recalbox.conf
recalbox.conf3.2.x(old)
Emulators
recalboxOSdetailled
Compilation&Modifications
Releases
Bugreport
Translation
MiniHowTo
PeripheralCompatibility
Credits
Franais(Entraductionpourla
3.3.0)
Home
Installation
Notice
Notice3.2.x(old)(FR)
recalbox.conf
recalboxOSdtaill
Compilation&Modifications
Signalementdebugs
Traduction
MiniHowTo
Priphriquescompatibles
FAQ
Espaol
Home
Instalacin
Manual
Manual3.2.x(old)

http://www.recalbox.com
IFirstuse
IIConfiguration
AControllers
1PS3controllers
2XBox360controllers
3Addanbluetoothcontroller
4Configureacontroller
5Buttonsmapping

recalbox.conf
recalbox.conf3.2.0(old)
Emuladores
recalboxOSaldetalle
Compilacinymodificaciones
Reportarerrores
Traduccin
MiniCOMO
Perifricoscompatibles
Crditos
DeutschWIKI

6Keyboardmapping

Home

7GPIOcontrollers

Installation

8VirtualGamepads

Anleitung

https://github.com/recalbox/recalboxos/wiki/Manual%28EN%29

recalbox.conf

1/10

4/13/2016

Manual(EN)recalbox/recalboxosWiki

BSystemsettings
IIIEmulationStation
APresentation
BSettings
1Systemsettings
2Gamesettings

Emulatoren
recalboxOSimDetail
Fehlermelden
PeripherieKompatibilitt
Credits
Portugus

3Controllersettings

Home

4UIsettings

Instalao

5Soundsettings
6Networksettings

Manual
recalbox.conf
Emuladores

CControls

recalboxOSdetalhado

DFavorites

Compilao&Modificaes

EScraper
IVDuringthegame
ASaves
BSpecialcommands
VUpdates
VINetworkfeatures
AAddyourgames
BArcadeGames

Reportarbugs
Traduo
PerifricosCompatveis
Crditos
Italiano
Home
Installazione
Manuale
recalbox.conf

CScummvmGames

recalboxOSdettagliato

DScreenshots

Compilazione&Modifiche

ESaveyoursaves
VIIKodiMediaCenter
VIIITroubleshooting
AControllers

SegnalareErrori
Traduzioni
MiniGuidaHowTo
Periferichecompatibili
Crediti

BOther
CHardreset
DRootAccess
IXrecalbox.conf

Clonethiswikilocally

https://github.com/recalbox/recalboxos.wiki

CloneinDesktop

Introduction
Therecalboxisasystemthatwillallowyoutoplayretrogameseasily.
ItrunsonamicrocomputercalledtheRaspberryPi,andusesabatchofoptimizedemulators.

IFirstuse
Thenecessarypackage:
AraspberryPI1or2
16GBormoreSD/microSDcard
HDMIcable
amicroUSBpowercable>1.5AMP
aUSBoraBluetooth*controller(*andBluetooth>USBdongle)
Seerecalbox.com/diyformoreinformationonthefirstinstall.
AftertheInstallation,thefirstthingyouhavetodoistoconnecttherecalboxtotheTVwiththe
HDMIcable.
Topowerontherecalbox,justplugthemicroUSBpowercablein.
Manycontrollersworkoutofthebox,butifyouwanttoconfiguredirectlyanUSBcontroller,plugin
aUSBkeyboardandseeAddanusbcontroller
Toshutdownthesystem:pushonthestartbuttonandchooseQUITandSHUTDOWN
SYSTEM.(Shortcut:Press"Select"forshutdownonlymenu)
https://github.com/recalbox/recalboxos/wiki/Manual%28EN%29

2/10

4/13/2016

Manual(EN)recalbox/recalboxosWiki

Youcanthenunplugthepowercable.(BestPractice:waitforgreen/orangelightonPItostop
flashing)

IIConfiguration
AControllers
PS3DualshockandXbox360controllersaresupportedwireless.ManyUSBandBluetooth
controllersaresupportedtoo.FormoreinformationseetheperipheralcompatibilitylistNote:By
defaultthePS3controllerisselectedintheconfig.Ifyouareusingothercontrolleritmaybe
necessarytodeselectthePS3andSelectthecontrolleryouareusing,savetheconfig&reboot.
Findyourcontrollerbelowformorespecifics.

1PS3controllers
YoumusthaveabluetoothdongletouseaPS3wirelesscontroller.Youcannotchargethesisaxis
ontheRPi,youmustchargecontrollersdirectlyontheusbpower.
Plugthecontrollerontherecalboxonlytoassociateyourcontrollerwithyourrecalbox.
InordertoassociateaPS3controller,plugthecontrollerontherecalboxandwait10seconds.
YoucannowunplugthecontrollerandpresstheHomebutton.
ForasiancopiesofthePS3dualshock3(akaGASIAorSHANWAN)seePS3controllersdrivers
RememberthattheconfigurationofthecontrollersinrecalboxisbasedontheSNESbuttons
assignment:
ps3pad

snespad

2XBox360controllers
XBox360Wirelesscontrollersneedaspecificwirelessreceiver.
IfyouhaveaXBox360wiredorwireless,activatethexboxdrvinrecalbox.conftohavethebest
supportpossible.
Toenable360controllersyouneedtoadjusttherecalbox.conffile.Todothiseasilyvisitthe
configurationtabbypullingupyourrecalboxIPaddressinabrowser.FirstdeselectthePS3
controller(default)changecontrollers.ps3.enabled=1tocontrollers.ps3.enabled=0Thenchange
thexBoxsettingsfromcontrollers.xboxdrv.enabled=0tocontrollers.xboxdrv.enabled=1
Thenrebootwithyourcontrollerorwirelessreceiverpluggedin.(Itisrecommendedto"wakeup"
thecontrollersbeforestartingthePI")
RememberthattheconfigurationofthecontrollersinrecalboxisbasedontheSNESbuttons
assignment:
xboxpad

snespad

https://github.com/recalbox/recalboxos/wiki/Manual%28EN%29

3/10

4/13/2016

Manual(EN)recalbox/recalboxosWiki

3Addabluetoothcontroller
Toaddabluetoothcontroller,setyourcontrollerinpairingmode.
ThengotothemenuwithstartbuttonorakeyboardandselectControllerSettings.
SelectPairabluetoothController:

Alistofdetectedcontrollersappears,justselectyoursandnowthecontrollerispaired!Nowyou
canconfigureitifit'snotalreadyasupportedcontroller!
For8bitdousers,see8bitdoonrecalbox.

4Configureacontroller
YoucanaddUSBcontrollersontherecalbox.
Mostmodelsarecompatible,seethecompatibilitylist
Afterpluggingyourusbcontrollerorpairingyourbluetoothcontroller,pressSTARTwithanalready
configuredcontroller(orENTERonthekeyboard)andselect"CONFIGUREINPUTS".
Thenfollowinstructions.
Thelastbutton,theHOTKEYisabuttonthatwillactivatebuttonscombination(seeSpecial
commands).Forxbox360andPS3gamepads,thedefaulthotkeybuttonisHOMEorPS.Itis
recommendedtouseL3(thejoystickclickondualshock)orSELECT
ButtonsassignmentisbasedontheSuperNintendocontroller:

TheLandRbuttons(withL2R2L3R3)arebasedonPlaystationcontrollers.
Passanybuttonsyoudon'thavebypressingabuttonfor2seconds.
Backontheconfigurationscreen,youcanassignthecontrollertoaplayer.Yourcontrollerisnow
configured!

5Buttonsmapping
For6buttonscontrollers(snes,psx,arcadeetc)thebuttonsaremappedtocorrespondingbuttons
ontheoriginalcontroller.
For2buttonscontrollers(nes,pcengine,gameboyetc)themappedbuttonsareBandA.
https://github.com/recalbox/recalboxos/wiki/Manual%28EN%29

4/10

4/13/2016

Manual(EN)recalbox/recalboxosWiki

6Keyboardmapping
Ifyoutotallyfailedatthecontrollerconfigurationorjustwanttoconfigureacontroller,youcan
attachawiredUSBkeyboardtotherecalbox.EnterisSTART,SpaceisSELECT,QisBACK,Sis
OK

7GPIOcontrollers
YoucanconnectyourarcadejoysticksandbuttonsdirectlyontheraspberryGPIOs.SeeGPIO
controllers
YoucanconnectoriginalcontrollersfromPSOne,Nes,Snes,Megradriveandother.SeeDB9and
Gameconcontrollers

8VirtualGamepads
WithMiroof'sVirtualGamepadsyoucanaddupto4controllerswithyourphones!Juststartyour
InternetNavigatoronyourphone,andtypetherecalboxIPfollowedbythecommunicationport
(port=8080).YoucangettherecalboxIPinthesettingmenuNETWORKSETTINGS

FormoreinfoseeVirtualGamepad

BSystemSettings
Youhavetwowaystoconfigureyourrecalbox.ThefrontendEmulationstationoffersmany
configurationsfeatures.SeeEmulationStationsettings
Butifyouwanttofinetuningemulatorsonebyone,youshouldhavealookatrecalbox.conf

IIIEmulationStation
APresentation
Whenyoustarttherecalboxsystem,thefrontendemulationstationshowsup.
Youcanselectyoursystems,launchyourgames,oraccessconfigurationmenufromhere.
Thefirstscreenisthesystemscreen:

Itshowsallavailablesystems.

BSettings
Bypressingstart,youwillbeabletochangesomesystemsettings.
https://github.com/recalbox/recalboxos/wiki/Manual%28EN%29

5/10

4/13/2016

Manual(EN)recalbox/recalboxosWiki

1SYSTEMSETTINGS
Youwillaccesssysteminformation,languageselection,overclocksettings,updatessettings
andkodisettings.
YoucanchangetheoverclockofyourRPI.TheoverclockspeedorderforRPI1is:
NONE<HIGH<TURBO<EXTREM
Extrememayvoidyourwarrantybutistheonlyonethatwillgiveyoureallygoodperformancefor
allemulatorsonRPi1.
ItisalsorecommendedtooverclockyourRPi2,ifyouwantemulatetheN64andhavethebest
gamingexperience.

2GAMESETTINGS
Youcansetgameoptions:videoratio(16/9,4/3),imagesmooth,rewindandautosave/load.
Therewindoptionallowsyoutoturnbacktimeingames.
Thisfeaturemayslowdownsomeemulators(snes,psx)ifyouenableitbydefault.Youcan
enableitbyemulatorinrecalbox.conf
Theautosave/loadoptionallowsyoutoautosaveasavestatewhenyouexitagame,thenreload
automaticallythissavestatewhenyourestartthisgame.Oncethegamestarted,andthesavestate
loaded,ifyouwanttoreturntothetitlescreenofthisgame,usethespecialcommandreset.You
canenableitbyemulatorinrecalbox.conf
Youcanalsoeasilyconfigureshadersforyoursystems.Theshadersetconfigurationcontainsthe
shadersetsavailableforrecalbox.Thescanlinesshadersenablescanlinesonallsystemstolook
likeaCRTtelevision.Theretroshadersisasetofthebestshaders,chosenbythecommunity,
thatwillofferyoutheclosesttooriginalgamingexperience!
MoreinfoonShadersconfigurationpage.
Youcanalsoswitchshadersingameusingyourcontroller.UsetheSpecialcommandsHotkey+
R2orHotkey+L2toseethenextorpreviousshader.
Youcanalose

3CONTROLLERSETTINGS
Youcanconfigureyourcontrollers.

4UISETTINGS
Youwillhaveaccesstothefrontendsetting.Youcansettheoverscanhereifyouhaveblack
borderoracroppedimage.SeeOverscansettingsformoreinformation.

5SOUNDSETTINGS
Youcanenableordisablebackgroundsoundsinemulationstation,setsystemvolumeand
chooseoutputdevice(auto,jackorhdmi)
Selectjacktoforceanalogoutput.
https://github.com/recalbox/recalboxos/wiki/Manual%28EN%29

6/10

4/13/2016

Manual(EN)recalbox/recalboxosWiki

6NETWORKSETTINGS
Youcanenableandconfigurethewifiandthehostname,gettherecalboxIPTypetheSSIDof
yournetworkandthenetworkkeywithakeyboard.
Onceyouvalidate,thewifiisactivated.
AknownbugbugexiststhatdoesnotallowyoutoenterallthecharactersyouneedfortheSSID
ortheKey.Youcanconfigurethisdirectlyfromyourwifiusingrecalbox.conf

CControls
Frontendcommands:
ASelect
BBack
YSwitchFavorite
XLaunchKodi
StartMenu
SelectOptions(rebootmenuonsystemsscreen)
RNextPage
LPreviousPage
WhenyouselectasystemwithA,thescreenchangeandshowallavailablegames.
Whenthegameisrunning,gotothesectionDuringthegametoseehowyoucangobacktothe
frontend.

DFavorites
YoucansetagameasafavoritebypressingtheYbutton.Thegamewillbeontopofthegame
listwithabeforeitsname.TogglethefavoritewithY.Itisnecessarytoturnoff/rebootthesystem
properlywiththeemulationstationmenutosaveyourfavoritesandthenfindtheminthenext
startup.

EScraper
Foreachgame,youcangetthecoverartandinformationaboutthegamesyouhavestoredwhile
browsingyourgameslistsintheemulationstation.PressSTARTandgotoSCRAPPER.Then
followtheinstructions.

IVDuringthegame
ASaves
Emulatorsbringaveryusefulfeature:savestate.Asavedstateisaquicksaveofthegame,and
allowsyoutoreloadthegameatthispoint.
Withsavestates,youwillneverhavetoseekforasavedpointagain!
Youcansavemorethanonestatepergameifyouchangethesaveslot.
YoucansaveastatewithHotkey+Y

BSpecialcommands
Whenyouareinthegame,therearespecialcommandsavailable.
PressHotkeyonthecontrollerandoneofthefollowing:
YSaveState
XLoadState
https://github.com/recalbox/recalboxos/wiki/Manual%28EN%29

7/10

4/13/2016

Manual(EN)recalbox/recalboxosWiki

StartQuit
AResetGame
BMenu
UpSelectSaveSlot1
DownSelectSaveSlot+1
L1Screenshot
RightSpeedupgame
LeftRewind(ifactivatedinoptions)
R2Nextshaderpreset
L2Previousshaderpreset
InFBAandMame,pressSelecttoaddacredit.InMame,ifyourHotkeyisSelect,youwillhaveto
quitwithR1+Start(inordertohaveselectascoin)
YoucanaccessretroarchconfigurationmenuwithHotkey+BIfyouwanttoconfigureretroarch
andsavetheconfig,youcanselectthe"SaveSettingsonExit"intheretroarchmenu.Afterthat,all
configurationyoumakeinrguiwillbesaved.

VUpdates
Therecalboxupdatecanbedoneinthefrontendmenu.Configurethewifiorpluganethernet
cableontherecalbox,pressStartandselect"SYSTEMSETTINGS"withA,then"UPDATES"and
"STARTUPDATE".
Aftertheupdate,thesystemwillreboot.

VINetworkfeatures
IfyouconfiguredthewifiorpluggedanEthernetcableontherecalbox,itsharesfilesonyourlocal
network.Onyourcomputer,gottoNetworkonWindowsexplorer,andselecttherecalbox:

Ifyoudon'tseetherecalboxinyournetwork,trytotype\\RECALBOXintheexploreraddressbar.
Ifitdoesn'twork,gointherecalboxmenu,NETWORKSETTINGSandnotetheip.Thentypeyour
ipintheexploreraddressbar,forexample\\192.168.1.30
Youcanaccessallrecalboxsharedfolders:

https://github.com/recalbox/recalboxos/wiki/Manual%28EN%29

8/10

4/13/2016

Manual(EN)recalbox/recalboxosWiki

AAddyourgames
Justcopythefilesinthecorrespondingfolder.Youcanuseeither.zipfilesoruncompressedroms.
Torefreshthegamelibrary,gototheMenu,thenGamesSettingsthenUpdateGamesLists
Donthesitatetotalkaboutyourfavoritegamesintherecalboxforum!
http://blog.recalbox.fr/forums/

BArcadegames
Ifyouwanttoaddarcadegamesonyourrecalbox,youshouldreadtheminihowtoEasyArcade
onRecalboxandlearnhowtocheckyourromsversion.
ThenyoucanalsoenabletheNeogeoUnibiostohavemoreoptionswithyourgames.

CScummvmgames
WhenyouaddaScummvmgame,itmustbeinanuncompressedfolder.Inthisfolder,youwill
havetoaddasinglefile,named[gameshortname].scummvm
Youcanfindshortnamesforallsupportedgamesathttp://scummvm.org/compatibility/
Forexample,ifyoucopiedthefolder"BrokenSword1"inthescummvmdirectory.Inthisfolder
createafilenamedsword1.scummvm
Yourgamewillappearinthefrontend,andyouwillbeabletochangeit'smetadataifyouwantto
displayagoodname.

DScreenshots
PressHotkey+L1inemulatorstotakeascreenshot.Thepngfileissavedinthe"screenshots"
directory,youcanaccessonthenetwork.
Shareyourbestscreenshotswithusonhttp://blog.recalbox.com/forums/

ESaveyoursaves
Thesavesfoldersharecontainsallsavesandsavedstates.Youcancopyallthefilesifyouwant
tosecurethem.

VIIKodiMediaCenter
BypressingXbuttononyourcontroller,youcanlaunchKodiMediaCenter,akaXBMC.Youcan
alsoaccessKodibypressingstartandlaunchingitfromthemenu.
ToquitKodi,Navigatetothelowerleftpowericonandselect"PowerOffSystem"intheprogram,
andyouwillcomebacktorecalboxOS.Currently(3.3.0b17)usingthe"Exit"buttonmaylockup
yourPI
https://github.com/recalbox/recalboxos/wiki/Manual%28EN%29

9/10

4/13/2016

Manual(EN)recalbox/recalboxosWiki

Thecontrollersarenowsupportedinkodi,butifyouprefer,youcanuseHDMICECora
smartphoneremoteapplication.MoreinfoontheminihowtoKodionrecalbox

VIIITroubleshooting
AControllers:
ThePS3controllerisblinkingbutdoesnotassociate
Plugacontrollerontherecalboxandwait10seconds.Youcannowunplugthecontrollerand
presstheHomebutton.
ThePS3controllerseemsdead
Youmustresetthecontrollerbypressingalittlebuttonbehindthecontrollerinalittlehole,
withapaperclip.

BOther
Blackborder,imagetoobig
Useyourtvremotetofindtheimagemenu,andsettheimagesizeto1:1pixelorfull.
Ifitdoesn'twork,trytoactivatetheoverscanintherecalboxmenuSystemSettings.
SeeOverscansettingsformoreinformation.
BlackscreenonPCmonitorIfyouhaveablackscreenonPCmonitor(hdmiordvi)editthe
config.txtfile(MAJatstart)andremovethelinehdmi_drive=2
MoreinfoinMiniHowToConnectyourrecalboxtoaDVIscreen

CHardreset
Ifyouwanttoresetthesystem,pluganusbkeyboardandpressShiftatstartup.Youcan
reinstallrecalboxOSfromhere.Allyourdatawillbeerased.

DRootAccess
Usetheusernamerootandthepasswordrecalboxroot
Youcanconnectthroughsshtotherecalbox.
YoucanaccessaterminalbyquittingemulationstationwithF4andthenpressALT+F2.
MoreinfoinMiniHowToRootaccessonterminal

IXrecalbox.conf
Thefilerecalbox.confsharedinthesambasystemdirectoryisusedtomodifyothersettingsthat
willnotappearinthefrontend.Seerecalbox.conf

The3.3.0betadocumentationiswritteninEnglishandisthentranslatedbythecommunity.Ifyouareonthe
3.3.0beta,pleaserefertoEnglishdocumentationfornow.
Ladocumentationdelabeta3.3.0estcriteenanglaisetensuitetraduiteparlacommunaut.Sivoustessurla
3.3.0beta,prfrezladocumentationanglaise.

2016GitHub,Inc. Terms Privacy Security Contact Help

https://github.com/recalbox/recalboxos/wiki/Manual%28EN%29

Status API Training Shop Blog About

10/10