Versatile C++ game scraper: Skyscraper

AlCzervik

@muldjord this is what it looks like:

muldjord

@AlCzervik I've been reading up on this and this is actually a bit tricky. EmulationStation actually launches the game when you select a gamename.daphne folder. This is quite unusual. No other platform I am aware of does this. They all launch using files. Skyscraper and other scrapers don't scrape folders, they scrape files, meaning that the gamename.daphne folder is not scraped, which is why you don't have any game information and artwork on it. But, the roms/lair.zip files is scraped, but this file is hidden inside of EmulationStation it would seem.

So I'll need to figure out how to deal with that.

AlCzervik

@muldjord Gotcha. Yeah, Daphne is quite different but once operational it works like a charm. Let me know how I can help troubleshoot/test!

muldjord

@AlCzervik This is now working in 3.5.0 which has just been released. Just update Skyscraper and run Skyscraper -p daphne and it should work without having to rescrape the data. Remember to exit EmulationStation first.

muldjord

Skyscraper 3.5.0 released: https://github.com/muldjord/skyscraper

For 'screenscraper', 'thegamesdb', 'mobygames' and 'arcadedb' Skyscraper will now no longer fetch the artworks if user has requested it to remain uncached (Thank you to user 'herbymachine' for the request)
Added '--skipexistingmedia' option to allow for faster gamelist generation in cases where some artwork already exists in the gamelist media folder (Thank you to 'jacrify' for suggesting this)
Added '--flags' command-line option that collects certain flag-like options into one
Added deprecated warnings to all options that are now moved to the '--flags' option
Added '*.cue' extension to '3do' platform (Thank you to 'therealdealneil' for the suggestion)
Implemented a hack for the 'daphne' platform that will add the game info to the 'game.daphne' folders instead of the 'game.zip' files (Thank you to 'AlCzervik' for pointing this out)

Several new features made it into this one that have been a long time coming. For one, when scraping any platform and user has requested any particular artwork resource not to be cached, the artwork will no longer be fetched from the sources either. This saves bandwidth and will provide faster resource gathering. So if you use the --nocovers and so on options (which are now deprecated, read on below), this will be useful to you.
A somewhat similar feature is the option to now skip any artwork generation if the artwork already exists in the media output folder. This can be done with the flags --flags skipexistingTYPEs where TYPE is cover, screenshot and so on. Remember the sat the end, so it's --flags skipexistingcovers. So basically, if the only thing you've changed is the textual data and you want to regenerate the gamelist only with that, you can now skip some or all of the artwork compositing to save a lot of time.

So, this is 3.5.0, and a rather substantial change to the command-line options have also snuck in. I was getting increasingly annoyed with how bloated the Skyscraper --help output was getting. It shows way too many options that are often only used in niche cases. I wanted to do away with that. So all options that do not require a parameter, which means they are basically flags, have now been collected in the --flags FLAG1,FLAG2 option. To see all available flags simply type Skyscraper -p PLATFORM --flags help. I will probably make this a bit smarter in the coming releases. Specifically I want it to only show flags that are relevant in relation to what mode Skyscraper was started in. For instance, if -s MODULEisn't set, it shouldn't show the --flags forcefilename option in the flags help text as it is not relevant when -s MODULEis left out. So it will be a contextual flags help. For now though, it just shows all flags.

@mitu The old options are still there, but should be corrected in the retropie script sometime soon'ish, as I plan to remove them from Skyscraper entirely in a few months. I won't do so without warning of course, but for now they are clearly marked as Deprecated in the Skyscraper --help output. If you want me to I can look over the script myself and see if I can figure out how to migrate them to the new --flags unattend,forcefilename,... format. Let me know what you think.

AlCzervik

@muldjord Still not showing with v3.5.0. What can I do to help? When I kill EmulationStation I do see the following error (not sure if this is related at all):
lv10: Error finding/creating FileData for "/home/pie/RetroPie/roms/daphne/roms"

