Show Control Panel Layout before game starts in RetroPie, just like Arcade1UP does.

robertvb83

@Texacate hey thanks thats a good point with contact information. I cannot change this myself but i think @markwkidd can add that info/links.

The button names for retroarch are great especially for unusual joypad layouts. So i already contributed some exotic games like stonebal or space wars. With written functions instead of btn1 btn2 btn3 it is now much easier to configure those games for any joypad that people use.

Of course missing clones are always welcome or even missing parent roms. But be aware not always are clones the same as parent by means of button names

Would be super cool if your naming contributions find their way into mame2003-plus as well

TheRealSmilebit

Kinda circled around back to this. You all are doing more with this than I can. This is a mock up of what I originally was going for:

And keep in mind this is tailored to my tastes and nothing is automatically built...everything is manual.

However, my goal was to get to where the background, control panel, marquee, ect. were in a separate folder for either a system or game and then have a XML setting file to assemble the file based on what files were supplied. Would work on once part at a time.

After looking at what you are all doing...may be making this a bit to complex. Will be trying out Texacate's example this weekend to see if I can get that up and running.

Texacate

@TheRealSmilebit

Cool. I love your concept example! Maybe someday. BTW, I just put my latest script, plus the CSV files, on GitHub. It's not very polished yet. But much better than previous versions.

I added support to run the main image creation script button_map.sh on the RPi.
Updated the Wiki on installing ImageMagick on the RPi.
If button data for a clone is not available, the script will attempt to use the button data from the parent rom.
Generates a place holder image, when no button data is available. Leaves them in the the tmp directory.
Uploaded a separate file with my suggested button data for additional roms. I have about 250 roms listed in custom_map.csv so far. More to come, I play a dozen or so games every day, and try to figure out what the appropriate names are for the buttons. I do try to look for a picture of the original arcade cabinet, and use those labels if possible.
Added a new script for doing your entire collection, all at once. for_all_roms.sh

I'm amazed how many games are just vertical shooters, with the exact same Fire,SuperBomb buttons. I found a fun unique variation on that theme. Check out dfeveron.zip and its Disco Bomb!

TheRealSmilebit

@Texacate Thanks...I plan on installing it this weekend. I have been looking at ImageMagick and messing around with it as well. Will let you know how your install goes.

Texacate

@TheRealSmilebit
custom_map.csv contains 600 labels now! Getting the data from www.arcade-museum.com, but its not automated. Clicking on each game's web page, and copy/paste . Not all pages have labels, but it's been much faster than playing each game. Downside is, there's a chance I don't have the buttons in the right order. Verification will be needed at some point.

Texacate

Update: I have collected button label data for ~1000 games, plus the ~1000 from the the controls.dat project, for a total of ~2000 titles. For now I'm done collecting the button data, and will work on improving usability of the image generation script. Suggestions are welcome.

Texacate

I received some feedback and have flipped how the two rows are labeled by default;

New Mapping

MAME   RetroPad  CntrPnl
123  -->  YXL -->  123
456  -->  BAR -->  456

Before it was

MAME   RetroPad  CntrPnl
456  -->  YXL -->  123
123  -->  BAR -->  456

Also, the script searches three database files for label data, (vs one previously). Now: custom_map.csv file is truly reserved for user customizations, button_map.csv file was renamed primary_map.csv, and the additional data I collected is in secondary_map.csv

janderclander14

@Texacate Thanks a lot for this project! I plan to use it on a secondary SPI LCD connected to the GPIO. I assume that in this case I need to modfiy the server so that it outputs the images in a second framebuffer, rather than a second Raspberry.

Regarding the mappings, could this be made configurable via an external file? The motivation is that, whereas Mame-2003plus default mapping is:

123
456

In FBalpha (which I use more often for arcade games) it is:

456
123

Also, with this approach it could be possible to support global custom controls.

Texacate

@janderclander14 said in Show Control Panel Layout before game starts in RetroPie, just like Arcade1UP does.:

