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.
It’s an important 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 will find out how to do that in Getting Started page. As soon as you did that, please proceed further.
Getting hands on the project
You can get the project from:
- The Asset Store (recommended, but not yet available)
The project has been created and tested with Unity 5.3.4. We highly recommend to use that particular version too.
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 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.
The patcher can be built exactly the same way as any other Unity project:
- Open File / Build Settings from the main menu.
- Choose PC, Mac & Linux Standalone as a Platform.
- Choose your Target Platform and Architecture. IMPORTANT: For Mac you have to choose x86_64 as Architecture. 1
- Make sure that Development Build is turned off.
- 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 will be stored in patcher.manifest file.
Now when you have your new patcher built, you have to upload it to your PatchKit account.
- Navigate to publisher panel applications page.
- Click the New Patcher button.
- In 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.
- Now click the New Version button.
- Edit the new version Label to, let’s say,
- Click the Upload Content button.
- 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.
- Choose that newly created zip file as your application content.
- Wait for the upload and version processing to finish.
- If there are no errors, click the Publish button.
- After the version is published, navigate to your game’s page.
- Inside Configuration panel look for Custom Patcher field. Click on the Edit button right next to it.
- From the dropdown select your new patcher.
- Click on the Save button.
From now on your new application will use your custom patcher instead of the default one.
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:
- Follow our Blog
- Follow our GitHub repository for new releases
- Sign in to Unity Patcher mails - You can do that in user settings page after you log in.
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.
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:
- You’re trying to launch patcher directly - this is not allowed. You can only test it inside Unity editor. When it’s build, you have to upload it to PatchKit for further testing.
- You did change application secret in inspector - For security reasons you have to reset application secret to default value which currently is
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!