Unity Custom Patcher

Patcher is the first thing your player sees when he wants to play the game. It downloads your game when launched for the first time, and it updates it automatically whenever a new version is available.

Example patcher

It’s an essential thing for you to be able to customize the patcher in any way required. That’s why PatchKit Patcher is available for anyone to download and customize at will.

Before you start

Before you start using your patcher, you first have to create your account and set up your game. You may find out how to do that in Getting Started page. As soon as you did that, please proceed further.

Getting hands on the project

Currently PatchKit Patcher is a Unity project. It means that you are required to have at least fundamental Unity and Unity UI knowledge.

You can get the project source files from GitHub.

The project has been created and tested with Unity 5.3.4. We highly recommend using that particular version too. You can get it through Unity Archive. If you have a newer Unity version installed, you don’t have to uninstall it, follow these instructions.

Making changes

Basic look & feel

Before starting customization of your patcher, make sure to make a copy of the Patcher scene and do all the modifications on that new scene. If you modify the supplied scene, any asset upgrade overwrites your changes!

The patcher layout is done entirely in Unity UI. Feel free to change it however you want, but make sure to keep all the attached scripts in place.

Changing the window size

If you’d like to change the window size, you should update it in Player Settings, Resolution and Presentation, Default Screen Width/Height.

Building

The patcher can be built the same way as any other Unity project:

  1. Open File / Build Settings from the main menu.
  2. Choose PC, Mac & Linux Standalone as a Platform.
  3. Choose your Target Platform and Architecture. IMPORTANT: For Mac, you have to choose x86_64 as Architecture. 1
  4. Make sure that Development Build is turned off.
  5. Click on the Build button and choose your target build location.

1 - If you do otherwise, the patcher may crash shortly after the start, or it won’t work correctly.

It’s not important how you name your executable. Information about it is stored in patcher.manifest file.s

Uploading

Now when you have your new patcher built, you have to upload it to your PatchKit account.

  1. Navigate to publisher panel applications page.
  2. Click the New Patcher button.
  3. In the new application form, name your patcher (e.g.,My Patcher Windows 64) and click the Create button. Shortly after you should be able to see your new application.
  4. Now click the New Version button.
  5. Edit the new version Label to, let’s say, 1.0.
  6. Click the Upload Content button.
  7. Compress the directory of your patcher into the zip file. Make sure that the patcher.manifest file can be found next to the patcher executable.
  8. Choose that newly created zip file as your application content.
  9. Wait for the upload and version processing to finish.
  10. If there are no errors, click the Publish button.
  11. After the version is published, navigate to your game’s page.
  12. Inside Configuration panel look for Custom Patcher field. Click on the Edit button right next to it.
  13. From the drop-down select your new patcher.
  14. Click on the Save button.

From now on your new application is using your custom patcher instead of the default one.

Updating

Unity Patcher will be getting updates from time to time introducing new features and bug fixes. If you’re using a custom patcher make sure to either:

Some releases may include migration guidelines since new changes can break yours.

Updating custom patcher is the same process as updating every application - you need to upload a new version to your patcher application and publish it. Old patcher versions are replaced by the new version on the next start of the launcher.

Troubleshooting

The patcher crashes right away

First look into the logs. A significant error message should be at the end of it. Usually, there may be two reasons:

  1. You’re trying to launch patcher directly - this is not allowed. You can only test it inside Unity editor. When it’s built, you have to upload it to PatchKit for further testing.
  2. You did change application secret in inspector - For security reasons you have to reset application secret to default value which currently is ac20fc855b75a7ea5f3e936dfd38ccd8.

Getting help

If you’d require any help with the custom patcher, please don’t hesitate to contact us. We will assist you the best as we can!

Did this page help you? For questions about this part, please use the chatbox on the right or contact support here.

Copyright © 2015 - 2018 Upsoft
All Rights Reserved.