UmaiUme - UmaiUme Tools: UmaiUme Launcher

UmaiUme Launcher (UULauncher)

UULauncher is an Unity Engine game launcher that allows to patch game’s assemblies and manage them while the game is running.

UULauncher is designed to be used alongside game patchers to make patching experience much smoother. Currently UULauncher has pre-built support for ReiPatcher, but other custom patcher modules will be supported in the future!

Key features

Easy to use: Simply run it instead of the game’s executable to automatically patch and run the game
Easy to set up: Just edit a configuration file (instructions inside) and you’re good to go!
Some sweets for power-users: Customize the behaviour of the tool through command line switches and the configuration file!
Automatically restores assemblies to unpatched state when the game exits
Logs every launch
Compatible with other patchers (Sybaris, IPA, ReiPatcher, etc.)
Open-source!

Differences from ReiPatcher and other patching tools

As a comparison, here is a table that displays key differences between running pure ReiPatcher versus using UULauncher with ReiPatcher support:

	UULauncher (with ReiPatcher support)	ReiPatcher
Running	Runs by default with a double-click. Supports additional switches for more precise control.	Requires te be run either through Command Prompt or by creating a custom batch file.
Patching assemblies	Done automatically before the game is run.	Must be executed manually before running the game executable.
Restoring assemblies	Done automatically after the game is closed (or when UULauncher is used the next time).	Must be done manually.
Removing patches	Remove the patch DLL from the patches folder	Remove the patch DLL and restore the game’s assemblies from backup.
Running unpatched game	Simply run the game’s executable.	Restore the original assemblies from backup and then run the game’s executable.
Backups	Creates a single backup of the original assembly and puts it in an easy-to-find place.	Creates backups every time ReiPatcher is run, creating a myriad of backups in the long run.
Logging	Logs every run automatically, making it easy to troubleshoot later	Does not log nor allows logging through stream redirection (as of v0.9.0.8).
Interface	Command-line interface, GUI will be implemented in the future.	Command-line interface only.

Note: Even with these differences, UULauncher is not a replacement for ReiPatcher (or other patching tools), as UULauncher will still utilize the code/assemblies of the original tools. That means that you will still have to download ReiPatcher to make UULauncher work. However, you will not need to install and set-up ReiPatcher, as UULauncher will do that instead.

Planned features

Modular patcher approach that will allow to create patchers for other tools
GUI interface (possibly with support to change the game’s settings alongside)

How to set-up

1. Download UULauncher

Download the latest release of UULauncher from the links above. The clean version of UULauncher comes only with the following files: README.txt that contains similar guide as this one, LICENSE that contains the MIT licence and UULauncher.exe that is the UmaiUme Launcher executable.

Copy the executable to the game’s root directory (where the game’s executable is located).

Note: ADVANCED: You can also place UULauncher.exe in some other folder than the game’s root, since you will be able to specify the game’s path in the configuration file later.

2. Download patcher tools

Currently UULauncher requires only ReiPatcher’s assemblies to work. Thus you need to only download ReiPatcher and the assemblies that come with it.

After downloading, unpack ReiPatcher (ReiPatcher.exe, ExIni.dll, Mono.Cecil.dll and other assemblies) into <Game Root>\ReiPatcher or other folder.

3. Run UULauncher for the first time

Next, double-click UULauncher.exe to run it. If everything works, UULauncher will prompt you to create a default configuration file – select Yes to create it.

Note: ADVANCED: In Command Prompt, running UULauncher.exe -h will show a help box with all the advanced arguments that UULauncher currently supports.

4. Edit the configuration file

Open the default configuration file (named UULauncher.ini) in the text editor of your preference. Read the editing guide contained withing the configuration file and edit it to your need/preference.

Most importantly, edit the keys specified by ;EDIT ME comment. Those keys include the paths to ReiPatcher, the patches and the game’s executable.

Note: ADVANCED: You can specify a locale emulator (or another executable) to run instead of the game when the patching is complete. In that case you must specify the GameExecutableName key with the game’s executable name. If that key is specified, UULauncher will attempt to find a process with the specified name to bind to. If GameExecutableName is not specified, UULauncher will be unable to restore the game’s assemblies after the game closes.

If you already have a pre-made configuration file, simply replace UULauncher.ini with it.

5. Install patches and run UULauncher

Finally, run UULauncher every time you want to run a patched game.

Note: ADVANCED: Double-clicking UULauncher.exe will run UULauncher with the default configuration. Run UULauncher.exe -c <PATH> (where <PATH> is the path to the configuration file) to run UULauncher with a custom configuration file.

Advanced: Current supported arguments

UULauncher supports command-line arguments.

Run UULauncher.exe [ARGUMENTS] with the one of the following arguments to change UULauncher’s behaviour:

Argument	Definition
`No arguments`	Runs UULauncher with the default configuration. Creates the configuration file if it does not exist.
`-h`	Displays the help window.
`-c <PATH>`	Runs UULauncher with the configuration file located in `<PATH>`.