Jump to content
LaunchBox Community Forums

LaunchBox ROM Patch Manager 0.0.4

   (2 reviews)

5 Screenshots

About This File

LaunchBox ROM Patch Manager
LaunchBox ROM Patch Manager is a plug-in for LaunchBox that intends to streamline the process of applying a patch to a ROM file and importing the patched ROM into your LaunchBox library

Demo
https://www.youtube.com/watch?v=WFBjIEwC-v4

Installation

  1. Download LaunchBoxRomPatchManager.zip
  2. Extract LaunchBoxRomPatchManager.zip to a folder.  Inside the LaunchBoxRomPatchManager folder is a folder called LaunchBox. Inside the LaunchBox folder will be two folders: LaunchBoxRomPatchManager and Plugins. Copy these two folders.
  3. Go to your LaunchBox installation folder and paste the copied folders

Included Patchers - Floating IPS
The plug-in includes Floating IPS by Alcaro to be used as IPS patcher. This patcher should be automatically included when following the installation instructions and can be found in your LaunchBox folder under LaunchBoxRomPatchManager\Patchers. By default, the plugin will be configured to use Floating IPS to patch games for the following platforms:

  • Nintendo Entertainment System
  • Nintendo Game Boy Advance
  • Nintendo Game Boy Color
  • Nintendo 64
  • Super Nintendo Entertainment System
  • Sega Genesis
  • Sega 32X
  • NEC TurboGrafx-16

Included Patchers - Paradox PPF
The plug-in includes Paradox PPF 3 by Icarus of Paradox to be used as a PPF patcher. This patcher should be automatically included when following the installation instructions and can be found in your LaunchBox folder under LaunchBoxRomPatchManager\Patchers. By default, the plugin will be configured to use Paradox PPF to patch games for the following platforms:

  • Sony Playstation
  • Sony PSP

Managing ROM Patchers
The plug-in includes a menu item called "Manage ROM Patchers" under the LaunchBox Tools menu. The plug-in uses these configurations when applying a patch to a game.

  • Name - Specify a name for the patcher
  • File path - Specify the path to the patcher
  • Command line - Specify the format of the command line that should be used when applying a patch to a game file. There are two special values that need to be included in the command line field for the plug-in to know how to apply a patch to a game file. {patch} indicates the patch file and {rom} indicates the game's rom file.
  • Platforms - Select the platforms that the patcher can be used with

Importing a ROM Hack
The plug-in includes a menu item called "Import ROM Hack" when you right click on a game. To import a rom hack, right click on a game and select "Import ROM Hack". A file dialog will open prompting to select a patch file. Select the file that contains the patch file. The "Import rom hack" screen will be displayed with information about the selected game and selected patch file. Enter values for the imported ROM hack as desired and click OK. The plug-in will make a copy of the source game, extract files as needed, apply the selected patch file to the source ROM file, and import the game into your LaunchBox library.

Source code

https://github.com/AtomFry/LaunchBoxRomPatchManager

Edited by Fry


What's New in Version 0.0.4   See changelog

Released

Minor fixes to remove security vulnerabilities found in dependencies 

  • Like 4
  • Game On 1
  • Unusual Gem 2

User Feedback

Recommended Comments

Thanks @Retro_Rage @Wally

Please let me know if you run into any problems or have ideas for new features. A few enhancements I’m thinking about for this plugin:

Option to patch an additional app

Patches often need to be applied to a specific version of a game. LaunchBox can combine different revisions of games into one game where the game points to the default revision and additional revisions of the same game are added to the game as additional apps. It would be nice to be able to select from the additional apps if you need to patch one of the revisions instead of the default rom. 
 

Option to add patched the game as an additional app

An option on the import rom hack screen that would allow you to specify if the new patched game should be added as a new game (current behavior) or if the game should be added as an additional app to the source game. 

