Developer documentation

FE developer information

The information here is mainly for developers.

Setting up the API

Development builds of FE are on the MinecraftForge repository. To use them during development, add / append the following options to your build.gradle:

repositories {
        maven {
            name = "forge"
            url = "http://files.minecraftforge.net/maven"
        }
        maven {
		name = "sk89q"
		url = "http://maven.sk89q.com/repo/"
	}
	maven {
		name = "sponge"
		url = "http://repo.spongepowered.org/maven/"
	}
}

dependencies {
	compile group: "com.forgeessentials", name: "forgeessentials", version: "1.4.4-SNAPSHOT", classifier: "dev", changing: true
}

To allow all features of FE to work correctly, you will also need to add --tweakClass com.forgeessentials.core.preloader.FELaunchHandler --mixin mixins.forgeessentials.json to the launch arugments.

Using the API

Use com.forgeessentials.api.APIRegistry as the main entry point to FE functions.

If you're using 1.3.0.2 or the 1.7.10 versions please use net.minecraftforge.permission.PermissionManager.registerPermission. More information can be found in the javadocs you can view when developing with FE in your IDE.

Any other queries

Please do not hesitate to contact us on IRC.

We are on irc.esper.net, channel #forgeessentials.