/PiUtils

Utility mod for unity modding

Primary LanguageC#GNU General Public License v3.0GPL-3.0

Pi Utils

GitHub release (with filter) GitHub Release Date - Published_At Thunderstore.io GitHub downloads all releases LiberaPay Patrons GitHub Workflow Status (with event) GitHub issues GitHub pull requests License

Utility mod for my other mods. This mod is a dependency for my other mods and does not add any content to the game itself.

Warning
 This mod is intended for modders and developers and does not add any content to the game itself.

I spent countless hours of my free time creating mods. If you enjoy them, please consider supporting me on Liberapay ❤️

Donate using Liberapay
Table of Contents

1. Prerequisites

2. Setup

You can install the mod from Thunderstore or install it manually:

2.1. BepInEx

  1. Download the latest 5.x release of BepInEx from the Releases page.

  2. Extract the downloaded archive into the game’s installation directory.

  3. Run the game once. BepInEx should be installed automatically.

2.2. PiUtils Mod

  1. Download the latest release (v0.4.0) of this mod from the Releases page.

  2. Extract the downloaded archive.

  3. Copy the BepInEx folder into the games folder in steamapps/common directory.

  4. Run the game. The mod should be loaded automatically by BepInEx.

2.3. Disabling the Mod

To disable the mod change the Enabled under [General] value in the de.xenira.pi_utils.cfg file in the BepInEx/config folder to false.

2.4. Uninstalling the Mod

To uninstall the mod remove the mod’s files from the BepInEx/plugins folder. This should be the following files:

  • pi_utils.dll

3. Configuration

The configuration file is located in BepInEx/config/de.xenira.pi_utils.cfg. You can edit it using a text editor like vim or Notepad++.

3.1. Resetting the Configuration

To reset the configuration, delete the de.xenira.pi_utils.cfg file in the BepInEx/config folder. The mod will create a new configuration file with the default values the next time you run the game.

To reset only a specific section, delete the section from the configuration file. The mod will create a new section with the default values the next time you run the game.

3.2. Configuration Options

General
Enabed

Enables or disables the mod. Currently this has not much of an effect, as most functionality acts as a library. If it does, it may break mods that depend on this. Default: true
Debug
Debug Mode

Mostly used for development. Default: false
Gizmo Enabled

Enables or disables gizmos. Only some objects have gizmos attached. Default: false
Debug Line Enabled

Enables or disables debug lines. Only some objects have debug lines attached and the direction might seem arbetrary at first glance. Default: false
Trace Enabled

Enables or disables trace. Default: false

4. Troubleshooting

If you encounter any issues while using this mod, please check the BepInEx console for any error messages. You can also report issues on the Issues page of this repository.

5. License

This mod is licensed under the GNU General Public License v3.0 (GPL-3.0).

6. Disclaimer

This mod is not affiliated with the game’s developers or Unity Technologies. All trademarks are the property of their respective owners.