Table of Contents

• About the Project
• Getting Started
  • Prerequisites
  • Installation
• Usage
• FAQ

About the Project

This tool is a game wrapper on top of the Unity Project Patcher.

This takes a build of REPO, extracts its assets/scripts/etc, and then generates a project for usage in the Unity editor.

[!IMPORTANT]
This tool does not distribute game files. It simply works off of your copy of the game!

Also, this tool is for personal use only. Do not re-distrubute game files to others.

Getting Started

Already Bundled

This project is bundled with the following packages:

• Insert text if needed or remove section

Gets Downloaded

• Insert text if needed or remove section

Prerequisites

You will have to make sure you have the following before using the tool in any way:

• Git
• .NET 8.0
  • To run Asset Ripper
• Unity Project Patcher
• Unity Project Patcher BepInEx
  • Can be disabled

Installation

Unity Project

• Requires Unity %UNITY_VERSION%
• Unity %UNITY_PIPELINE% pipeline

Create a new Unity project with the above requirements before getting started.

[!IMPORTANT]
These options require git to be installed!

You will need to install three packages in sequence here:

• Unity Project Patcher: https://github.com/nomnomab/unity-project-patcher.git
• Unity Project Patcher BepInEx: https://github.com/nomnomab/unity-project-patcher-bepinex.git
  • Can be disabled
• This package

Installing the Unity Project Patcher core

Install with the package manager:

1. Open the Package Manager from Window > Package Manager
2. Click the '+' button in the top-left of the window
3. Click 'Add package from git URL'
4. Provide the URL of the this git repository: https://github.com/nomnomab/unity-project-patcher.git
   • If you are using a specific version, you can append it to the end of the git URL, such as #v1.2.3
5. Click the 'add' button

Install with the manifest.json:

1. Open the manifest at [PROJECT_NAME]\Packages\manifest.json
2. Insert the following as an entry:

"com.nomnom.unity-project-patcher": "https://github.com/nomnomab/unity-project-patcher.git"

• If you are using a specific version, you can append it to the end of the git URL, such as #v1.2.3

Installing this Game Wrapper

The same steps as previously, just with https://github.com/[AUTHOR]/[GAME-WRAPPER-NAME].git

Installing the BepInEx Wrapper

Open the tool window Tools > Unity Project Patcher > Open Window and press the Install BepInEx button.

Otherwise, follow the steps at https://github.com/nomnomab/unity-project-patcher-bepinex

Disabling BepInEx Usage

If you don't want to use plugins, then follow the steps at https://github.com/nomnomab/unity-project-patcher-bepinex#disabling-this-package

Usage

The tool window can be opened via Tools > Unity Project Patcher > Open Window

[!IMPORTANT]
This tool mostly supports patching an already patched project, although this can lead to broken assets. So make sure you back up your project beforehand.

Estimated patch durations:

• Fresh patch: $ESTIMATED_DURATION$
• Already patched: $ESTIMATED_DURATION$

These can vary wildly depending on system speed and project size.

FAQ

The core project's FAQ can be found here: https://github.com/nomnomab/unity-project-patcher#faq