Sega Saturn Patcher 1.91 BETA

Sega Saturn Patcher V1.91 (Beta for 2.0)

(C) 2021 Knight0fDragon - Knight0fDragon@gmail.com

If you would like to say thanks and offer a donation, I accept only PayPal
at knight0fdragon@gmail.com

Thanks to everybody over at SegaXtreme and Sega Saturn Shiro, along
with various people communicating with me on the side,
working out all of the kinks with this program.

Special thanks to dibz' and the rest of SegaXtreme.net for providing a home for resources and access to the API.
Special thanks to SEGA RPG FAN for his research and development into the XBand driver patches.
Special thanks to TrekkiesUnite118 for his extensive testing with the patcher.
Special thanks to privateeye for his extensive testing with the patcher.

Thank you for using this patcher, and happy gaming.

You can find me hanging out in the following Discord channels:

Join the SegaXtreme Discord Server! Sega Xtreme
Join the SEGA SATURN, SHIRO! Discord Server! Sega Saturn Shiro
Join the Shining Force 3 Discord Server! My Shining Force 3 Discord




-------------------------------------------------------
Licence
-------------------------------------------------------

This program is provided free of charge for non commercial use
and is to be used at your own risk.
Knight0fDragon nor patch creators will be held responsible for any loss
of data or damage incurred during processing.

-------------------------------------------------------
Requirements
-------------------------------------------------------

Sega Saturn Patcher requires .NET 5.0 Desktop Runtimes.
If it is not included, the app will prompt you to install it.
It could also be dowbnloaded at Download .NET 5.0 (Linux, macOS, and Windows)

-------------------------------------------------------
Troubleshooting
-------------------------------------------------------
1)Continuous prompting of .NET Runtime install.
Run the following command in command prompt: dotnet --list-runtimes
If only Microsoft.WindowsDesktop.App 5.#.# does not exist, install the desktop runtime above.
If Microsoft.NETCore.App 5.#.# does not exist, install the full runtime above.

-------------------------------------------------------
What is new?
-------------------------------------------------------

Patcher has been rebuild from the ground up.

CDs and Images have wrappers written to now treat them as the same thing, so compatabilitiy issues should no longer be a problem.

New features to be available in 2.0.

Command line support.

Patchers will now work with command line arguments for batch processing (commands below.)
The GUI version does not output text to console, so a seperate CLR app will be made available if output is needed.

Meta data can now be included in the patch. This can be used by developers to provide technical information about their patch.
Hopefully this will be used to provide patch updates.

Read me. Developers can now include important notes and information they want users to read.

SSCD Image (previously SSG)fomat now exists. It is a cd image format that uses compression, as well as allows for meta data to be added.

UI also exists to create SSCD.

More intuitive UI. The UI provides more information a person may want, as well as makes it easier to create or use patches.

Settings. You can now customize the experience of the program.

Cheat Detection removal patch. Will remove Action replay blocking methods in games. (Known in Panzer Dragoon Saga)

XBand Patch. Add custom XBand/Netlink patches to applicable games. Needs to be added via Settings.

Pseudo Kai Fast Boot patch. If you are a Pseudo Kai user, you can apply this patch to skip the second Sega authorization check.

Application is now resizeable.

Command line can be used to create CD image formats.

This feature will allow for homebrew developers to generate more accurate CD images.

-------------------------------------------------------
XBand Driver Setup
-------------------------------------------------------
Sega Saturn Patcher does not include custom drivers currently due to copyright issues.

Just place the files that need patching into a zip file, and assign the file to SSP in the settings.

There are 2 different drivers that need to be added depending on the online play available.

Netlink(USA games) Drivers use the USXBandPatchZipFile setting.
SegaNet(Japan games) Drivers use the JPXBandPatchZipFile setting.


Files to patch SegaNet games (Japan) to allow for Netplay can be found the SEGA DTS CD (Nov 1996).
The minimum files required are LOADER.BIN, XBAND.BIN, and XBLIBUS.BIN.
These files do not need to be renamed or placed into any folders.

