Jump to content
LaunchBox Community Forums

Flashpoint Importer for Launchers 0.7.5.5

   (5 reviews)

1 Screenshot

About This File

FIL (Flashpoint Importer for Launchers)

FIL is an importer tool for several launchers/frontends that allows one to add platforms and playlists from BlueMaxima's Flashpoint project to their collection. It is fully automated and only requires the user to provide the paths to their launcher and Flashpoint installs, choose which Platforms/Playlists they wish to import, and select between a few import mode options. Once the import is started the current progress is displayed and any errors that occur are shown to the user, with resolvable errors including a prompt for what the user would like to do. After the process has completed, the specified launcher can be started and the games from Flashpoint can be played like those from any other Platform.

For Platforms, the importer is capable of importing each game/animation along with any additional apps, images, and most of the metadata fields (i.e. Title, Description, etc, see below).

Function

This utility makes use of its sister project CLIFp (Command-line Interface for Flashpoint) to allow launchers to actually start and exit the games correctly. It is automatically deployed into your Flashpoint installation (updated if necessary) at the end of a successful import and the latest version of CLIFp will be included in each release of this utility so it is not generally something the end-user needs to concern themselves with.

Before making any changes to your collection, any datafiles that will be altered are automatically backed up (only one backup is maintained at once so any previous backup will be overwritten) and if any unrecoverable errors occur during the import any partial changes are reverted and the backups are restored; however, it is strongly suggested that you consider making a manual backup of your launcher's configuration to be safe. No responsibility is held for the loss of data due to use of this tool.

FIL can safely be used multiple times on the same collection to update the selected Platforms and Playlists if that have already been imported previously. The method with which to handle existing entries is selected within the program before each import.

The import time will vary, correlated with how many Platforms/Playlists you have selected, but more significantly the image mode you choose, which is expanded on later. Importing the entire collection usually takes 5-10 minutes with the recommended settings but can take longer with a more basic PC. The vast majority of the processing time is due to the plethora of images that have to be copied/symlinked when games processed so the speed of your storage device is the most significant factor. Running the importer for updates should be significantly faster it first checks to see if the source image from the new import source is actually different than your current one before copying/linking it.

You will still be able to use the standard Flashpoint launcher as normal after completing an import.

Compatability

Flashpoint Infinity/Flashpoint Ultimate
This tool was made with the express purpose of using it with Flashpoint Ultimate (i.e. all games/animations pre-downloaded), but since the 0.2 rewrite of CLIFp it should work with Infinity as well. Just note that use with Infinity is not tested as rigorously.

General

While testing for 100% compatibility is infeasible given the size of Flashpoint, OFILb was designed with full compatibility in mind.

The ":message:" feature of Flashpoint, commonly used to automatically show usage instructions for some games before they are started, is supported. The entries that use it are added as additional-apps to their respective games as they once were when Flashpoint came packaged with LaunchBox. All messages are displayed in a pop-up dialog via CLIFp.

Viewing extras (which are simply a folder) is also supported and the corresponding additional apps that open these folders will be added when importing a platform.

Since Flashpoint originally used LaunchBox as its launcher, most fields within Flashpoint have a one-to-one equivalent (or close enough equivalent) LaunchBox field. That being said there are a few fields that are unique to Flashpoint that do not have matching field and so they are simply excluded during the import, resulting in a relatively minor loss of information for each game in your collection.

Version Matching

Supported Launchers

  • LaunchBox
  • AttractMode

Flashpoint
While testing for 100% compatibility is infeasible given the size of Flashpoint, FIL was designed with full compatibility in mind.

The ":message:" feature of Flashpoint, commonly used to automatically show usage instructions for some games before they are started, is supported. The entries that use it are added as additional-apps to their respective games as they once were when Flashpoint came packaged with LaunchBox. All messages are displayed in a pop-up dialog via CLIFp.

Viewing extras (which are simply a folder) is also supported and the corresponding additional apps that open these folders will be added when importing a platform.

Each metadata field (i.e. Title, Author, etc.) is matched to the closest equivalent of a given launcher, or a custom field if there is no near equivalent and the launcher supports them; otherwise, the field will be omitted.

Both Flashpoint Ultimate and Flashpoint Infinity are supported.

