Hj Updater API

This 'mod' is actually an API for developers willing to implement an auto-update feature for their mod in only one function call. As a user of the mod, every other mod using Hj Updater API will be updated automatically while you are playing. As a developer, many options are available for you to decide how the update should behave. If you only want to warn the mod user that an update is available, Hj will provide you an easy way to do so.

How does it work ?

I won't enter the details but BepInEx loads all of your mods into your RAM when you start the game. That means that while still playing, modification to the mods files are possible without impacting your gameplay experience. For mods that require runtime access to files resources (assets, sandbanks,etc.)., Hj will wait for you to close the game before deploying the changes.

Is it safe to use ?

Yes. Every update is logged, and every old mod version is kept into a Backup folder under BepInEx/plugin/HijackHornet-HjUpdaterAPI/Backup. Also, Hj create an interface between mods and the folder structure in which they exist. So no matter if a user put the dll file into the root of /plugin or into a folder inside another folder named pepeDontLikeToFeel : the mod will still update and keep this folder structure.

User Guide

As a user, you can install this mod by unzipping the archive into the plugin folder. Don't forget to add BOTH dll next to each other.
However, this mod won't do anything if the other mods you are using aren't compatible with it. Some mods might put Hj as a dependency, forcing you to install it, while others might only suggest you install it because they made their mod compatible.

Config

At the moment, the only config available to you is the emergency turn of parameters. For example, if a mod has been updated automatically but the update is broken and you would like to use the backup files (previous version), you should change this parameter to true,
Just go to /BepInEx/config/hjupdaterapi.config and change the value from false to true.

Developer Guide

As a modder, you can use Hj function to add an update behaviour for your mod. It's very simple to do and should provide enough flexibility to work with basically any mod. Here is how to setup Hj into your mods. It also ensures that if your mod end up being deprecated, it will be automatically deactivated on users’ computers.

Adding the dll into your project lib folder

In Visual Studio (or whatever IDE you use) add both dll included in the mod download link into your library folder, and add a reference to them into your project settings.

Adding the dependency

You can choose to HjUpdaterAPI as a dependency so that you are assured that everyone using it will get the latest version or at least be informed that a new version is available. However you can also choose to add it has an optional dependency and check in the awake function if the mod is installed and if so perform the command call.

Using the namespace

First add the namespace usage at the beginning of your mods main class.

using Hj;  
//your other namespace  

Now go into your awake function (it has to be put into Awake and not into Start) and call the register function :

void Awake(){  
HjUpdaterAPI.RegisterForUpdate(  
	string packageName,  
	System.Version currentVersion,  
	string assemblyFileLocation,  
	[byte flag],  
	[List<string> otherFilesLocationRelativeToTheDll],  
	[bool modUseRuntimeRessourceLoading]
	);  
}  

Let's go through each parameter
Mandatory parameters

• packageName - The name of your mod inside the manifest.json name
• currentVersion - The version of your mod. Can bet fetch using MetadataHelper.GetMetadata(this).Version
• assemblyFileLocation - This is a runtime absolute value. This HAS TO BE Assembly.GetExecutingAssembly().Location

Optional parameters

• flag - This is used to specify the behaviour of the update. Options are :
  HjUpdaterAPI.UpdateAlways
  HjUpdaterAPI.UpdateIfSameDependencyOnlyElseWarnOnly
  HjUpdaterAPI.UpdateIfSameDependencyOnlyElseWarnAndDeactivate
  HjUpdaterAPI.WarnOnly
  HjUpdaterAPI.WarnAndDeactivate

By default, UpdateIfSameDependencyOnlyElseWarnOnly is used.
DO NOT use UpdateAlways except if you know what you are doing. It could be useful for instance if you know that the next dependency update will not break your mod, but it's risky and could end up breaking your mod.

• otherFilesLocationRelativeToTheDll - Other files relative path inside of you mod. You do not have to add the readme, manifest and icon positions here. Those files could be other dll, resources, assets.
• modUseRuntimeRessourceLoading - True if your mod is loading files at runtime (in or after the Start() call. Default : false.
  If this value is true, then the deployment process of the update is postponed to the game closure call, so that it doesn’t affect the mod usage at runtime.

That's it ! Your mod is now able to self-update at runtime when newer versions are uploaded on the thunderstore.

Case study / Example

A simple dll mod with no other files

void Awake(){  
RegisterForUpdate(  
	"MyModNameAsInTheManifest",  
	MetadataHelper.GetMetadata(this).Version,  
	Assembly.GetExecutingAssembly().Location  
	);  
//...your other function calls  
}  

A mod with one dll but that don't update and just warn the user that a new version exists

void Awake(){  
List<string> files = new List<string>();  
files.Add('mySecondDll.dll');  
RegisterForUpdate(  
	"MyModNameAsInTheManifest",  
	MetadataHelper.GetMetadata(this).Version,  
	Assembly.GetExecutingAssembly().Location,  
	HjUpdaterAPI.WarnOnly  
);  
//...your other function calls  
}  

A mod with two dll next to each other

void Awake(){  
List<string> files = new List<string>();  
files.Add('mySecondDll.dll');  
RegisterForUpdate(  
	"MyModNameAsInTheManifest",  
	MetadataHelper.GetMetadata(this).Version,  
	Assembly.GetExecutingAssembly().Location,  
	HjUpdaterAPI.UpdateIfSameDependencyOnlyElseWarnOnly  
	files  
);  
//...your other function calls  
}  

A mod with resources loaded at runtime inside a subfolder

void Awake(){  
List<string> files = new List<string>();  
files.Add('/asset/myAssetPack.asset');  
files.Add('/font/myFont.ttf');  
files.Add('/sounds/mySoundBank.bnk');  
RegisterForUpdate(  
	"MyModNameAsInTheManifest",  
	MetadataHelper.GetMetadata(this).Version,  
	Assembly.GetExecutingAssembly().Location,  
	HjUpdaterAPI.UpdateIfSameDependencyOnlyElseWarnOnly,  
	files,  
	true  
	);  
//...your other function calls  
}  

Versions

• 1.0.0 - Initial release

Contact

I'm available on the ROR2 Official discord server (@Hijack Hornet).

Thanks

And thanks to @Bepis for explaining to me how he made BepInEx. That really helped me find how to make this API possible. Thanks to @Rein too for its encouragement in this project.