@Texacate Thanks a lot for this project! I plan to use it on a secondary SPI LCD connected to the GPIO. I assume that in this case I need to modfiy the server so that it outputs the images in a second framebuffer, rather than a second Raspberry.

Yes. Discard the simpleClient.py file completely, and strip out all the socket communication code from simpleServer.py, and only keep the bits that reassembles a full pathname of the desired image from the system name & rom name, and displays it. By the way, the whole reason I chose python for that part was I found a good tutorial on client/server communication. If I was coding it to work all on a single RPi, then the file-display stuff would have been written in bash.

Could (the mapping) be made configurable via an external file?
( Mame)
123
456

In FBalpha (which I use more often for arcade games) it is:
456
123

Yes, button_map.sh could certainly be enhanced to read an external config file. But assuming the number of different configs is small and predictable, it might be easier to pre-code the required mappings, and just add a switch to select the one you want. Something like: if ($arg2 = "-fba") use 456123, else use 123456.

Also, with this approach it could be possible to support global custom controls.

I'm not sure I understand what you mean by global custom controls. Are you thinking of something beyond button labels? As in; joystick direction labeling, trackballs active/inactive, different control panel arrangements, etc.

Texacate

@janderclander14

Also a the RPi (out of the box) has only one frame buffer. This is baked right into Raspian. I did some google research on adding a second frame buffer. There are some success stories out there, but as I recall, details were sketchy and the whole thing seemed pretty advanced. That was another reason I chose a second RPI. If you find the solution, please post! I gave up, and spent an extra $30 on another RPi.

Texacate

@janderclander14 said in Show Control Panel Layout before game starts in RetroPie, just like Arcade1UP does.:

In FBalpha (which I use more often for arcade games) it is:

456
123

I use that arrangement too. I've updated the script to handle it. Try the latest version on github, and append the switch"-fba" to the command line. Default is still:
123
456

But button_map.sh <game> -fba gives you:
456
123

Also added button_map.sh <game> -8btn which gives you:
1237
4568

janderclander14

@Texacate Thanks a lot! This adds quite a lot of flexibility across emulators and control layouts.

Regarding the frame buffer, the RPi only supports two framebuffers if the second one corresponds to a LCD screen connected to the GPIO via SPI. These are usually small screens that plug like a HAT and that, because of the serial connection, offer poor refresh rates. However, they are fine for displaying static images like the panel layout or the marquee.

Here you can see the build of a user that employed one of these small screens to display the title of the game in a snes cartridge while using the HDMI output as the main display:

https://retropie.org.uk/forum/topic/3376/pi-in-a-super-famicom-build

He also provides a runcommand script to detect the running game and display the artwork, similarly to your project.

As far as using two framebuffers in general, for example, combining the HDMI and DSI outputs, I'm only aware of a beta kernel that seems to support this but does not seem to be included in the public distribution yet:

https://www.raspberrypi.org/forums/viewtopic.php?t=216399

Texacate

@janderclander14
Thanks for the pointers! I noticed that post #177 of the Super Famicom project included the runcommand_onstart.sh code, to display the image on the SPI based LCD. Very cool. I'd say go with that versus what's in my simpleServer.py script. It seems to follow very similar "fall-back rules" when the desired image isn't found.

Let us know how your build goes! Do let me know if you find errors in the primary and secondary database files. The secondary one especially was a whole lot of copy-n-paste.

Kjarkur

Hey, thanks a lot for this project. I adapted the source code and put game snaps as background, new buttons and instead of rom file name the game name. Second I modified it to use a crt friendly resolution of 320 x 240 for my arcade cab via pi2jamma.

Here's a little video.

Cheers

BJRetro

@Kjarkur wow guys this video is like what everyone envisioned for this project - great teamwork. Is there some way to incorporate this easily into retropie setup some day? This project is a huge advancement for the retropie user interface for people with arcade setups.

Kjarkur

@BJRetro the video shows my own regamebox distribution. I can make a fork on github.com. Of course it can be done with retropie easily. General steps are this

create the button mapping pictures in advance
put a picture viewer in runcommand-onstart.sh

