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

Arnulf

I like this idea.
I've done this a few day ago to light my buttons depending on the rom/game.
I wrote a python script which will do this for me.

My next plan would be to illustrate this within the load screen. So this thread is now one of my favorite :)

@cyperghost : I like your method to trace the keylayout.txt.

Texacate

I have a prototype of this working, and have set up my first "real" github project!

All the files are at:
https://github.com/Texacate/Visual-RetroPie-Control-Maps

The (starting framework of) the documentation is at:
https://github.com/Texacate/Visual-RetroPie-Control-Maps/wiki

This is definitely a work-in-progress and is my first foray into Python programming! Please be kind. I'm sure I've made numerous coding blunders. Also, I have no artwork files built yet, (I'm using a set of marquee files for my testing). But the thing actually works and does not seem to crash my RPis !

I would love to have feedback on this.

Thanks!

cyperghost

@Arnulf Yes I think the way to do is clear but I think I've not the time to take on that challenge. Working on some other projects currently

@Arnulf Why do you want to establish a communication socket between a node? I think the Pie alone is powerfull enough to create/show/manage every image. Keep us imformed about your progress ;)

Texacate

@cyperghost Was the question on socket communication meant for me?

My project uses a small LCD screen dedicated to displaying the button map, where as GreenGriffon and others prefer to use the splash screen, upon launching the game. I agree there is enough compute power to handle everything on one RPi. But out of the box, an RPi cannot drive the HDMI port and the LCD port at the same time. This limitation led me to choose a 2nd RPI for the button map display, but also created a need for the two RPIs to communicate. TCP sockets seemed a logical way to accomplish that.

CargoRunner

@GreenGriffon I think your loading screen looks great. And you are certainly correct when you say how time consuming producing them is. I wanted to do the same thing for console games. I have a small curated list of games too. I find the more artwork the more interesting and/or nostalgic the experience of playing the game is. And reminding the player what the controls are can make playing the game enjoyable instead of frustrating when nothing seems to work. I gave up on my theme and console loading screens as I am not artistic enough to make the finished product look good enough.

Carnival (USA)-image.jpg

And as people have stated, the value of sharing the finished product is limited as people use different controllers. Mine is based on the xbox 360 controller.

I put the TV retropie project on hold as I want to build an arcade cab more. I would love to use your loading screens but my menu/exit/coin/start buttons are in totally different places.

I think that the ideal solution would be if the loading screen was an XML defined page just like the game select screens. So the loading screen was just part of the emulation station theme. The XML defined page could then pick up the artwork and button text. This is obviously a significant change to ES so is not possible at all. But it is nice dreaming !

BJRetro

I stumbled upon a post of someone else trying to do something like this so linking here since there was a different tool mentioned for automating the control images thought those considering this project might want to look at: https://retropie.org.uk/forum/topic/20030/controller-info-overlay-in-the-game

Texacate

@BJRetro Thank you for the link. CPWizard looks like an interesting tool! However I spent a good chunk of time today figuring out how ImageMagic works, and finally got something to show for it.

I have a prototype image building script that uses ImageMagic, and the scripting that @cyperghost posted above. The script and the underlying button images have been added to my github project. Here's an example I built with the script:

I could use some help converting the controls.dat / control.c data into the simplified keylayout.txt format.

UPDATE: For now, all the data in my project is in .csv format (comma separated values). The keylayout.txt file has been removed from the project repository.

Arnulf

@cyperghost

no no... the port is not my idea. I am only using the IO extension, because it is easier to handle all of my 32 LEDs :)

But for another project it could be one solution to use a second pi (pi zero or any cheap alternative) to handle a second monitor or display

Arnulf

@Texacate
thumbs up!

nice work

cyperghost

@Texacate Wow... thank you for the take off ;)
I think you've done the first steps for an impressive usecase.
I think that not only a "lauching screen" can be used for this but also the button controlls can be burned into overlay ;)

I could use some help converting the controls.dat / control.c data into the simplified keylayout.txt format

I'm not sure of the keylayout.txt should be used. I think it's better to have an database in whatover format (XML, SQL, JSON) where the buttons are assigned and use a engine to export one request to a keylayout.txt. This file can be processes by the script with imagemagik

@Arnulf

no no... the port is not my idea. I am only using the IO extension, because it is easier to handle all of my 32 LEDs :)

Ah understood. But then the script is also usefull. You need a simple logic... instead of adding "green" buttons in a picture you send command to light up the controller LED.

Texacate

