ExMods/TBMM
1
0
Fork 0
Code Issues 2 Pull requests Projects Releases 7 Packages Wiki Activity

Update README

Browse source
This commit is contained in:
Norbi Peti 2021-07-12 02:21:15 +02:00
parent 1cb3c200a9
commit 4ddab53b6d
2 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -1,7 +1,7 @@
# Gamecraft Mod Manager # Techblox Mod Manager
A manager that handles everything needed to use mods for Gamecraft. A manager that handles everything needed to use mods for Gamecraft.
**Note:** If you already have a mod installed the manager won't know about what files it has until it's updated through GCMM. If you uninstall the mod before updating it, it'll only remove the plugin dll and then treat the other mod files as part of Gamecraft. **Note:** If you already have a mod installed the manager won't know about what files it has until it's updated through TBMM. If you uninstall the mod before updating it, it'll only remove the plugin dll and then treat the other mod files as part of Techblox.
## Features ## Features
* Download and run GCIPA if needed * Download and run GCIPA if needed
@ -12,8 +12,14 @@ A manager that handles everything needed to use mods for Gamecraft.
## Mod requirements ## Mod requirements
* For a mod to be listed, it needs to have a regular release (so not a prerelease) with exactly 1 recognised attached asset. * For a mod to be listed, it needs to have a regular release (so not a prerelease) with exactly 1 recognised attached asset.
* That asset can be either a dll if the mod doesn't have any other files, or a zip archive. * 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. * If the zip contains a folder named Plugins, the manager will unzip it to Techblox'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 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.
* If you have any other files as part of the release, the mod one (that needs to be downloaded to the game) must have the same name as the repository. * If you have any other files as part of the release, the mod one (that needs to be downloaded to the game) must have the same name as the repository.
* The release tag must be the same as the assembly version of the mod with an optional `v` prefix. It can also have a `-preview` suffix if it **only** works with preview versions of the game * The release tag must be the same as the assembly version of the mod with an optional `v` prefix. It can also have a `-preview` suffix if it **only** works with preview versions of the game
* Add the mod to the list at https://git.exmods.org/ExMods/html-site/src/branch/master/site/mods/modlist.tsv * Add the mod to the list at https://git.exmods.org/ExMods/html-site/src/branch/master/site/mods/modlist.tsv
### Examples
* For a mod named ExampleMod that also needs ExampleDll to work: zip the mod and the dll up in an archive named ExampleMod.zip and make sure the dll is also named ExampleMod.dll
* For a mod named ExampleMod that needs to add an asset to the game, put the dll in a Plugins directory and the asset where it should be in the game and zip that together (Plugins/ExampleMod.dll and TechbloxPreview_Data/...)
* For a mod named ExampleMod that has a separate app for it in the same repository or you want to attach something else in the release, *just do it:* as long as the zip is named ExampleMod.zip the mod manager will (only) download that zip
* If you only have a single dll, it can be named anything, though why would you not name it the same?!

1
TBMM/Configuration.cs
View file

@ -6,7 +6,6 @@ namespace TBMM
public class Configuration public class Configuration
{ {
public string GamePath { get; set; } public string GamePath { get; set; }
public AutoPatchingState AutoPatch { get; set; } = AutoPatchingState.Unspecified;
public static Configuration Load() public static Configuration Load()
{ {