From f4c33d6c2817cd3d481d9999150a6593407d146d Mon Sep 17 00:00:00 2001 From: Slxdy Date: Wed, 3 Apr 2024 12:23:46 +0200 Subject: [PATCH] Added a guide for properly releasing mods --- Guides/DeveloperGuide.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/Guides/DeveloperGuide.md b/Guides/DeveloperGuide.md index da30c89..245b1a6 100644 --- a/Guides/DeveloperGuide.md +++ b/Guides/DeveloperGuide.md @@ -143,4 +143,35 @@ You can easily debug your mod through your IDE. This will allow you to start the - Set the `Arguments` property to the path of your game. Make sure to put it between double quotes. Example:
![Project Properties](image.png) -- You're all set! You can now start debugging your mod by simply clicking the `Start` button at the top of your IDE. \ No newline at end of file +- You're all set! You can now start debugging your mod by simply clicking the `Start` button at the top of your IDE. + +## Releasing Your Mod +When releasing a mod, it's important to make it easy for users to install. + +First, we need to understand the basic folder structure of TweaksLauncher. +- Each mod should have its own folder, for example: `MyMod/MyMod.dll` +- The mod folder must have the same name as the dll +- All universal mods go to the `GlobalMods` folder. Example path: `TweaksLauncher/GlobalMods/MyMod/MyMod.dll` +- All game-specific mods need to go to the `Games/Your Game Name/Mods` folder. Example path: `TweaksLauncher/Games/BloonsTD6/Mods/MyMod/MyMod.dll` + +Knowing this, the best practice is to zip your mod with the same folder structure before releasing it. This will allow the users to easily unzip the mod into the right directory. + +Example of a good zip structure: +``` +Games +| BloonsTD6 + | Mods + | MyMod + | MyMod.dll + | ExampleDependency.dll +``` + +TweaksLauncher also support standalone mods, which don't have their own directory, but only a single dll. This isn't recommended, but may look better for smaller mods. + +Example of a good zip structure for standalone mods: +``` +Games +| BloonsTD6 + | Mods + | MyStandaloneMod.dll +``` \ No newline at end of file