Skip to content

Instantly share code, notes, and snippets.

@substring
Last active April 25, 2016 15:41
Show Gist options
  • Save substring/e473f24275f25a23cd3ba3c797df74b1 to your computer and use it in GitHub Desktop.
Save substring/e473f24275f25a23cd3ba3c797df74b1 to your computer and use it in GitHub Desktop.
recalbox.conf for API
# System Variable
# You can configure your recalbox from here
# To set a variable, remove the first ; on the line
# ------------ A - System Options ----------- #
## Available powerboards
# Values:
# ATX_RASPI_R2_6: http://lowpowerlab.com/atxraspi/#installation
# MAUSBERRY: http://mausberry-circuits.myshopify.com/pages/setup
# REMOTEPIBOARD_2003: http://www.msldigital.com/pages/support-for-remotepi-board-2013
# REMOTEPIBOARD_2005: http://www.msldigital.com/pages/support-for-remotepi-board-plus-2015
# WITTYPI: http://www.uugear.com/witty-pi-realtime-clock-power-management-for-raspberry-pi
# PIN56ONOFF: https://github.com/recalbox/recalbox-os/wiki/Add-a-start-stop-button-to-your-recalbox-(EN)
# PIN56PUSH: https://github.com/recalbox/recalbox-os/wiki/Add-a-start-stop-button-to-your-recalbox-(EN)
;system.power.switch=
## Recalbox Manager (http manager)
system.manager.enabled=1
## Recalbox security
# enforce security
# samba password required
# disable virtual gamepads
system.security.enabled=0
## Recalbox API (REST)
system.api.enabled=0
## EmulationStation menu style
# Values:
# default: default all options menu
# none: no menu except the game search menu
# bartop: less menu, only needed for bartops
system.es.menu=default
## Emulator special keys
# Values:
# default: default all special keys
# nomenu: cannot popup the emulator menu
# none: no special keys in emulators
system.emulators.specialkeys=default
## Show or hide kodi in emulationstation (0,1)
kodi.enabled=1
## Start kodi at launch (0,1)
# Values:
# 0: starts on ES
# 1: starts on Kodi
kodi.atstartup=0
## set x button shortcut (0,1)
# Values:
# 0: in ES, X does nothing
# 1: in ES, X starts Kodi
kodi.xbutton=1
## Kodi can wait for a network component before starting
## waithost is the ip or hostname that must answer to a ping to validate the availability
## waittime is the maximum time waited when kodi boots
## if waitmode is required, kodi will not start if the component is not available
## if waitmode is wish, kodi will start if the component is not available
## if waitmode is not set or has an other value, kodi will start immediatly
;kodi.network.waitmode=required
;kodi.network.waittime=10
;kodi.network.waithost=192.168.0.50
# ------------ B - Network ------------ #
## Set system hostname
system.hostname=RECALBOX
## Activate wifi (0,1)
wifi.enabled=0
## Wifi SSID (string)
;wifi.ssid=new ssid
## Wifi KEY (string)
# after rebooting the recalbox, the "new key" is replace by a hidden value "enc:xxxxx"
# you can edit the "enc:xxxxx" value to replace by a clear value, it will be updated again at the following reboot
;wifi.key=new key
## secondary wifi (not configurable via the user interface)
;wifi2.ssid=new ssid
;wifi2.key=new key
## third wifi (not configurable via the user interface)
;wifi3.ssid=new ssid
;wifi3.key=new key
## Samba share
system.samba.enabled=1
### Virtual Gamepads
system.virtual-gamepads.enabled=1
### SSH
system.ssh.enabled=1
# ------------ C - Audio ------------ #
## Set the audio device (auto, hdmi, jack)
# Values:
# auto:
# hdmi:
# jack:
audio.device=auto
## Set system volume (0..100)
# Range: 0-100
audio.volume=90
## Enable or disable system sounds in ES (0,1)
# Values:
# 0: no background music in ES
# 1: listen to music in ES
audio.bgmusic=1
# -------------- D - Controllers ----------------- #
# Enable support for standard bluetooth controllers
controllers.bluetooth.enabled=1
## Please enable only one of these
# -------------- D1 - PS3 Controllers ------------ #
## Enable PS3 controllers support
controllers.ps3.enabled=1
## Choose an driver beetween official, shanwan and gasia if you have dualshock clones. Only one type can be set
# Values:
# official: for official Sony Dualshock pads
# shanwan : for shanwan clones
# gasia: for gasia clones
controllers.ps3.driver=official
# ------------ D2 - XBOX Controllers ------------ #
## Xbox controllers are already supported, but xboxdrv can solve some compatibility issues
## Enable xboxdrv driver, disable this if you enabled ps3 controllers (0,1)
controllers.xboxdrv.enabled=0
## Set the amount of controllers to use with xboxdrv (0..4)
# Range: 0-4
controllers.xboxdrv.nbcontrols=2
# ------------ D3 - GPIO Controllers ------------ #
## GPIO Controllers
## enable controllers on GPIO with mk_arcarde_joystick_rpi (0,1)
controllers.gpio.enabled=0
## mk_gpio arguments, map=1 for one controller, map=1,2 for 2 (map=1,map=1,2)
controllers.gpio.args=map=1,2
## DB9 Controllers
## Enable DB9 drivers for atari, megadrive, amiga controllers (0,1)
controllers.db9.enabled=0
## db9 arguments
controllers.db9.args=map=1
## Gamecon controllers
## Enable gamecon controllers, for nes, snes psx (0,1)
controllers.gamecon.enabled=0
## gamecon_args
controllers.gamecon.args=map=1
## XGaming's XArcade Tankstik and other compatible devices
controllers.xarcade.enabled=1
# ------------ F - Language and keyboard ------------ #
## Set the language of the system (fr_FR,en_US,en_GB,de_DE,pt_BR,es_ES,it_IT,eu_ES,tr_TR,zh_CN)
system.language=en_US
## set the keyboard layout (fr,en,de,us,es)
;system.kblayout=us
## Set you local time
## Select your timezone from : ls /usr/share/zoneinfo/ (string)
;system.timezone=Europe/Paris
# ------------ G - UPDATES ------------ #
## Automatically check for updates at start (0,1)
updates.enabled=1
## Select your update channel
# Values:
# stable: check for updates on the stable channel. Most secure
# beta: to get the next version currently beeing tested. Expect some bugs
# unstable: development version. Use at your own risks
updates.type=stable
# ------------ H - HERE IT IS - GLOBAL EMULATOR CONFIGURATION ------------ #
## The global value will be used for all emulators, exept if the value
## is redifined in the emulator
## Set game resolution for emulators
## select your mode from the command : tvservice -m [MODE]
## CEA 5 HDMI : 1920x1080 @ 60Hz 16:9, clock:74MHz interlaced
## CEA 4 HDMI : 1280x720 @ 60Hz 16:9, clock:74MHz progressive
## use 'default' to keep the default resolution
global.videomode=CEA 4 HDMI
## Shader set. Automatically select shaders for all systems
# Values:
# none: no shaderset
# retro: select the retro shader
# scanlines: add software scanlines
global.shaderset=none
## Set gpslp shader for all emulators (prefer shadersets above). Absolute path (string)
global.shaders=
## Set ratio for all emulators
# Values:
# auto: let the emulator select the right ratio
# 4/3: for the 4:3 ratio
# 16/9: force the 16:9 ratio
# 16/10: force the 16:10 ration
# custom: manually edit the recalbox.conf => LUI VA POSER PROBLEME ....
global.ratio=auto
## Set smooth for all emulators (0,1)
# Values:
# 1: Activate bilinear filtering in libretro
# 0: big old school pixels
global.smooth=1
## Set rewind for all emulators (0,1)
# 1: try'n'die
# 0: no rewind, genuine gameplay experience
global.rewind=1
## Set autosave/load savestate for all emulators (0,1)
# Values:
# 0: don't save on exit, load on start
# 1: saves on exit, loads on start
global.autosave=0
## Enable retroarchievements (0,1) => REEDITER CONFIGGEN POUR LES .ENABLED AJOUTES
## Set your www.retroachievements.org username/password
global.retroachievements.enabled=0
global.retroachievements.hardcore.enabled=0
global.retroachievements.username=
global.retroachievements.password=
## Set retroarch input driver (auto, udev, sdl2)
## If you don't have issues with your controllers, let auto
# Values:
# auto:
# udev:
# sdl2:
global.inputdriver=auto
## If you do not want recalboxOS to generate the configuration for all emulators (string)
;global.configfile=/path/to/my/configfile.cfg
################### LA CA DEVIENT LA CONFIG PROPRE A CHAQUE EMULATEUR
# ------------ I - EMULATORS CHOICES ----------- #
## You can override the global configuration here
## Here is the snes example
;snes.videomode=CEA 4 HDMI
;snes.core=snes9x_next
;snes.shaders=/recalbox/share/shaders/shaders_glsl/mysnesshader.gplsp
;snes.ratio=16/9
;snes.smooth=0
;snes.rewind=1
;snes.autosave=0
;snes.emulator=libretro
## If you do not want recalboxOS to generate the configuration for the emulator :
;snes.configfile=/path/to/my/configfile.cfg
## Default cores for RPi3
snes.core=snes9x_next
gba.core=mgba
mame.core=mame078
nes.core=fceunext
## NeoGeo emulator
## You can use pifba or a libretro core (fba2x,libretro)
neogeo.emulator=libretro
## If you set libretro as neogeo.emulator, the line below sets the retroarch core (fba,imame4all)
neogeo.core=fba
## N64 emulator is configured to display a screen with a 640x480 resolution (native n64 resolution)
## So you must use one of these video modes (DMT 4 HDMI,CEA 1 HDMI).
## If your screen is not compatible with one of these video modes, please check the recalbox's wiki.
n64.videomode=DMT 4 HDMI
## If you are using a CRT screen, please change the setting above with this one :
# n64.videomode=default
## Dreamcast emulator
## Like N64, such a CPU intensive emulator needs a small resolution
## Consider DMT 4 HDMI or DMT 9 HDMI. Mode 9 is selected for a better screen compatibility
dreamcast.videomode=DMT 9 HDMI
## Configurations generated by Recalbox
@substring
Copy link
Author

