Installing the optional assets

We strongly recommend installing the optional asset package to unlock the full functionality of the SDK. The package includes 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.

This tutorial is available directly in the SDK under PB Mod SDK/Getting Started/Tutorials/Installing optional assets. The SDK version can include interactive elements such as buttons automatically selecting project assets. Make sure you are in the right scene (game_main_sdk or game_extended_sdk). You should see DataModel and ModManager in the Hierarchy window. If you're unsure how to find the right scene, use the scene buttons in the Getting Started window.

Importing the package

The package was separated from the SDK into an optional download to keep the repository lightweight and easy to update. You can download it here (~3.7Gb). Once the package is downloaded, click Assets/Import Package/Custom Package in the top toolbar of Unity Editor and the downloaded .unitypackage file. Click "Open" and wait for the Editor to process the package contents (this can take up to 10 minutes on some machines):

Once the Editor is done analyzing the contents of the .unitypackage file, you should see the "Import Unity Package" window pop up. It will show a preview of two new folders: ContentOptional and Resources. Click the "Import" button in the bottom right corner and wait for the process to finish.

Refreshing the project

Once the import is done, click "PB Mod Tools/Rebuild Resource DB" in the top toolbar (or click the button below). Next, force refresh of all asset services with "PB Mod Tools/Refresh Asset Managers".

Some of the imported assets might need a restart to start working. To ensure everything is loaded properly, it's best to restart the Unity Editor after completing all previous steps.

Check the scene

To switch to the full toolkit, open the extended scene. Open the game_extended_sdk scene located in the ContentOptional/Scenes folder using the Project tab. Alternatively, press "Open main scene" in the Getting Started window. You should see new objects in the Hierarchy tab, like on the screenshot above.

With this completed, you're all set! The Editor will remember the opened scene and will continue to use it on startup. You will have access to the level editor, item previews, region previews and more!