Unity Custom Patcher

Patcher is the first thing that 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 important thing for you to be able to customize the patcher however possible. 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 will find out how to do that in Getting Started page. As soon as you have one, please proceed further.

Getting hands on the project

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

You can get the project from:

Making changes

Basic look & feel

Before starting customizing your patcher, make sure to make a copy of the Patcher scene and do all the modifications on that new scene. If you will modify the supplied scene, any asset upgrade will overwrite 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 build exactly in 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 would name your executable. Information about it will be stored in patcher.manifest file.

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 on the New Patcher button.
  3. In new application form name your patcher (e.g. My Patcher Windows 64) and click on the Create button. Shortly after you should be able to see your new application.
  4. Now click on the New Version button.
  5. Edit the new version Label to let’s say 1.0.
  6. Click on 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 won’t be any errors, click on the Publish button.
  11. After the version is published, navigate back to your patcher application page.
  12. Copy your patcher secret into your clipboard.

Secret field

  1. Navigate to the game page that you want to use your custom patcher for.
  2. Edit Custom Patcher Secret and paste copied secret into it.

Custom Patcher Secret

From now on your new application will use 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 just need to upload a new version to your patcher application and publish it. Old patcher versions will be automatically replaced by the new version on the next start of the launcher.

Getting help

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

Copyright © 2015 - 2017 Upsoft
All Rights Reserved.