{"id":18890808,"url":"https://github.com/mdmods/musedash.mod.template","last_synced_at":"2026-02-25T18:30:15.658Z","repository":{"id":218224006,"uuid":"667414691","full_name":"MDMods/MuseDash.Mod.Template","owner":"MDMods","description":null,"archived":false,"fork":false,"pushed_at":"2024-03-29T08:21:01.000Z","size":145,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2024-12-31T06:14:10.939Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MDMods.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-17T12:59:32.000Z","updated_at":"2024-10-18T01:43:02.000Z","dependencies_parsed_at":"2024-02-24T08:28:50.893Z","dependency_job_id":"1141690d-8349-4aaf-a98d-88a823e01f27","html_url":"https://github.com/MDMods/MuseDash.Mod.Template","commit_stats":null,"previous_names":["lxymahatma/musedash.mod.template","mdmods/musedash.mod.template"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MDMods%2FMuseDash.Mod.Template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MDMods%2FMuseDash.Mod.Template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MDMods%2FMuseDash.Mod.Template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MDMods%2FMuseDash.Mod.Template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MDMods","download_url":"https://codeload.github.com/MDMods/MuseDash.Mod.Template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239861968,"owners_count":19709331,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T07:57:32.164Z","updated_at":"2026-02-25T18:30:15.578Z","avatar_url":"https://github.com/MDMods.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MuseDash.Mod.Template\n\n[![NuGet](https://img.shields.io/nuget/v/MuseDash.Mod.Template)](https://www.nuget.org/packages/MuseDash.Mod.Template)\n\n**A template for making Muse Dash Mods**\n\n## Pre-requisites\n\n* [Muse Dash](https://store.steampowered.com/app/774171/Muse_Dash/) with [MelonLoader 0.6.1](https://github.com/LavaGang/MelonLoader)\n* [.Net SDK 6.0](https://dotnet.microsoft.com/en-us/download/dotnet/6.0)\n* Any C# IDE ([Visual Studio](https://visualstudio.microsoft.com), [Rider](https://www.jetbrains.com/rider), etc.)\n\n## Getting Started (Windows Only)\n\n* Download [SetPath.cmd](SetPath.cmd) from this repository and run it as administrator, follow the instructions to set Muse Dash path into your\n  computer's environment variable.\n* Open command prompt or powershell\n\n* If you are using .Net SDK 6, run\n\n```shell\ndotnet new --install MuseDash.Mod.Template\n````\n\n* If you are using of .Net SDK 7 or 8, run\n\n```shell\ndotnet new install MuseDash.Mod.Template\n````\n\nThis will install the template on your computer.\n\n## Usage\n\n* If you are using Visual Studio, you should be able to find the template in `Create a new project -\u003e MuseDash Mod`\n\n  Then you can create a new project with the following options:\n  ![VS](Intros/VS.png)\n\n* If you are using Rider, you should be able to find the template in `New Solution -\u003e Custom Templates -\u003e MuseDash Mod`\n\n  Then you can create a new project with the following advanced settings:\n  ![Rider](Intros/Rider.png)\n\n### Parameters\n\n* `--Patching`: Whether to generate a patching class for the mod. (Defaults to true)\n* `--Setting`: Options for generating a setting class for the mod. (Defaults to None)\n    * `None`: Do not generate a setting class\n    * `MelonLoader`: Use MelonPreferences for setting\n    * `Tomlet`: Use Tomlet directly for setting, this will also generate a `Data` class for setting\n* `--UsefulLibs`: Options for including useful libraries for the mod. (Defaults to MuseDashMirror)\n    * [`MuseDashMirror`](https://github.com/MDMods/MuseDashMirror): Offers more smooth and efficient modding experience for Muse Dash.\n    * [`ILRepack`](https://github.com/ravibpatel/ILRepack.Lib.MSBuild.Task): Able to merge dependencies and mod into a single dll file.\n    * [`UniTask`](https://github.com/Cysharp/UniTask): Provides an efficient allocation free async/await integration for Unity.\n    * [`ZString`](https://github.com/Cysharp/ZString): Zero Allocation StringBuilder for better performance.\n\n## Update Template\n\nRun the following command\n\n```shell\ndotnet new update\n```\n\n## Build From Source\n\n* Clone the repository to your computer\n* Open command prompt or powershell in that folder, run\n\n```shell\ndotnet build\n````\n\n* Or you can use your IDE to open the `MuseDash.Mod.Template.sln` solution file and build the solution\n\n\u003e [!NOTE]\n\u003e If you saw errors during the build about `Error CS1031`, it's normal, and you can ignore it. The nuget package file should still be generated.\n\n* Then you can find the nuget package in `bin/MuseDash.Mod.Template.{version}.nupkg`\n* Open command prompt or powershell in `bin` folder, run\n\n```shell\ndotnet new install MuseDash.Mod.Template.{version}.nupkg\n```\n\n\u003e [!IMPORTANT]\n\u003e If you have installed the template before, you should uninstall it first by running `dotnet new uninstall MuseDash.Mod.Template` before installing the built\n\u003e version.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdmods%2Fmusedash.mod.template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmdmods%2Fmusedash.mod.template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdmods%2Fmusedash.mod.template/lists"}