thearst3rd/miuu-spreadsheet-helper
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add README.md

Browse source
This commit is contained in:
Terry Hearst 2024-01-01 16:30:09 -05:00
parent 809bdb85f6
commit 9327dd2105
1 changed files with 28 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md Normal file
View file

@ -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!