Version Matching
Each release of this application targets a specific version series of BlueMaxima's Flashpoint, which are composed of a major and minor version number, and are designed to work with all Flashpoint updates within that series. For example, a FIL release that targets Flashpoint 10.1 is intended to be used with any version of flashpoint that fits the scheme 10.1.x.x, such as 10.1, 10.1.0.3, 10.1.2, etc, but not 10.2.

Using a version of FIL that does not target the version of Flashpoint you wish to use it with is highly discouraged as some features may not work correctly or at all and in some cases the utility may fail to function entirely or even damage the Flashpoint install it is used with.

Please see the project's releases page on GitHub to check which tool version targets which Flashpoint version.

Metadata Fields

Currently the following fields in LaunchBox will be populated for each game, which is limited by what is available within Flashpoint:

  • Title
  • Series
  • Developer
  • Publisher
  • Platform
  • Sort Title
  • Date Added
  • Date Modified
  • Broken Flag
  • Play Mode
  • Status
  • Notes
  • Source
  • Release Date
  • Version
  • Library
  • Language (as a Custom Field)

Usage

Please check the usage section for the tool on its GitHub page. It's easier to keep the instructions up to date when they are in one location.

If you have a bug or feature request I ask that you submit an issue on the GitHub page for this tool, but if you just want to ask a question, discuss the tool in general, or are having issues getting it working for reasons you don't think are due to a bug then please just make a post here. Since sometimes the line between the two can be blurry don't feel afraid to use the wrong system, it isn't a huge deal.

GitHub

FIL: https://github.com/oblivioncth/OFILb

CLIFp: https://github.com/oblivioncth/CLIFp

Edited by oblivioncth
Update for rebrand


What's New in Version 0.7.5.5   See changelog

Released

Fix crash during import

  • Like 12
  • Thanks 2
  • Game On 1

User Feedback

Recommended Comments



I am so happy you made this. Just added over 50k games to my setup, my wife loves you right now. Thank you for all the time and effort you put into this buddy, you da man!. 

I have an issue I thought you might be able to fix. Launchbox will not run right now due to an error that says the following: 

"A directory could not be created: F:\LaunchBox\Images\Flash\Box-3D\en; pt; zh; de; es; fr; id: it; ja; pl: nl; ru; sv

Please make sure you have proper permissions to create the folder and that the folder path is valid..."

I can confirm that I have not changed any permissions settings and that my drives are working fine. The only thing I notice is that in some cases the folders it is trying to make are showing a : instead of a ; (like in the above with id: and pl:). Not a programmer so not sure if this helps but it is all I could see.

Anyway, really appreciate your contribution, I am sure most of us will be using this one!

Link to comment
Share on other sites

37 minutes ago, cemfundog said:

I am so happy you made this. Just added over 50k games to my setup, my wife loves you right now. Thank you for all the time and effort you put into this buddy, you da man!. 

I have an issue I thought you might be able to fix. Launchbox will not run right now due to an error that says the following: 

"A directory could not be created: F:\LaunchBox\Images\Flash\Box-3D\en; pt; zh; de; es; fr; id: it; ja; pl: nl; ru; sv

Please make sure you have proper permissions to create the folder and that the folder path is valid..."

I can confirm that I have not changed any permissions settings and that my drives are working fine. The only thing I notice is that in some cases the folders it is trying to make are showing a : instead of a ; (like in the above with id: and pl:). Not a programmer so not sure if this helps but it is all I could see.

Anyway, really appreciate your contribution, I am sure most of us will be using this one!

Sure thing. Flashpoint is one of those up and coming major collections (like MAME, SCUMMVM, etc) so it would be a shame for people to not be able to use it in LaunchBox, especially since the metadata for it is so similar since it was derived from LB.

As for the issue, definitely a bit strange but hopefully we can figure it out. The error is ultimately happening because ":" is not allowed in folder or file names and it is trying to create them because of how I transferred the FP Language entry into the Region field of LB. What is a bit confusing though is I don't know why it is touching the Box-3D folder as I only add images to Box - Front and Screenshot - Gameplay. Stranger yet, I don't remember ever seeing this error during testing.

What this probably means is that there are some typos in the FP database where game curators meant to use a semi-colon but accidentally used a colon. I can simply add code to make sure that any colons found are swapped with semi-colons; however, it makes me wonder if I should change my approach for that field since in LB it is generally a single entry field. Perhaps having only the first language listed as the "Region". I'm not sure and will think on it a bit.