muldjord

@AlCzervik I just tested it on lair, works fine.

Please recheck that Skyscraper has been updated to 3.5.0 at the top when you run it. For a more thorough fix, first exit EmulationStation (Very important!) then try running:

$ Skyscraper -p daphne -s screenscraper --refresh --flags unattend
$ Skyscraper -p daphne --flags unattend

That should do it. For it to work you need the lair.daphne folder with the files inside. And there needs to be a roms/lair.zip file, just as it describes on the RetroPie daphne page you linked above.

AlCzervik

@muldjord I reconfirmed 3.5, ran your commands, and still no art. I then removed everything from the daphne folder, restarted and no game (as expected). I then re-added all the files to lair.daphne and the roms folders under daphne. So the daphne folder only had lair.daphne and roms and the roms folder contained lair.zip. Rebooted and Dragon's lair was operational. Played a few rounds to confirm. I then exited EmulationStation again, re-ran the two commands you list above and still nothing via EmulationStation. I once again see the following error after quitting EmulationStation now: lv10: Error finding/creating FileData for "/home/pie/RetroPie/roms/daphne/roms", skipping. I think that has to be part of the issue. Lair is operational so I know the folders are setup correctly. Let me know what screenshots you'd like.

muldjord

@AlCzervik Can you please paste the contents of /home/pi/RetroPie/roms/daphne/gamelist.xml here as a codeblock? I'm kind of thinking that maybe some other gamelist is overriding it. I just need to verify that it even exists and that the contents look as it is supposed to.

AlCzervik

@muldjord Here you go:

<?xml version="1.0"?>
<gameList>
<folder>
<path>/home/pi/RetroPie/roms/daphne/roms</path>
<name>Dragon's Lair</name>
<cover />
<image>/home/pi/RetroPie/roms/daphne/media/screenshots/lair.png</image>
<marquee>/home/pi/RetroPie/roms/daphne/media/marquees/lair.png</marquee>
<video />
<rating>0.8</rating>
<desc>Originally released in the arcades as a laserdisc game, Dragon's Lair is an interactive cartoon movie. Players control Dirk the Daring as he struggles his way through a dungeon to fight Singe, the Dragon, and rescue the beautiful Princess Daphne. The game consists of animated scenes, during which the player has to press direction buttons or the sword button in the right moment to trigger the next segment of the movie.</desc>
<releasedate>19830601T000000</releasedate>
<developer>Sullivan Bluth Interactive</developer>
<publisher>Cinematronics</publisher>
<genre>Platform, Plateform / Run Jump, Action / Adventure</genre>
<players>2</players>
</folder>
</gameList>

muldjord

@AlCzervik Thanks, something is definitely wrong with that. <path>/home/pi/RetroPie/roms/daphne/roms</path> should be <path>/home/pi/RetroPie/roms/daphne/lair.daphne</path>. I find that a bit odd as it worked when I tested it here. I'll look into it.

muldjord

@AlCzervik 3.5.1 out now where this is fixed. It only happens when you only have a single rom for the daphne platform. Which is why it didn't happen on my setup where i have two. But it's fixed for instances where the is only one as well now.

Please update and run Skyscraper -p daphne.

mitu

Not quite, but progress. Here's what it generated in my gamelist:

  <folder>
    <path>/home/pi/RetroPie/roms/daphne/lair.daphne</path>
    <name>Dragon&apos;s Lair</name>
    <cover />
    <image>/home/pi/RetroPie/roms/daphne/media/screenshots/lair.png</image>
    <marquee>/home/pi/RetroPie/roms/daphne/media/marquees/lair.png</marquee>
    <video />
    <rating>0.8</rating>
    <desc>Originally released in the arcades as a laserdisc game, Dragon&apos;s Lair is an interactive cartoon movie. Players control Dirk the Daring as he struggles his way through a dungeon to fight Singe, the Dragon, and rescue the beautiful Princess Daphne. The game consists of animated scenes, during which the player has to press direction buttons or the sword button in the right moment to trigger the next segment of the movie.</desc>
    <releasedate>19830601T000000</releasedate>
    <developer>Sullivan Bluth Interactive</developer>
    <publisher>Cinematronics</publisher>
    <genre>Platform, Plateform / Run Jump, Action / Adventure</genre>
    <players>2</players>
  </folder>



