TBMM/GCMM/README.md

16 lines
999 B
Markdown
Raw Normal View History

# Gamecraft Mod Manager
A manager that handles everything needed to use mods for Gamecraft.
## Features
* Download and run GCIPA if needed
* List, install and uninstall mods
* Keep track of files added by mods and remove them when the mod is uninstalled
## Mod requirements
* For a mod to be listed, it needs to have a regular release (so not a prerelease) with exactly 1 attached asset.
* That asset can be either a dll if the mod doesn't have any other files, or a zip archive.
* If the zip contains a folder named Plugins, the manager will unzip it to Gamecraft's directory instead of the Plugins directory.
* The mod dll must use the same name as the repository, including casing. The manager will rename single dlls automatically but can't handle zipped mods with different names.
* The release tag must be the same as the assembly version of the mod with an optional `v` prefix.
* Add the mod to the list at https://git.exmods.org/ExMods/html-site/src/branch/master/site/mods/modlist.tsv