Otherwise, I could use some helpful details:

  • LaunchBox version
  • Flashpoint version
  • Which Platforms you selected for import
36 minutes ago, cemfundog said:

Whoops, forgot to mention that my set up has only 4 of the platform options offered in your importer.

Do you mean that when you use the importer you only see 4 Platforms to select from? Or you're just saying that you only chose 4 of the whole list?

  • Like 1
Link to comment
Share on other sites

6 minutes ago, oblivioncth said:

Sure thing. Flashpoint is one of those up and coming major collections (like MAME, SCUMMVM, etc) so it would be a shame for people to not be able to use it in LaunchBox, especially since the metadata for it is so similar since it was derived from LB.

As for the issue, definitely a bit strange but hopefully we can figure it out. The error is ultimately happening because ":" is not allowed in folder or file names and it is trying to create them because of how I transferred the FP Language entry into the Region field of LB. What is a bit confusing though is I don't know why it is touching the Box-3D folder as I only add images to Box - Front and Screenshot - Gameplay. Stranger yet, I don't remember ever seeing this error during testing.

What this probably means is that there are some typos in the FP database where game curators meant to use a semi-colon but accidentally used a colon. I can simply add code to make sure that any colons found are swapped with semi-colons; however, it makes me wonder if I should change my approach for that field since in LB it is generally a single entry field. Perhaps having only the first language listed as the "Region". I'm not sure and will think on it a bit.

Otherwise, I could use some helpful details:

  • LaunchBox version
  • Flashpoint version
  • Which Platforms you selected for import

Do you mean that when you use the importer you only see 4 Platforms to select from? Or you're just saying that you only chose 4 of the whole list?

Thank you for helping out!

My set up is as follows:

  • LB version is 11.5 Beta 1
  • FP version is Ultimate 8.2
  • I selected Flash, Java, HTML5, Shockwave and Unity

What I meant was that when I use the importer I see all platforms but only selected the above.

Hope this helps and again thank you!

Link to comment
Share on other sites

Ah alright.

As I noted in the description above FP 8.2 isn't officially supported yet because I haven't checked it to see if changes to this importer are needed, which based on this issue you are having I'm guessing there are (probably new games added that have the colon typos). I also have not updated to LB 11.5 Beta 1 yet so I'm guessing there was a behavior change where it tries to create the region folders under all image sub-folders, including Box3D.

I did happen to just finish extracting FP 8.2 on my local machine so while I understand what the issue here is already I'll try it out myself to ensure I can re-create the issue and then implement a fix along with any other changes that are needed for proper 8.2 support. Once the new version is out you should be able to just redo the import with it and the problem will be gone. If you want to be extra sure that the changes take effect you could delete the Flash, Java, HTML5, Shockwave, and Unity platform .xmls and sub-folders within Images (essentially removing everything the importer added) before doing the import again.

The fix shouldn't take too long to get out, though I am juggling a few things at the moment so I can't give an exact estimate, though it's possible it could be by the end of the day depending on how the other things go.

  • Like 1
Link to comment
Share on other sites

2 minutes ago, oblivioncth said:

Ah alright.

As I noted in the description above FP 8.2 isn't officially supported yet because I haven't checked it to see if changes to this importer are needed, which based on this issue you are having I'm guessing there are (probably new games added that have the colon typos). I also have not updated to LB 11.5 Beta 1 yet so I'm guessing there was a behavior change where it tries to create the region folders under all image sub-folders, including Box3D.

I did happen to just finish extracting FP 8.2 on my local machine so while I understand what the issue here is already I'll try it out myself to ensure I can re-create the issue and then implement a fix along with any other changes that are needed for proper 8.2 support. Once the new version is out you should be able to just redo the import with it and the problem will be gone. If you want to be extra sure that the changes take effect you could delete the Flash, Java, HTML5, Shockwave, and Unity platform .xmls and sub-folders within Images (essentially removing everything the importer added) before doing the import again.

The fix shouldn't take too long to get out, though I am juggling a few things at the moment so I can't give an exact estimate, though it's possible it could be by the end of the day depending on how the other things go.