<folder>
    <path>/home/pi/RetroPie/roms/daphne/astron.daphne</path>
    <name>Astron Belt</name>
    <cover />
    <image>/home/pi/RetroPie/roms/daphne/media/screenshots/astron.png</image>
    <marquee>/home/pi/RetroPie/roms/daphne/media/marquees/astron.png</marquee>
    <video />
    <rating>0.6</rating>
    <desc>In Astron Belt, you fly through the universe battling alien ships to make your way to fight the main Alien Battle Cruiser.  Along the way, you fly across alien planets, through tunnels, through trenches, and get involved in a few astro-dogfights with enemy space fighters</desc>
    <releasedate>19830710T000000</releasedate>
    <developer>Sega</developer>
    <publisher>Sega</publisher>
    <genre>Shoot&apos;em Up, Shooter, Shooter / Plane, 1st person</genre>
    <players>1</players>
  </folder>

Note that I have a single game (lair.daphne), and the roms sub-folder has multiple entries (for multiple games), which have been thoroughly scraped :). The gamelist has all the .zip scraped data for each zip found under roms, but with paths similar to the entry above.

Daphne is a weird system.

AlCzervik

@muldjord Worked! And it looks glorious !
F453C513-0BC8-417A-8A0A-E9CB15ED3656.jpeg

muldjord

@AlCzervik Awesome! Thanks for testing

@mitu Sure is. To my knowledge it is also the only system that launches from a folder and not a file. I played a bit of Dragon's Lair 2. Damn it's hard! But it works pretty well.

Did you see my mention in https://retropie.org.uk/forum/topic/11826/versatile-c-game-scraper-skyscraper/1420 about the (soon-to-be) deprecated flags that are now moved to --flags? I can give it a go updating it myself if you like.

mitu

@muldjord said in Versatile C++ game scraper: Skyscraper:

Did you see my mention in https://retropie.org.uk/forum/topic/11826/versatile-c-game-scraper-skyscraper/1420 about the (soon-to-be) deprecated flags that are now moved to --flags? I can give it a go updating it myself if you like.

Yes, I'll have to update the script to make use of them. I wouldn't mind if you do it instead of me :), but it's no trouble.

muldjord

@mitu Great, I'll look into it at some point. But we should probably hold out on it until there's a reasonable chance that people have updated to the 3.5.x versions. Otherwise it won't work for pre-3.5.x users when the script is using the --flags options.

KN4THX

@muldjord Thank you, it seems to have been my fault but the result was strange. I failed to have the user"pass line uncommented properly so it was not detecting my thread count and said I was logged in as an anonymous user (which limited me to 1 thread).

What was weird was my scrape count kept going up in my SS account when monitoring it in real time. Not sure if that is any relevant info to you but everything works dandy now and you are much appreciated in every way. I thank you and hope you are staying safe.

muldjord

@KN4THX Hm, that makes little sense. If the entire userCreds="USER:PASS" line was commented I can't see how ScreenScraper would know it is you who is scraping. It has to have been entered somewhere, somehow. Maybe it wasn't entirely commented? I dunno. Glad you like the scraper and got it working.

muldjord

@mitu I've forked and updated the skyscraper.sh script to use the --flags FLAG1,FLAG2 format. I've also added version checks for at least 3.5 to the gathering and generating functions that will display a message in case the user needs to update. Lastly I've updated all the places where the old flags were mentioned in the help texts so they now show the new --flags versions.

Should I just create a pull request for the RetroPie-Setup project?