Skip to content

Installing the SDK

Jump to bottom
Artyom Zuev edited this page Dec 13, 2025 · 5 revisions

The SDK is a standalone Unity Project distributed as a Git repository. Follow the following steps to get started:

  • Download & install Unity Hub
  • Open the download page for Unity 2020.3.49f1 LTS. Click Install on top of the page to begin installation through Unity Hub. If this doesn't work, try downloading a Windows installer through links at the bottom of that page. It is very important to download the exact version of Unity Editor to avoid problems in the SDK.
  • Download the project from this repository. We strongly recommend downloading (cloning) through Git to facilitate easy updating.
    • If you're not familiar with Git and are unsure how to download a project from GitHub, try installing the GitHub Desktop client and following this tutorial.
    • You can find the list alternative Windows GUI clients here.
    • We recommend installing a standalone Git release and making sure it is in your PATH. If you're using a GUI client, you might not have standalone git.exe installed or might not have PATH set up. Download Git here.
  • In Unity Hub, navigate to the Projects tab and choose Open, selecting the folder with the project. Wait for the project to import.
  • We strongly recommend installing the optional asset package after opening the project for the first time (see below).

Pick a drive with at least 10Gb of free space and select a location with a short path, such as C:/Work/Unity Projects/PB_ModSDK. The core repository is a fairly small download, but an optional asset package totals around 4Gb. Full import of the project with the optional asset package installed might create up to 5Gb of temporary files, hence our recommendation to reserve up to 10Gb.

Optional assets

The optional asset package unlocks the full functionality of the SDK. We recommend downloading the package (~3.7Gb) in the background while you set up the main project and follow the initial tutorials. The assets were separated into an optional download to keep this repository lightweight and easy to update. They include 3D models of mech items, levels, props, textures, landscapes and some other art assets. These files are not required for most of the tools included in the SDK, but they unlock ability to view and edit levels, items, landscape metadata etc.

desc_getting_started.png Follow the instructions in the Getting Started window to install this optional asset package.

This wiki is a work in progress. Please make sure to check the built-in tutorials within the SDK or the modding articles on the game wiki to supplement this page. If you get stuck or experience a bug, please don't hesitate to ask questions in the #phantom-modding channel of the official Discord server. We can't wait to see what you create!

Clone this wiki locally