Sounds great! I will do exactly as you have suggested and I am in no rush so I will sit tight and wait for your next release. Let me know if there is anything else I can offer to help troubleshoot. I am working but I work from home so I might be able to respond pretty quickly. Thanks again man!

  • Like 1
Link to comment
Share on other sites

2 hours ago, cemfundog said:

Sounds great! I will do exactly as you have suggested and I am in no rush so I will sit tight and wait for your next release. Let me know if there is anything else I can offer to help troubleshoot. I am working but I work from home so I might be able to respond pretty quickly. Thanks again man!

Just curious, did you get the warning message and yellow exclamation about a possible compatibility issue in regards to FP 8.2 when you selected it in the importer? Np if you did and just ignored it, I just want to make sure it is working correctly for others.

Link to comment
Share on other sites

2 minutes ago, oblivioncth said:

Just curious, did you get the warning message and yellow exclamation about a possible compatibility issue in regards to FP 8.2 when you selected it in the importer? Np if you did and just ignored it, I just want to make sure it is working correctly for others.

Yes I did. And I read the instructions before hand and noticed that you had mentioned that potential problem but figured might as well try it. 

Link to comment
Share on other sites

Just now, cemfundog said:

Yes I did. And I read the instructions before hand and noticed that you had mentioned that potential problem but figured might as well try it. 

Yup, as I said its no problem, just would prefer an immediate heads up that your issue was due to use with a newer unsupported version next time ;)

  • Like 1
Link to comment
Share on other sites

19 hours ago, oblivioncth said:

@cemfundog Give'er a roll and let me know if you run into any other issues.

Got it and it is working great, thanks for the update buddy. This is awesome. So many new games and so easy to import.

Link to comment
Share on other sites

Very cool! The Platform import works perfectly, but I'm not seeing any Playlists (I selected all). For troubleshooting, I even installed a brand new version of LaunchBox 11.4 and ran OFILb with all Platforms/Playlists selected, but still only the Platforms were imported. I'm not seeing any .xml files created in Data\Playlists either. I also tried running it a second time but still no luck. Any ideas? (Running LB 11.4 and FP 8.2)

Thanks for a great program!

Link to comment
Share on other sites

46 minutes ago, bcpenney said:

Very cool! The Platform import works perfectly, but I'm not seeing any Playlists (I selected all). For troubleshooting, I even installed a brand new version of LaunchBox 11.4 and ran OFILb with all Platforms/Playlists selected, but still only the Platforms were imported. I'm not seeing any .xml files created in Data\Playlists either. I also tried running it a second time but still no luck. Any ideas? (Running LB 11.4 and FP 8.2)

Thanks for a great program!

Possible I broke something by accident or another oddity. Ill check it out, I'm particularly busy at the moment but I'll get to it as soon as I can.

Link to comment
Share on other sites

I just finished a major rewrite of ClIFp that should make it very rarely require updates.

I also just submitted a few changes for Qt (a major library this program uses) regarding two bugs/oversights that required me to use a workaround in this program (though it will be quite some time before they are integrated into the next release of Qt).

Now that those are both done my next priority is the Playlists issue.

Link to comment
Share on other sites

On 9/3/2020 at 6:16 PM, bcpenney said:

Very cool! The Platform import works perfectly, but I'm not seeing any Playlists (I selected all). For troubleshooting, I even installed a brand new version of LaunchBox 11.4 and ran OFILb with all Platforms/Playlists selected, but still only the Platforms were imported. I'm not seeing any .xml files created in Data\Playlists either. I also tried running it a second time but still no luck. Any ideas? (Running LB 11.4 and FP 8.2)

Thanks for a great program!

Ok sorry for the wait, I ended up working with the Flashpoint devs to heavily improve the functionality of CLIFp (the underlying program that lets the games run from LaunchBox) for longer than I initially thought.

The playlist issues has been fixed in 0.1.2 which I just uploaded.

Link to comment
Share on other sites