Search/Download
This one, I’m not sure if/when it will ever happen but long term hope is to provide the ability to search and download rom hacks directly from the plugin. 

Edited by Fry
Link to comment
Share on other sites

56 minutes ago, Mongu said:

The patchs are downnloaded of Romhaking?

Yes I mostly download patches from romhacking.net. You could also get them from other places like smwcentral or anywhere that you can find IPS or PPF patches. 

Link to comment
Share on other sites

I went a bit off specs:

Tried to patch Golden Axe (Master System) with a fresh bps patch.

https://www.smspower.org/forums/18151-SMSGoldenAxeTyrisFlareEditionROMHack

It did patch it, created the file as well but it semi-destroyed my Platforms: Only half of them were visible. Master System along with others just disappeared from Launchbox.

Fortunately Launchbox has the awesome backup feature of the XMLs and got everything restored back.

Link to comment
Share on other sites

Oh god that’s horrible. Did you see any error in the log?  Really sorry to hear about that. I would like to try to reproduce this issue and figure out what happened. I don’t play master system so I’ll need to set that up. I’m glad you were able to use a backup of your data file to resolve this 

Link to comment
Share on other sites

Dont be. Your plugin is very useful!

I noted that I went a bit out of specs.

What can I post so I can help you debug?

  • Thanks 1
Link to comment
Share on other sites

1 hour ago, Wally said:

What can I post so I can help you debug?

There should be a LaunchBoxRomPatchManager folder in your LaunchBox folder and in there any errors would be logged to the log.txt file. Could you check if there is anything in there and if so send it to me?  Also do you by chance have the bad data file where your platforms got messed up?  If so I would love to take a look at that. And if possible could you send me your good data file so I can see how you have stuff setup, if anything sticks out to me?  
 

lastly, when you say you went out of specs, what do you mean by that exactly?  I wasn’t clear on what you did there. 

Link to comment
Share on other sites

The log is empty:

Log Entry : 12:06:12 μμ Κυριακή, 30 Ιανουαρίου 2022
  :Output length: 37
-------------------------------

Out of specs:I mean that I used a bps (not ips) in a platform that you have not listed.

Link to comment
Share on other sites

I see. Bps files should be fine with floating IPS patcher and sega master system roms shouldn’t be a problem to patch either. I am curious why your log file seems to have an entry in it but no log message. Normally if there is a log entry, there would be something written in there. 

 

Would you be able to share your data file?  I’d like to confirm the data you have for golden axe in sms and try to reproduce the issue. 

Link to comment
Share on other sites

7 hours ago, ARandomMastodon said:

Any chance we could get included xdelta support?

Could you point me to an xdelta patch or two that I can use to test with?  It is possible we can get it to work without any code change by adding the xdelta patcher to the patchers list with the right command line arguments. It is also possible a code change would be needed to support the xdelta command line arguments. I’d like to test but all the rom hacks I ever tried use ips, bps, or PPF format. If you can link me some xdelta examples, I’ll test it out and report back. 

Edited by Fry
Link to comment
Share on other sites

@ARandomMastodon I think it'll work fine out of the box.  To use xdelta, you can download it and place it in the LaunchBox\LaunchBoxRomPatchManager\Patchers folder like this: 

image.thumb.png.d7795828a3f999c61fa90dc6e6979b5a.png

Then you need to add the patcher in LaunchBox under Tools > Manage ROM patchers with the command line -f -q -d -s {rom} {patch}

like this: 

image.thumb.png.1ec928491a5c23ecd297871a70e15d50.png

I associated it with Nintendo DS to test the ROM hacks you mentioned.  

Then you can import the rom hack by right clicking a game and Import ROM Hack.  It doesn't default the patch (I could add a small code change to have it look for xdelta files) but you can manually pick the xdelta file like shown here: 

image.thumb.png.c9bd0a3de8aed91d4daf7595162e5d94.png

It was able to successfully patch the game and add the hack.  

 

Edited by Fry
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...