miuu-diamond-time-viewer/README.md

Marble It Up! Ultra Diamond Time Viewer

This is a mod of Marble It Up! Ultra which allows you to view the hidden diamond times in-game. It is comically over configurable for the simple task it sets out to achieve.

Usage

1. Install the MIUU Mod Loader.
2. Download the mod from the Releases page.
3. Extract the zip into your Mods folder.
4. Optional: Install the Console Unlocker.
   • With the console unlocked, you can run the command dtv to configure the mod at runtime.
5. Run the game, and you should be able to see the diamond times in-game!

Configuration Modes

All of these options can be configured by editing config.json or using the dtv console command.

There are a few modes which I felt made sense as a way to show diamond times. They are as follows, in order of most to least restrictive:

• never: Never show diamond times. This option disables the mod and lets the original code run.
• diamond: Only show the diamond time after you have achieved it. This is the default mode.
• gold: Show the diamond time after you have achieved the gold time. This is to help players who can achieve gold times, but might not want to commit to grinding a diamond time unless they think they can achieve it.
• always: Always show diamond times no matter what.

When showing the diamond time, it will show three times instead of two, making things slightly more cluttered. If this is bothersome, I added some additonal options:

• Show silver time no matter what. This is the default mode.
• Hide the silver time when showing the diamond time. This means that no matter what, you will always see exactly two times in the menu. When the diamond time is being displayed, it will not display the silver time, so it will only show the gold and diamond time and retain a similar layout to the vanilla game.

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 DiamondTimeViewer.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!