net.minecraftforge.fml.common

Annotation Type Mod

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface Mod

This defines a Mod to FML. Any class found with this annotation applied will be loaded as a Mod. The instance that is loaded will represent the mod to other Mods in the system. It will be sent various subclasses of ModLifecycleEvent at pre-defined times during the loading of the game.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	value The unique mod identifier for this mod.

Element Detail

value

public abstract java.lang.String value

The unique mod identifier for this mod. Required to be lowercased in the english locale for compatibility. Will be truncated to 64 characters long. This will be used to identify your mod for third parties (other mods), it will be used to identify your mod for registries such as block and item registries. By default, you will have a resource domain that matches the modid. All these uses require that constraints are imposed on the format of the modid.