reste à détailler kodi. et remettre voir pour retroachievements. LEs .enabled ne le sont pas par défaut, à voir avec le configgen

@substring
Copy link
Author

substring commented Apr 25, 2016

Détail de la lecture d'une section

Une section commence par ## et finit par la lecture du tuple propriete=valeur. Il est recommandé de faire un saut de ligne avec le tuple.

Une section comporte :

  • une description. Toutes les lignes de début de section commencant par ##sont des commentaires de la section
  • optionnel : un descriptif du type de valeur #Values: ou #Range:
  • le tuple propriete=valeur

Le descriptif

Chaque ligne de descriptif doit commencer par un ##.
Exemple : ## Recalbox Manager (http manager)

Values:

Lors une ligne commence par # Values:, l'snebme des lignes de la forme #valeur: commentaire sont les valeurs que peut prendre la propriété.
Exemple :

# Values:
# ATX_RASPI_R2_6: http://lowpowerlab.com/atxraspi/#installation
# MAUSBERRY: http://mausberry-circuits.myshopify.com/pages/setup
# REMOTEPIBOARD_2003: http://www.msldigital.com/pages/support-for-remotepi-board-2013
# REMOTEPIBOARD_2005: http://www.msldigital.com/pages/support-for-remotepi-board-plus-2015
# WITTYPI: http://www.uugear.com/witty-pi-realtime-clock-power-management-for-raspberry-pi
# PIN56ONOFF: https://github.com/recalbox/recalbox-os/wiki/Add-a-start-stop-button-to-your-recalbox-(EN)
# PIN56PUSH: https://github.com/recalbox/recalbox-os/wiki/Add-a-start-stop-button-to-your-recalbox-(EN)

Ranges:

Cette ligne indique l'intervalle de valeurs acceptées, bornes inclues.
Exemple : # Range: 0-100 -> la propriété doit être dans l'intervalle [0, 100]

propriete=valeur

Elle peut éventuellement commencer par un ; pour laisser le comportement par défaut

global et emulateurs

Certaines propriétés pour émulateurs peuvent être configurées de façon globale. Ces propriétés sont préfixées soit par global soit par le nom du systeme

Propriétés globales et par émulateur :

  • videomode
  • shaders
  • ratio
  • smooth
  • rewind
  • autosave

Note pour global.videomode : si sa valeur est à default, dans ce cas Recalbox ne switche pas sur cette resolution avant de lancer un émulateur

Propriétés pour emulateur seuleemnt

  • emulator
  • core

core et emulateur sont disponibles dans /recalbox/share_init/system/.emulationstation/es_systems.cfg

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment