Getting Started with REPOLib (Unity)

The Unity workflow is used to create content for REPOLib without writing code.

Unity Project Setup

In Unity at the Menubar go to Window then Package Manager.
Click the + button in the top left and choose Add package from git URL.
Paste all of the following Unity Packages one after another here:

Unity Project Patcher: Generates a Unity project from a game build so the game can be played in the editor.
bash
```
https://github.com/nomnomab/unity-project-patcher.git
```
Unity Project Patcher BepInEx: BepInEx handler for a Unity Project Patcher project.
bash
```
https://github.com/Kesomannen/unity-project-patcher-bepinex.git
```
Unity Repo Project Patcher: Game wrapper that generates a Unity project from R.E.P.O. build for in-editor play.
bash
```
https://github.com/ZehsTeam/unity-repo-project-patcher.git
```
REPOLib-Sdk: Editor tools that streamline REPOLib content creation and export.
bash
```
https://github.com/ZehsTeam/REPOLib-Sdk.git
```

TIP

To update REPOLib-Sdk open Package Manager, select the REPOLib-Sdk package, then choose Update.

Add REPOLib to the project

Download REPOLib.dll from Thunderstore
Extract the downloaded archive.
Copy the file named REPOLib.dll into any location under your project's Assets folder.

TIP

To update REPOLib, replace the dll with a newer version's.

Working with Mods and Content

Content in REPOLib is organized with Mod and Content assets. Each Mod has its own folder with its content. Here's an example file hierarchy:

- Assets
    - MyModFolder
        - MyMod.asset
        - MyValuable.asset // content asset, references the prefab
        - MyValuablePrefab.prefab
        - EnemyFolder
            - MyEnemy.asset // content in subfolders is also fine
    - MyEnemyPrefab.prefab // other assets can be outside of the mod's folder

Mods can be automatically exported from the editor, where REPOLib-Sdk handles bundling the assets and packaging the files for Thunderstore (see Export a Mod).

Create a new Mod

Create a new folder in your project.
Right click in the folder, then choose Create > REPOLib > Mod.
Fill in the fields on the Mod asset:
- Name: the mod's name, as shown on Thunderstore. This can only contain numbers, letters and underscores.
- Author: the name of your Thunderstore team.
- Version: must be in the format X.Y.Z.
- Dependencies: a list of dependency strings. Zehs-REPOLib-X.X.X should always be included (where X.X.X is the target version).
- Website Url: optional.
- Icon: must be a 256x256 PNG file.
- Readme: a longer description of the mod, in a separate file. Supports markdown formatting.
- Extra Files: additional files to include in the package, for example a dll containing your scripts.

TIP

You can have multiple mods in the same project, as long as they are in separate folders.

Export a Mod

Select the Mod asset and click Export in the inspector.
- In the window you'll see the associated content files found by REPOLib-Sdk.
Choose an Output Path. The path is relative to the Unity project (unless you specify an absolute path).
Click Export and wait. Once finished, a window should appear showing the exported zip file. This file can be uploaded to Thunderstore or locally imported into mod managers.

WARNING

REPOLib-Sdk creates multiple folders and files under the export path. Therefore, it is recommended to use a new, empty folder as the target.

TIP

The export window can also be accessed from Window > REPOLib Exporter

Getting Started with REPOLib (Unity) ​

Unity Project Setup ​

Add REPOLib to the project ​

Working with Mods and Content ​