@cyperghost Thank you. Agreed, both the button-map-artwork-generator, and the display-server could be used for a lot of things. A dynamic marquee display comes to mind too.

I would be happy to integrate an XML reader into the scripts, if someone can point me to an free, easy-to-use XML reader, with some good examples I can follow. The ones I've seen are Windows based. I need a simple Linux one. For all I know, there could be one built right into every Raspian disto, and I'm just not aware of it. I'm just not a very experienced database-querying guy. I'm more of a simple MS Excel kind of database guy.

Meanwhile, it's time for me put some more work into the WIKI documentation...

Texacate

Wow the wiki I'm writing is getting out of control. I'm up to 15 pages or more. I'm thinking of splitting the project in half. IE: Separate all the stuff that generates the library of button-map images, from the all the stuff that selects and displays those images. Two independent GitHub projects.

mitu

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

I would be happy to integrate an XML reader into the scripts, if someone can point me to an free, easy-to-use XML reader, with some good examples I can follow

One XML manipulation program that's available (and installed by the RetroPie-setup script) is xmlstarlet - it can be used to read and manipulate XML documents. Unfortunately it fails at the good examples category.
But if you have the file structure and you can tell me what information you'll need extracted, we can lend a hand.

GreenGriffon

@CargoRunner I think your attempt looks great! I can definitely see that being a time-consuming endeavor as well.
In my case, I wanted to keep mine simple and straightforward, without inundating the user with too much info (although it's nice to have). My launching images are set to 6 seconds - just enough time to see the controls and the original arcade flyer, and the user would be all set to play the game.
Even with simple requirements, yes, still a time consuming project. For me, most of the time is being spent on finding a high quality copy of the arcade flyer for each game. The rest is a Photoshop template where I just display the layer for each button with the function, and that's it. I'm slowly making progress.
My controls are obviously customized for the retrocade I built, but the 6-button layout itself is pretty standard. Someone else might find them useful.

GreenGriffon

I'm very happy to see that you guys are developing a hopefully automated solution to creating these images. Very inspiring stuff!

Texacate

@mitu Thanks for the pointer to xmlstarlet. There was just enough examples for me to dump all the button names inside controls.xml file into some plain text. Then, with a whole bunch of grep commands, followed by a series of search-and-replace in my favorite text editor ( nedit ), I was able to wrangle the data into comma sepearated lines. I like .csv because it is easy to maintain in Microsoft Excel. Now I'm off and running. I will post the simplified button_dat.csv file to my GitHub area later today. This doesn't cover the clones, but for now, that's good enough. I can go build my library of images now.

TheRealSmilebit

Just came back to this and gotta say...WOW...some of this is over my head and wish I could contribute more to help out...but will keep plugging away at what I can do.

markwkidd

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

Thanks for the pointer to xmlstarlet. There was just enough examples for me to dump all the button names inside controls.xml file into some plain text. Then, with a whole bunch of grep commands, followed by a series of search-and-replace in my favorite text editor ( nedit ), I was able to wrangle the data into comma sepearated lines. I like .csv because it is easy to maintain in Microsoft Excel. Now I'm off and running. I will post the simplified button_dat.csv file to my GitHub area later today. This doesn't cover the clones, but for now, that's good enough.

Do let me know if you want to work together on generating this from the control names that are actually in the MAME 2003-Plus source. Plain text, XML, etc is all possible.

GreenGriffon

@chicuelo Hi, the arcade joystick icon that I'm using in my launching image above...did you create that? I found it somewhere online, but can't seem to track down the original source.
If so, not sure when I'll be done with this batch of launching images, but would you be okay with me releasing them for others to use?

Texacate

@markwkidd At some point I will take you up on the offer to pull the data directly from XML, or JSON or whatever. But right now I'm happy with CSV.

@GreenGriffon I'm in the same boat. I wan't to make sure I'm using public-domain button and joystick artwork, and give proper credit to original source. I may end up just drawing my own button and joystick icons...

BTW everyone, I have put the CSV button database in my github area. It's it in the MAME generic order: P1_BUTTON1, P1_BUTTON2, P1_BUTTON3, etc .

Also the works:

A copy of the exact same data, but with "less wordy" labels. Some of the text is 20 or more characters per button, and the label runs off the screen, or collides with an adjacent label.
Auto-scaling down the font size when a label has a lot of characters, for the same reason.
Functions that map MAME->RetroPad, and then RetroPad->ControlPanel. Hopefully that will make the scripts easier to customize according to one's specific button layout.