Unity Extension
The PatchKit Unity Editor Extension is a Unity tool for direct, automatic application distribution from the Unity Editor. Provide a fast, comfortable and safe connection with API PatchKit. The Extension allows uploading without leaving the editor, all you have to do is log in and make the build. After that, version is being sent to PatchKit.
Downloading and Installation
The extension is available for download from GitHub, for free. It’s compatible with Unity 2017.x version and higher.
Installation steps
- Download unitypackage from GitHub.
- Choose Assets / Import Package / Custom Package from the Unity menu and select the unitypackage file from the file browser.
- Confirm importing all the assets by clicking on the Import button.
After importing the PatchKit Unity Editor Extension, you should see it in your Project window, and there should be a new entry called PatchKit in the Tools main menu.
Windows
The extension can be accessed by opening one of three windows from the Tools / PatchKit main menu.
About
This window contains information about PatchKit Unity Editor Extension and actual version. Includes also shortcuts to Support: Contact and Documentation pages.
Account
This window allows you to login to your PatchKit account using your API Key. You can switch account by clicking on the RESET button and changing the API Key.
Build and Upload
Shortcut: Ctrl+Alt+Shift+B
This window allows you to make a build of your project and send it directly to PatchKit with the confidence that everything is set up correctly.
Actions
Connecting an account
To connect with your PatchKit account, you need to use your API Key. API key is a key to your account features. You can get if from the Account page in the PatchKit panel (quick open by clicking magnifier icon).
Building and uploading application
Make sure to connect your PatchKit account first.
Choosing an application
Before you can build anything, you must first select a target PatchKit application. You can either create a new application or choose an existing application.
New application
This option creates a new application on your PatchKit account. It is required to provide its name* and choose build target platform**.
* Name may include English-only characters and ‘:’, ‘_’ or ‘-‘, and must be unique.
** Build target platform is set automatically from the current Unity project build target platform. To change PatchKit’s application platform, you need to switch your Unity build target first.
Existing application
This option displays a list of applications that are already existing on your PatchKit account. All you have to do is select the one you’d like to use. The list can display either all applications or the filter these by your current Unity target platform
Creating and uploading a build
After the application is chosen, this is the next step to prepare your build. Before proceeding, you have to select a disk location where the build will be compiled (it’s recommended to be an empty directory) and scene list that you wish to be included in the build.
The last step is a form with version description consisting of two *text fields: Label and Changelog field. Label field is a “title” of the current version, changelog lists the changes that have been introduced in the version and can be left blank. Version can be automatically published by checking the Automatically publish after upload button. If there’s an existing draft version, you have to acknowledge it by selecting Override draft version if it exists, otherwise, uploading operation will be rejected to avoid any unwanted damage.
* These text fields allows only English characters and ‘:’, ‘_’ or ‘-‘, if you need to enter other characters, please use the PatchKit panel.
Uploading
Uploading is the final operation of application publishing, when the built version is being sent to PatchKit, including provided details. During the process, a system console may be opened, just leave it open until you see a “Done” message. When you do, it can be safely closed. Your version has just been correctly transferred to PatchKit!