Other drivers exist created by SEGA RPG FAN that tweek the initialize strings for better performance on VoIP devices.


-------------------------------------------------------
Adding update information and urls
-------------------------------------------------------
SSP uses REST to grab data from a server.
All you simply need to do is provide a URL to grab the JSON object (JSONURL)
and provide and API key if applicalble (APIKey).

The JSON itself follows a simple structure:

{
"resource":{
"version":<string>
}
"errors": [
{
"code": <string>,
"message": <string>,
}
]
}

Other tags can be added, it will be simply ignored.

-------------------------------------------------------
Linking with SegaXtreme
-------------------------------------------------------
SSP is built to work with the SegaXtreme resource page.

To include your patch at SegaXtreme, go and set up an account if applicable.

Head over to the resources page, and click on Add Resource.

Fill out the form, but do not add your file yet.

After sumbmitted, look at the URL to get your app ID.

The format will look like this Resources<Title>.<ID>/

Go into the Edit META of your SSCD or SSP, and look for the key JSONURL.

Add the following URL https://segaxtreme.net/api/resources/<ID>/ where <ID> is the ID number from your URL.

Do not worry about the APIKey, this will be provided for you.

Press the Test JSON URL button to ensure it worked.

Save your SSP.

Congratulations. This SSP will now notify users if they are using an older version of your patch.

Note* Resources may need to be approved by admins prior to the test working.

-------------------------------------------------------
Command line arguments
-------------------------------------------------------

=General options=
-help Lists help. Also /h, -h, --h, /help, --help , /?, -?, --?
-imagetype <type> Image type output format. Valid choices:bin,iso,ccd,sscd.
-o <name> Outut name for CD Image.
-quiet Do not display any console output.
-multitrack Export tracks as separate files (if applicable.)
-meta <string> Meta data for SSCD format
-readme <string> Readme text for SSCD format


Additional options depending on task.
Do not mix patching options with generation.


=CD Patching options=


-cheat-check-defeat Apply cheat check defeat patch
-drive <letter> Letter of CD Drive to patch.
-extract <path> Extracts selected drive or image to path.
-fast-boot Apply fast boot patch
-patch <filename> SSP file to apply to game.
-image <filename> CD Image to patch.
-region-free Apply region free patch


=CD Image generation options=


-audiotracks <filename>,<filename2>,... Add audio tracks to image.
-appid <string> Application ID
-abstract <filename> ABSTRACT file.
-biblio <filename> BIBLIOGRAPHY file.
-cdda Generate CDDA files in CD Image. Format is CDDA#, where # is Track #.
-copyright <filename> COPYRIGHT file.
-generic-boot <filename See -ipbin
-i <foldername> Folder of files to create CD Image.
-ipbin <filename> Binary file that fills first 16 Sectors of CD Image.
-preparer <string> Preparer ID.
-publisher <string> Publisher ID.
-shortname Omit ;1 from filename
-sort <filename> Directory and file order sheet.
-sysid <string> System ID.
-volid <string> Volume ID.
-volset <string> Volume Set ID.

Sega Saturn Patcher V1.9 (Beta for 2.0)

(C) 2021 Knight0fDragon - Knight0fDragon@gmail.com

If you would like to say thanks and offer a donation, I accept only PayPal
at knight0fdragon@gmail.com

Special thanks to everybody over at SegaXtreme and Sega Saturn Shiro, along
with various people communicating with me on the side,
working out all of the kinks with this program.

Thank you for using this patcher, and happy gaming.

You can find me hanging out in the following Discord channels:

Join the SegaXtreme Discord Server! Sega Xtreme
Join the SEGA SATURN, SHIRO! Discord Server! Sega Saturn Shiro
Join the Shining Force 3 Discord Server! My Shining Force 3 Discord


---Licence---
This program is provided free of charge for non commercial use
and is to be used at your own risk.
Knight0fDragon nor patch creators will be held responsible for any loss
of data or damage incurred during processing.


Patcher has been rebuild from the ground up.

CDs and Images have wrappers written to now treat them as the same thing, so compatabilitiy issues should no longer be a problem.

New features to be available in 2.0.

