equilinoxmodkitproject / equilinox-mod-kit Goto Github PK

The Equilinox Mod Kit is an open source modding API for the indie game Equilinox which was developed single-handedly by Karl Wimble (ThinMatrix). It is part of the Equilinox Mod Kit Project aiming to bring simple and straightforward modding support to Equilinox.

If you simply want to add modding support to Equilinox and are not interested in creating mods the Equilinox Mod Kit is the wrong project for you. Head over to the Equilinox Mod Loader repository for detailed instructions on adding modding support and installing mods.

• Downloads
• Wiki
• Website
• Discord

The Equilinox Mod Kit and Mod Loader currently are in public beta and rough edges are to be expected.

Making a mod is as simple as adding the Equilinox Mod Kit as a dependency to your project and creating a class extending EquilinoxMod.

public class Mod extends EquilinoxMod {
	@Override
	public void preInit( PreInitializer pInit ) {
	}
	
	@Override
	public void init( Initializer initializer ) {
	}
}

All your mod is missing now is the @ModInfo annotation.

@ModInfo(
	id = "example.mod",
	name = "Mod",
	version = "0.0.1",
	author = "Example",
	description = "",
	thumbnail = ""
)

For more detailed tutorials visit the Wiki and for examples take a look at our Example Mods repository.

As an open source community project, EMKP is grateful for every helping hand. It can be as simple as reporting a bug or requesting a new feature that you think is crucial for the Equilinox Mod Kit.
If you are more into contributing code read into our Contributing Guidelines.