mdmodsdev / misctoolsformd

Misc tools for Muse Dash

MiscToolsForMD

What is This

A Muse Dash Mod which contains many features.

What feature does it have

1. Realtime accuracy calculator (a little buggy but I can't fix it now, maybe you can help me.)

2. Key indicator (which key do you press and how many times do you press that key)

3. Realtime lyric display (under developing)

How to use it

Install mod loader from here, install binary file as a mod, start game and you can see changes.

How to get binary

You can clone this repo, copy Directory.Build.props.example to Directory.Build.props and edit it, set game folder(for example, C:\Program Files\Steam\steamapps\common\Muse Dash), open in Visual Studio and recover the project. All libraries are in %Game Folder%\MelonLoader\Managed after you started game with MelonLoader at least once but it should be detected automatically if you edit Directory.Build.props correctly.
After recovering project successfully, you can build it and get MiscToolsForMD.dll and MiscToolsForMD.SDK.dll at %Repo Folder%\bin\%Build Type%\. Both files are needed, put MiscToolsForMD.dll at Mods folder and put MiscToolsForMD.SDK.dll at UserLibs folder.

Why create MiscToolsForMD.SDK and how to use it

Code inside it contains a data provider which allows you get realtime play info. I think this may be useful for someone. MiscToolsForMD mod now also depends on this.
Just add it to your project as a reference, all APIs are under namespace MiscToolsForMD.SDK.
[WARN] The SDK is under heavy development and may not work as expected. Also it needs a qualified document, but I am working on fixing accuracy calculating now so you may have to explore it yourself.

Known issues

• Accuracy calculation in some cases is not same with game's result, we are working on it now.

Contributing

1. Please creating feature at branch dev, we use branch main as stable version.
2. Please use Visual Studio or other IDE supports Visual Studio's .editorconfig. Because we defined our code style in .editorconfig file, using Visual Studio can make your code like us. You can use Visual Studio Community for free. If you still want to choose other IDE which does not support the .editorconfig file, please keep our code style yourself:
   • Most of the names are using Pascal Style, interface must starts with letter I like IMyInterface, MyAwesomeClass and MyFunction.
   • Property's name should use Camel Style like propertyAlpha and betaProperty.
3. Please make sure most warnings in Visual Studio are solved. Solving warnings may help reducing hidden bugs.

misctoolsformd's Issues

Quick question on contributing to the project

Hi 👋! I've noticed that you are implementing synced lyrics for Muse Dash. I want to add Musixmatch lyrics source. Is it ok to ship additional dependency that provides Musixmatch API for lyrics?