Command line support.

Patchers will now work with command line arguments for batch processing (commands below.)
The GUI version does not output text to console, so a seperate CLR app will be made available if output is needed.

Meta data can now be included in the patch. This can be used by developers to provide technical information about their patch.
Hopefully this will be used to provide patch updates.

Read me. Developers can now include important notes and information they want users to read.

SSCD Image (previously SSG)fomat now exists. It is a cd image format that uses compression, as well as allows for meta data to be added.

UI also exists to create SSCD.

More intuitive UI. The UI provides more information a person may want, as well as makes it easier to create or use patches.

Settings. You can now customize the experience of the program.

Cheat Detection removal patch. Will remove Action replay blocking methods in games. (Known in Panzer Dragoon Saga)

Pseudo Kai Fast Boot patch. If you are a Pseudo Kai Cartridge user, you can apply this patch to skip the second Sega authorization check.

Application is now resizeable.

Command line can be used to create CD image formats.

This feature will allow for homebrew developers to generate more accurate CD images.

Command line arguments:

=General options=
-help Lists help. Also /h, -h, --h, /help, --help , /?, -?, --?
-imagetype <type> Image type output format. Valid choices:bin,iso,ccd,sscd.
-o <name> Outut name for CD Image.
-quiet Do not display any console output.
-multitrack Export tracks as separate files (if applicable.)
-meta <string> Meta data for SSCD format
-readme <string> Readme text for SSCD format


Additional options depending on task.
Do not mix patching options with generation.


=CD Patching options=


-cheat-check-defeat Apply cheat check defeat patch
-drive <letter> Letter of CD Drive to patch.
-extract <path> Extracts selected drive or image to path.
-fast-boot Apply fast boot patch
-patch <filename> SSP file to apply to game.
-image <filename> CD Image to patch.
-region-free Apply region free patch


=CD Image generation options=


-audiotracks <filename>,<filename2>,... Add audio tracks to image.
-appid <string> Application ID
-abstract <filename> ABSTRACT file.
-biblio <filename> BIBLIOGRAPHY file.
-cdda Generate CDDA files in CD Image. Format is CDDA#, where # is Track #.
-copyright <filename> COPYRIGHT file.
-generic-boot <filename See -ipbin
-i <foldername> Folder of files to create CD Image.
-ipbin <filename> Binary file that fills first 16 Sectors of CD Image.
-preparer <string> Preparer ID.
-publisher <string> Publisher ID.
-shortname Omit ;1 from filename
-sort <filename> Directory and file order sheet.
-sysid <string> System ID.
-volid <string> Volume ID.
-volset <string> Volume Set ID.

When using a single file bin image, the CUE sheet may contain obscure terms. This update handles some of those terms.

Adds support for DragonBall Z legends

Fix reading CCD

Fixes issues with Audio tracks for Bulk Slash and Cotton 2

If a game had a file with a name like BG.txt and TitleBG.txt. the patch would pull an archive for BG.txt if only TitleBG.txt was in the patch, causing it to crash.

New to V1.1

Patches made with V1.1 will not be supported in V1.0.

V1.1 is however backwards compatable with V1.0 patches.

1) Multiple CD support is now added.

To use, first create a patch with files to CD 1.
Click Build Disc # Patch button and save.

Repeat process for every additional disc.

End with loading in disc 1, and creating a patch containing all community files.

Then drag in the specific CD patches and build your patch normally.

There is a version feature that works in a similar way if you need to build a patch for a specific version.

Do not worry about containing different copies of the same file through out all of the different patches.

The patcher has a priority order when determining which file to use.

The file with the utmost priority is a Version.SSP located inside of a CD.SSP.
Then the CD.SSP has the next highest priorty.
The Version.SSP has the second lowest priority.
Finally the base SSP has the least priority.

2) New Delta algorithm used.

The files are now based on BSS Diff

3) Ability to export IPBin when creating a patcher

4) Ability to open CCD images.

Some machines were getting a stream length issue when building MPEG titles, this update fixes that issue.

Fixed a bug where if a change file was larger, it would not patch the extra bytes.