Skip to content
PEAK Modding Wiki

PEAK Unity Project Setup

A guide for setting up your PEAK Unity Project to create mods for PEAK.
Setting up a Unity Project is required to allow the custom creation of items and a custom design for status effects.

PEAK Project Patcher Thread Join the discussion on the PEAK Modding Discord server.
PEAK Project Patcher GitHub Repository View the PEAK Project Patcher GitHub Repository

The finished PEAK Unity Project functionality and custom creations are limited to some extent. Make sure to check the list below.

List of Current Limitations (Click to Expand)
  • Editor Play-Mode Starts but UI Elements and Interaction is Limited to non working.
  • GameObjects, Prefabs, and ScriptableObjects may have missing references.
  • Project uses Dummy Shaders and needs Replacements.

Prerequisites

Section titled “Prerequisites”

Download and Install the following:

Unity Project Setup

Section titled “Unity Project Setup”

Create a new Unity project with the following configuration:

  • Editor Version: 6000.3.15f1
  • Project Location: Local Project
  • Template: Universal 3D (URP/SRP)

Once Unity fully opens, navigate to the menubar and click Window > Package Management > Package Manager.
Click the 🞢 button in the top left of the Package Manager and choose Add package from git URL... and install the required Unity Packages by pasting the following links one by one into the Text field:

Unity Project Patcher:

https://github.com/Jettcodey/unity-project-patcher.git

Unity Project Patcher BepInEx (Optional):

https://github.com/Jettcodey/unity-project-patcher-bepinex.git

Unity PEAK Project Patcher:

https://github.com/Jettcodey/unity-peak-project-patcher.git

Please make sure to only use these git links when setting up the PEAK Unity Project Patcher!

Run Project Patcher

Section titled “Run Project Patcher”

Navigate to the Menubar and click Tools > Unity Project Patcher > Configs > UPPatcherUserSettings.

  • You will now see new options in the Inspector panel. Leave all the Pre filled fields as they are and only Enter the path to your prepared/copied game folder.

Back to the Menubar and open the Patcher Window by going to Tools > Unity Project Patcher > Open Window.

  • (Optional) If the BepInEx package is installed:
    Click on Enable BepInEx at the bottom of the window and wait for the process to finish.

Press Run Patcher to start the patching process.

Expected patch behavior:
Section titled “Expected patch behavior:”
  • Fresh patch time: ~45-60 minutes.
  • Unity will restart approximately 5-6 times during the process.
  • Simply click OK on the 4 popups when prompted after starting the process.
  • For “Script Updating Consent” select: “Yes, for these and other files that might be found later”.

After Unity restarts for the last time, a confirmation window will appear indicating the project has been successfully patched.