I have used here a own picture viewer based on SDL. Reason was that I wanted to use something like quit on all keys and quit after 10 seconds.

Texacate

@Kjarkur I like what you did with the code. Using a game-specific background is a great idea!

janderclander14

@Texacate It took a longer than expected but I managed to setup up everything. First, I used a Waveshare 4inch SPI LCD connected to the GPIO, as explained here.

After that, I configured the lcd screen by using the overlays available here. It was quite straightforward. Just need to activate SPI in /boot/config.txt and add the overlay file corresponding to the screen. You may even use parameters to increase the refresh rate or rotate the screen (it uses a vertical orientation by default). The lcd is detected as a secondary framebuffer in /dev/fb1

Finally, as you suggested, I modified the script proposed here to call for the images generated by your button_map.sh tool once the emulator runs.

I post here the code that looks for the button image or falls-back to title or generic system images if not found.

# /opt/retropie/configs/all/runcommand-onstart.sh
# get the full path filename of the ROM
rom=$3
# get the system name
system=$1
# get rom filename without folder
rom_bn=$(basename "$rom")
#get rom filename without extension
rom_bn="${rom_bn%.*}"
# escape square brackets in rom filename
rom_bn="${rom_bn//[/\[}"
rom_bn="${rom_bn//]/\]}"
# Set a TFT-specific image if there is one
img="$(find "/home/pi/button_images/${system}" -type f -name "${rom_bn}.*" -print -quit)"
# If a TFT-specific image was not found, look in the images folder in the ROMs directory for that system
if [[ -z "${img}" ]];
then
   img="$(find "/home/pi/RetroPie/roms/${system}/media/cover" -type f -name "${rom_bn}.*" -print -quit)"
fi
# If cover is not found, look for the title
if [[ -z "${img}" ]];
then
   img="$(find "/home/pi/RetroPie/roms/${system}/media/title" -type f -name "${rom_bn}.*" -print -quit)"
fi
# If no game images are found, display one for the system being emulated
if [[ -z "${img}" ]];
then
   img="$(find "/home/pi/button_images/systems" -type f -name "${system}.*" -print -quit)"
fi
# If no system image is found, default back to the Picade logo
if [[ -z "${img}" ]];
then
   img="/home/pi/button_images/systems/picade.png"
fi
# run the script to display the image
sudo fbv -c -u -i -e -k /home/pi/button_images/systems/black.png > /dev/null 2>&1 &
sudo fbv -c -u -i -e -k "${img}" > /dev/null 2>&1 &

I used the fbv tool to display static images in the secondary framebuffer, but the more common fbi tool can also be used.

TheRealSmilebit

@Texacate Finally had an opportunity to look at your code. Looks good.

For myself, I just need static images as I showed in my video. So I think what I need to do is the following:

1 - Create XML file with gaming information. I would convert the work you have done and convert to XML. Do not have to do this, but would like to practice manipulating XML files.

2- Will also add to this what recommended controller to use. Joystick, spinner, trackball or lightgun.

3- If Joystick, what type (2-way, 4-way, etc.):

4- A note added stating if certain controller is not available, which one to use. This would be static on every image file.

5- When building the image, have the user select which button layout they want to use(6 button, 8 button, etc.)

I am going to program this in Windows for now, but use ImageMagic to create the image to eventually port over to the Pi. Basically would program similar to what you have (if it is ok to reference your code) and just create the images, but add the additional data.

Once the static image is create, will re-visit my code to have it come up before the game starts. Also thinking about just creating the image and putting the snapshots in the Screenshots or Covers folder. I have downloaded video snapshots and marquees, so the gamelist.xml file would already have a path to get the Screenshots or Covers and can just place the image on the theme instead. Would be less programming and just create the images.

In any case, will start on this over the weekend. Hopefully will have something functional by the end of the weekend.

Texacate

@janderclander14 and @TheRealSmilebit,

Sorry for the late replies. I'm not getting much hobby time these days... Feel free to reference/reuse any of my code in your projects. I'm always interested in seeing what folks do to improve it.