Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 2.33 KB

README.md

File metadata and controls

38 lines (29 loc) · 2.33 KB

TweaksLauncher

A Simple and User-friendly Unity Mod Launcher for Windows.

In Development

The project is still in development. Check out the roadmap.

How it works

TweaksLauncher is a game launcher, meaning it does NOT inject itself into the game, but rather starts it manually through the UnityPlayer module.

Requirements

How to use

If you've already installed the launcher before, skip steps 1 and 2.

  1. Grab the latest zip from the Releases Page.
  2. Unzip it to an empty folder (NOT IN A GAME FOLDER).
  3. Start the launcher, and follow the instruction displayed in the console. Do not use the x86 version unless you know what you're doing. This will allow you to start the game through the launcher.

How to install mods

Depending on the mod, the installation instructions may vary. However, most zipped mods should be extracted to the launcher's folder. Make sure to extract the entire zip, including all folders within it. Do NOT create any extra folders if prompted. If the mod is a single DLL, follow instructions provided by the developer.

Developing Mods

TweaksLauncher provides useful features for developers, such as auto-build and debugging.
To get started, refer to the Developer Guide.

Compilation Guide

The project should be compiled using Visual Studio. Make sure to build the entire solution. The builds are saved to the output directory.

Credits

Il2CppInterop - A tool interoperate between CoreCLR and Il2Cpp at runtime
Cpp2IL - Work-in-progress tool to reverse unity's IL2CPP toolchain.
BepInEx/Dobby - Fork of jmpews/Dobby with stability edits for Windows
HarmonyX - Harmony built on top of MonoMod.RuntimeDetours with additional features
Pastel - A tiny utility class that makes colorizing console output a breeze.