New version 0.1.2 tested and working with LB 11.5 (just released today). I can see all the playlists now. Thank you so much for this! (NOTE: new version 0.1.2 is posted at the bottom of the page. It's not available from the red "Download this file" button at the top.)

Link to comment
Share on other sites

1 hour ago, bcpenney said:

New version 0.1.2 tested and working with LB 11.5 (just released today). I can see all the playlists now. Thank you so much for this! (NOTE: new version 0.1.2 is posted at the bottom of the page. It's not available from the red "Download this file" button at the top.)

Woops. Thanks for the catch.

EDIT:

After responding to this comment I just caught that Rodrick had edited his review to point out another small issue with the game description's not getting carried over correctly (see patch notes). So when you feel like it you'll want to grab 0.1.2.1 and re-do the import to get all of the descriptions that are available.

Edited by oblivioncth
Link to comment
Share on other sites

Hey oblivion, thanks for the great plugin. 2 quick questions.

There doesn't seem to be a checkbox for when the option to Turn off "Extreme" games is clicked. I don't think there's a way for the end user to know if the option is checked or not.

I also tried the tool with Infinity 8.2. However the program is giving me an error saying there isn't a valid FP install, or the version won't work with the tool. Does it need to be pointed to a different location if using Infinity?

Link to comment
Share on other sites

Gave 0.1.2 a try with infinity, and it gives the error about potentially being the wrong install but compatible file structure. For now that seems to be the best option for the latest version of infinity.

Link to comment
Share on other sites

4 hours ago, TheNewClassics said:

Gave 0.1.2 a try with infinity, and it gives the error about potentially being the wrong install but compatible file structure. For now that seems to be the best option for the latest version of infinity.

Sorry I missed your first post.

For the extreme games, there is no check box but there is a check, if you click the option and then return to the menu it will be blue with a checkbox next to the entry. This is because of a limitation with the menu setup I'm using. Eventually I may try to work out something a little more obvious.

As for the issue you were reporting thats interesting. I did test this on 8.2 Infinity and didn't have that issue, I'm wondering if something about your install was changed slightly or if maybe something broke in the last update.

You're most likely fine to use it as is but I'll look into the issue. May need to ask you some questions about your install. Regardless 9.0 is out now so I'm going to release an update for that version. I may release a second build that's fixed for 8.2 if I did screw something up.

Link to comment
Share on other sites

On 11/20/2020 at 1:23 PM, TheNewClassics said:

Sounds good, thanks for the great plugin Oblivion.

Ok the update is available, though it is specifically for 9.0 and wont work with 8.2 due to changes in FPs setup.

It turns out the error you were seeing was due to a small change I made in the previous patch (0.1.2.1) that improved accuracy in determining the integrity/compatibility of your selected Flashpoint install. I hadn't accounted for a small detail that is different between the Ultimate and Infinity builds and was testing on a copy of Ultimate at that time, so this caused all builds of Infinity to incorrectly be marked as invalid. This has been remedied for 9.0 so that both work.

Since it is just a false-positive, you can continue to use the 0.1.2 build with 8.2 without issue, though the game descriptions won't be imported correctly as noted in the changelog of 0.1.2.1. Assuming you want to use Infinity I don't see why upgrading would be an issue though.

  • Thanks 1
Link to comment
Share on other sites

Works well, thanks oblivion. General question: for Infinity specifically, is the plugin supposed to import every game for a platform, or just the games installed? I just had one Flash game installed, and it imported the entire Flash platform. That's probably how it's supposed to work, but figured I'd check with you. Thanks again

Link to comment
Share on other sites

11 minutes ago, TheNewClassics said:

Works well, thanks oblivion. General question: for Infinity specifically, is the plugin supposed to import every game for a platform, or just the games installed? I just had one Flash game installed, and it imported the entire Flash platform. That's probably how it's supposed to work, but figured I'd check with you. Thanks again

Yes, it is supposed to work this way. You can even start a game you haven't played yet through LaunchBox and it will download it all the same. The only caveat is that the images for the games can only be downloaded through Flashpoint so if you haven't at least seen the game once in FP yet it still be playable but it will be missing its images. You would have to rerun the importer after the image is added in Flashpoint for it to appear in LB.

If you want only a subset of game's to be imported, like only those you've played so far, you could try to create a Playlist of those games and then import that in addition to the platforms its comprised of.

Someone else asked for a way to only import downloaded games, but I'm not sure yet if there's a way to distinguish them reliably. I'd guess there is but I just haven't checked yet. I'm going to look into it at some point.

Link to comment
Share on other sites


Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Unfortunately, your content contains terms that we do not allow. Please edit your content to remove the highlighted words below.
Add a comment...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

×
×
  • Create New...