From 9327dd21058a1f80f32d1ed680d5837fdb4e395f Mon Sep 17 00:00:00 2001 From: Terry Hearst Date: Mon, 1 Jan 2024 16:30:09 -0500 Subject: [PATCH] Add README.md --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..17c71ab --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Marble It Up! Ultra Spreadsheet Helper + +This is a mod of [Marble It Up! Ultra](https://marbleitup.com/) which allows you to quickly copy your personal bests to your clipboard, so they can be easily pasted into the community spreadsheet. + +## Usage + +1. Install the MIUU Mod Loader. +2. Download the mod from the Releases page. +3. Extract the zip into your `Mods` folder. +4. Install the Console Unlocker. +5. Launch the game. +6. In the in-game console, run the command `ssh N` where N is the number of a chapter: + * Numbers 1-6 correspond to Ultra Arc chapters 1-6. + * Numbers 7-10 correspond to Bonus Arc chapters 1-4. +7. Paste into the community spreadsheet over the corresponding chapter. +8. Repeat 7 and 8 until you have all of your PBs on the community spreadsheet! + +## Build + +If you just want to use the mod, refer to the Usage section above. These instructions are if you want to compile the mod itself. + +1. Clone the git repository. +2. Install the MIUU Mod Loader, so the Harmony dll is present. +3. Edit `UserProperties.xml` to remove the `UserPropertiesNotSetUp` property (or set it to false) and point `GameDir` to your MIUU installation directory. + * **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 `ShreadsheetHelper.sln` in Visual Studio. +5. Click Build -> Build Solution, and it will build directly into your MIUU installation directory. +6. You should now be able to launch the game with the mod built!