Skip to content

Retroarch setup overlays (EN)

Cirion75 edited this page Sep 7, 2018 · 7 revisions

Overlays per game:

What you need :

  • create the overlays folder + sub directory with the same name of the system
  • add there your .png, a romName.cfg + romName.zip.cfg

So here is the basic info through an example

  • System : mame
  • Rom : double dragon (ddragon.zip)

Folder : /recalbox/share/overlays/mame
Files :

  • /recalbox/share/overlays/mame/ddragon.zip.cfg :
input_overlay = "/recalbox/share/overlays/mame/ddragon.cfg"
  • /recalbox/share/overlays/mame/ddragon.cfg :
overlays = "1"
overlay0_overlay = "ddragon.png"
overlay0_full_screen = "true"
overlay0_descs = "0"

So see the link : recalbox will look for overlays/<system>/<rom.extension>.cfg which itself refers to another .cfg (the file doesn't need to be named like the rom, up to you to customize the input_overlay parameter). Same goes for the overlay name.

These are the very minimum requirements. You can of course add some custom retroarch parameters to ddragon.zip.cfg
Most of times you'd force the viewports.

Overlays by system:

What you need :

  • create the overlays folder
  • add there your .png + systemName_overlay.cfg inside /recalbox/share/system/configs/retroarch/overlays folder
  • add your systemName.cfg inside /recalbox/share/system/configs/retroarch folder
  • systemName.cfg is named like the folder's name in /recalbox/share/roms/.... For instance, sega 32 X file is called sega32x.cfg. There is an exception for odysee². The file must be called odyssey2.cfg (so not o2em.cfg)

So here is the basic info through an example

  • System : psx

Folder : /recalbox/share/system/configs/retroarch
File : /recalbox/share/system/configs/retroarch/psx.cfg

input_overlay = "/recalbox/share/system/configs/retroarch/overlays/psx_overlay.cfg"

Folder : /recalbox/share/system/configs/retroarch/overlays
Files : /recalbox/share/system/configs/retroarch/overlays/psx_overlay.cfg :

overlays = "1"
overlay0_overlay = "psx.png"
overlay0_full_screen = "true"
overlay0_descs = "0"

So see the link : recalbox will look for retroarch/<systemName>.cfg which itself refers to another .cfg (the file doesn't need to be named like the systemName_overlay, up to you to customize the input_overlay parameter). Same goes for the overlay name.

These are the very minimum requirements. You can of course add some custom retroarch parameters to psx_overlay.cfg
Most of times you'd force the viewports.

Custom Viewports:

So now that overlays per systems are defined, to correctly display the game inside the overlay, we'll set custom viewports for each system.

Let's take the gamegear as example:

  • Define ratio in Emulationstation options on custom.
    GAMES SETTINGS / GAME RATIO = CUSTOM

ratio_custom

  • Start a gamegear game then open retroarch menu with Hotkey+B.
  • Enable option that allows to display overlays in retroarch menu. Go in menu settings/onscreen_display/onscreen_overlay, then set this option:
    hide_overlay_in_menu = on -> off
  • Go in settings/video menu:
    • define aspect ratio on custom
    • set custom aspect ratio width and custom aspect ratio height values to perfectly display game inside the overlay.
    • note these 2 values.

custom_viewports

  • Exit the retroarch menu and the game without save any settings.

  • Edit file /recalbox/share/system/configs/retroarch/gamegear.cfg created before.

    • add defined values from the previous step:
    custom_viewport_width = "992"
    custom_viewport_height = "720"
    aspect_ratio_index = "22"
    

Our file contains these informations:

input_overlay = "/recalbox/share/system/configs/retroarch/overlays/gamegear.cfg"
custom_viewport_width = "992"
custom_viewport_height = "720"
aspect_ratio_index = "22"

If you want to display a predefined ratio, here are the aspect ratio codes:

0: 4:3
1: 16:9
2: 16:10
3: 16:15
4: 1:1
5: 2:1
6: 3:2
7: 3:4
8: 4:1
9: 4:4
10: 5:4
11: 6:5
12: 7:9
13: 8:3
14: 8:7
15: 19:12
16: 19:14
17: 30:17
18: 32:9
19: config (video_aspect_ratio setting)
20: 10:9 (1:1 PAR)
21: Core Provided
22: Custom

So to force, for instance, a 4:3 aspect ratio you have write in the cfg file: aspect_ratio_index = "0"

  • Save your file and exit.
  • Start a game to test.
  • Have fun.

Adding bezels from The Bezel Project Go to The Bezel Project and download the zip for your system: https://github.com/thebezelproject?tab=repositories

In this example I will use Atari7600 As in the example in the begining, create the atari7800 folder: /recalbox/share/overlays/atari7800/ And then a bezel folder in that: /recalbox/share/overlays/atari7800/bezel

Unzip your bezelproject-Atari7800-master.zip and copy all the .png and cfg files from: bezelproject-Atari7800-master\retroarch\overlay\GameBezels\Atari7800 to /recalbox/share/overlays/atari7800/bezel

Now edit all the .cfg files (i like to use Notepad++ for this). In Notepad++ use the replace function and replace: /opt/retropie/configs/all/retroarch/overlay/GameBezels/Atari7800/ With nothing and press the Replace in all documents.

The files should look like this:

overlays = 1 overlay0_overlay = "Alien Brigade (USA).png" overlay0_full_screen = true overlay0_descs = 0

Now make a copy of all the .cfg files and paste them in this folder: /recalbox/share/overlays/atari7800

Edit all of them in recalbox: Replace: overlays = 1 With nothing

Replace: overlay0_overlay = " With: input_overlay = "/recalbox/share/overlays/atari7800/arcade-artwork/

Replace: .png" With: .cfg"

Replace: overlay0_full_screen = true With: input_overlay_enable = true

Replace: overlay0_descs = 0 input_overlay_opacity = 0.900000

Add this line: input_overlay_scale = 1.000000

The file should now look like this: input_overlay = "/recalbox/share/overlays/atari7800/arcade-artwork/Alien Brigade (USA).cfg" input_overlay_enable = true input_overlay_opacity = 0.900000 input_overlay_scale = 1.000000

You can now start a game and test the result.

English

Basic

Advanced


Français

Basique

Avancée


Deutsch

Basic

Fortgeschritten


Español

Basic

Avanzado


Português

Básico

Avançado


Italiano

Di base

Avanzate

Clone this wiki locally
You can’t perform that action at this time.