diff --git a/README.md b/README.md new file mode 100644 index 0000000..9c912e9 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# Marble It Up! Ultra Mod Loader + +A very simple mod loader for [Marble It Up! Ultra](https://marbleitup.com/), utilizing [Unity Doorstop](https://github.com/NeighTools/UnityDoorstop). In theory, this will probably work with lots of other Unity games due to its simplicity. + + + +## Usage + +To use the mod loader: + +1. Download the mod loader from the Releases page +2. Navigate to your Marble It Up! Ultra installation directory + * On Windows, this will probably be something along the lines of `C:\Program Files (x86)\Steam\steamapps\common\Marble It Up!` +3. Extract the zip file into this directory +4. Put any mods you want to use in your `Mods` directory +5. Start the game and you should be good to go! + +## Build + +If you just want to use the mod loader, refer to the Usage section above. These instructions are if you want to compile the mod loader itself. + +1. Clone the git repository +2. Download [Harmony](https://github.com/pardeike/Harmony/releases/tag/v2.2.2.0) and extract `0Harmony.dll` for net48 into the directory `/Mods/ModLoader`. +3. Edit `UserProperties.xml`: + * Remove the property `UserPropertiesNotSetUp` or set it to false. + * Edit `GameDir` to point to the directory of your MIUU installation. + * **Optional but recommended**: To prevent this file from showing as changed in git, run the git command `git update-index --skip-worktree UserProperties.xml` +4. Open `ModLoader.sln` in Visual Studio. +5. Click Build -> Build Solution, and it will build directly into the `Mods/ModLoader` directory. +6. Download [Unity Doorstop](https://github.com/NeighTools/UnityDoorstop/releases/tag/v4.0.0) and extract the x64 version into your MIUU install directory. +7. Edit `doorstop_config.ini`: + * Change `target_assembly` to `Mods/ModLoader/ModLoader.dll` + * **Optional but recommended**: Change `redirect_output` to `true` +8. You should now be able to launch Marble It Up! Ultra with the mod loader.