Mod documentation

This page covers the ModRegistry, Mod, and ModInfo classes.

`ModRegistry`

A purely static class that should be used only to register mods with Equilimod.

Name	Arguments	Return type	Description
`registerMod`	`Mod`	`void`	Registers the given mod with the internal system, allowing the mod to work.
`getMods`	None	`Map<String, Mod>`	Returns a map of all of the registered mods - it is not recommended to use this.

Represents a mod in Equilimod, being able to be registered with the system.

The constructor for Mod takes a single JavaScript object with the properties for the mod:

Name	Type	Description
`name`	`String`	The user-friendly name of the mod.
`version`	`String`	The version of the mod (must follow the Semver standard).
`author`	`String`	The author(s) of the mod.
`init`	`function()`	The function to be run when the mod is initiated.

Name	Arguments	Return type	Description
`getInfo`	None	`ModInfo`	Returns basic information about the mod, provided in the mod's constructor.

Stores basic information about a mod.

Name	Arguments	Return type	Description
`getName`	None	`String`	Returns the user-friendly name of the mod.
`getVersion`	None	`Version` (https://github.com/zafarkhaja/jsemver)	Returns the semantic version of the mod.
`getAuthor`	None	`String`	Returns the author(s) of the mod.
`getDescription`	None	`String`	Returns the mod description.
`isEnabled`	None	`boolean`	Returns true if the mod is enabled during gameplay.

Thanks for visiting this wiki. Don't forget to check out Equilinox!

The wiki and the modding framework are still heavily under development, so not all content is available yet.