Testing Patches

You can use the Patcher apply command to try applying a patch via the console app:

• root: root path of the application that is to be updated (application directory)
• versionURL: download URL of the VersionInfo.info
• dontUseIncrementalPatch: (optional)(flag) SimplePatchTool will not apply incremental patches
• dontUseRepairPatch: (optional)(flag) SimplePatchTool will not apply repair patch
• dontUseInstallerPatch: (optional)(flag) SimplePatchTool will not apply installer patch
• verifyFiles: (optional)(flag) files on the server will be verified
• silent: (optional)(flag) progress will not be logged to console
• versionInfoKey: (optional) if you've signed VersionInfo.info with a private RSA key, then pass the path of the public RSA key here
• patchInfoKey: (optional) if you've signed PatchInfo.info with a private RSA key, then pass the path of the public RSA key here

Example: Patcher apply -root="C:\App v1.1" -versionURL="https://www.myserver.com/PatchFiles/VersionInfo.info"

To check for updates only, use the Patcher check_updates command. In addition to root, versionURL, silent and versionInfoKey arguments mentioned above, it can take the following argument:

• checkVersionOnly: (optional)(flag) when enabled, only the version number of the application is compared against the VersionInfo to see if there is an update. Otherwise, hashes and sizes of the files in the application directory are compared against VersionInfo (i.e. verifying integrity of files)

Example: Patcher check_updates -root="C:\App v1.1" -versionURL="https://www.myserver.com/PatchFiles/VersionInfo.info"

Currently, it is not possible to test self patching via the console app.

Testing on local file system

After creating a patch, you can quickly test it via the console app or Unity plugin without having to upload the files to a server first:

• simply assign the PatchFiles (or Output) directory to VersionInfo.info's BaseDownloadURL: <BaseDownloadURL>file://C:\Users\USERNAME\Desktop\Project\Output\</BaseDownloadURL> (notice how the path ends with a path separator char)(don't forget to revert its value afterwards)
• use file://C:\Users\USERNAME\Desktop\Project\Output\VersionInfo.info as the versionURL while testing the patch
  • console app: Patcher apply -root="C:\Users\USERNAME\Desktop\PatchTest" -versionURL="file://C:\Users\USERNAME\Desktop\Project\Output\VersionInfo.info"
  • Unity plugin: open the PatcherControlPanelDemo scene, enter Play mode, fill the required fields and hit PATCH!