Mod (Forge API)

@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 FMLEvent at pre-defined times during the loading of the game, based on where you have applied the Mod.EventHandler annotation.

This is a simple example of a Mod. It has the modId of "MyModId", the name of "My example mod", it is version 1.0, and depends on FML being loaded.


 package mymod;
 // Declare that this is a mod with modId "MyModId", name "My example mod", version "1.0" and dependency on FML.
 {@literal @}Mod(modId="MyModId",name="My example mod",version="1.0",dependencies="required-after:FML")
 public class MyMod {
      // Populate this field with the instance of the mod created by FML
      {@literal @}Instance("MyModId")
      public MyMod instance;

      // Mark this method for receiving an {@link FMLEvent} (in this case, it's the {@link FMLPreInitializationEvent})
      {@literal @}EventHandler public void preInit(FMLPreInitializationEvent event)
      {
          // Do stuff in pre-init phase (read config, create blocks and items, register them)
      }
 }

Required Element Summary

Required Elements
Modifier and Type Required Element and Description

java.lang.String modid
The unique mod identifier for this mod.

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

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and Description
`java.lang.String`	`acceptableRemoteVersions` A replacement for the no-longer-existing "versionRange" of NetworkMod.
`java.lang.String`	`acceptableSaveVersions` A version range specifying compatible save version information.
`java.lang.String`	`acceptedMinecraftVersions` The acceptable range of minecraft versions that this mod will load and run in The default ("empty string") indicates that the currently RUNNING minecraft version is acceptable.
`boolean`	`canBeDeactivated` If your mod doesn't have a runtime persistent effect on the state of the game, and can be disabled without side effects (minimap mods, graphical tweak mods) then you can set true here and receive the FMLDeactivationEvent to perform deactivation tasks.
`java.lang.String`	`certificateFingerprint` Specifying this field allows for a mod to expect a signed jar with a fingerprint matching this value.
`boolean`	`clientSideOnly` If true, this mod will not be loaded on the Dedicated Server environment.
`Mod.CustomProperty[]`	`customProperties` A list of custom properties for this mod.
`java.lang.String`	`dependencies` A dependency string for this mod, which specifies which mod(s) it depends on in order to run.
`java.lang.String`	`guiFactory` An optional GUI factory for this mod.
`java.lang.String`	`modLanguage` The language the mod is authored in.
`java.lang.String`	`modLanguageAdapter` The language adapter to be used to load this mod.
`java.lang.String`	`name` A user friendly name for the mod
`boolean`	`serverSideOnly` If true, this mod will not be loaded on the Client environment.
`java.lang.String`	`updateJSON` An optional URL to a JSON file that will be checked once per launch to determine if there is an updated version of this mod and notify the end user.
`boolean`	`useMetadata` Whether to use the mcmod.info metadata by default for this mod.
`java.lang.String`	`version` A version string for this mod.

- Element Detail
  - modid
```
public abstract java.lang.String modid
```
    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.
- - name
```
public abstract java.lang.String name
```
    A user friendly name for the mod
    
    Default:
    
    ""
- - version
```
public abstract java.lang.String version
```
    A version string for this mod. The version string here should be just numbers separated by dots, to make specifying dependencies() simple for other mods.
    
    Default:
    
    ""
- - dependencies
```
public abstract java.lang.String dependencies
```
    A dependency string for this mod, which specifies which mod(s) it depends on in order to run. A dependency string must start with a combination of these prefixes, separated by "-": [before, after], [required], [client, server] At least one "before", "after", or "required" must be specified. Then ":" and the mod id. Then a version range should be specified for the mod by adding "@" and the version range. The version range format is described in the javadoc here: VersionRange.createFromVersionSpec(java.lang.String) Then a ";". If a "required" mod is missing, or a mod exists with a version outside the specified range, the game will not start and an error screen will tell the player which versions are required. Example: Our example mod: * depends on Forge and uses new features that were introduced in Forge version 14.21.1.2395 "required:forge@[14.21.1.2395,);" * is a dedicated addon to mod1 and has to have its event handlers run after mod1's are run, "required-after:mod1;" * has optional integration with mod2 which depends on features introduced in mod2 version 4.7.0, "after:mod2@[4.7.0,);" * depends on a client-side-only rendering library called rendermod "required-client:rendermod;" The full dependencies string is all of those combined: "required:forge@[14.21.1.2395,);required-after:mod1;after:mod2@[4.7.0,);required-client:rendermod;" This will stop the game and display an error message if any of these is true: The installed forge is too old, mod1 is missing, an old version of mod2 is present, rendermod is missing on the client.
    
    Default:
    
    ""
- - useMetadata
```
public abstract boolean useMetadata
```
    Whether to use the mcmod.info metadata by default for this mod. If true, settings in the mcmod.info file will override settings in these annotations.
    
    Default:
    
    false
- - clientSideOnly
```
public abstract boolean clientSideOnly
```
    If true, this mod will not be loaded on the Dedicated Server environment. Will crash if both serverSideOnly and clientSideOnly are set to true.
    
    Default:
    
    false
- - serverSideOnly
```
public abstract boolean serverSideOnly
```
    If true, this mod will not be loaded on the Client environment. Will crash if both serverSideOnly and clientSideOnly are set to true.
    
    Default:
    
    false
- - acceptedMinecraftVersions
```
public abstract java.lang.String acceptedMinecraftVersions
```
    The acceptable range of minecraft versions that this mod will load and run in The default ("empty string") indicates that the currently RUNNING minecraft version is acceptable. This means ANY version that the end user adds the mod to. Modders PLEASE set this. FML will refuse to run with an error if the minecraft version is not in this range across all mods.
    
    Returns:
    
    A version range as specified by the maven version range specification or the empty string
    
    Default:
    
    ""
- - acceptableRemoteVersions
```
public abstract java.lang.String acceptableRemoteVersions
```
    A replacement for the no-longer-existing "versionRange" of NetworkMod. Specify a remote version range that this mod will accept as valid. Defaults to nothing, which is interpreted as "only this version". Another special value is '*' which means accept all versions. This is ignored if there is a NetworkCheckHandler annotation on a method in this class.
    
    Returns:
    
    A version range as specified by the maven version range specification or the empty string
    
    Default:
    
    ""
- - acceptableSaveVersions
```
public abstract java.lang.String acceptableSaveVersions
```
    A version range specifying compatible save version information. If your mod follows good version numbering practice Like this (http://semver.org/) then this should be sufficient. Advanced users can specify a SaveInspectionHandler instead.
    
    Returns:
    
    A version range as specified by the maven version range specification or the empty string
    
    Default:
    
    ""
- - certificateFingerprint
```
public abstract java.lang.String certificateFingerprint
```
    Specifying this field allows for a mod to expect a signed jar with a fingerprint matching this value. The fingerprint should be SHA-1 encoded, lowercase with ':' removed. An empty value indicates that the mod is not expecting to be signed. Any incorrectness of the fingerprint, be it missing or wrong, will result in the FMLFingerprintViolationEvent event firing prior to any other event on the mod.
    
    Returns:
    
    A certificate fingerprint that is expected for this mod.
    
    Default:
    
    ""
- - modLanguage
```
public abstract java.lang.String modLanguage
```
    The language the mod is authored in. This will be used to control certain compatibility behaviours for this mod. Valid values are currently "java", "scala"
    
    Returns:
    
    The language the mod is authored in
    
    Default:
    
    "java"
- - modLanguageAdapter
```
public abstract java.lang.String modLanguageAdapter
```
    The language adapter to be used to load this mod. This overrides the value of modLanguage. The class must have a public zero variable constructor and implement ILanguageAdapter just like the Java and Scala adapters. A class with an invalid constructor or that doesn't implement ILanguageAdapter will throw an exception and halt loading.
    
    Returns:
    
    The full class name of the language adapter
    
    Default:
    
    ""
- - canBeDeactivated
```
public abstract boolean canBeDeactivated
```
    If your mod doesn't have a runtime persistent effect on the state of the game, and can be disabled without side effects (minimap mods, graphical tweak mods) then you can set true here and receive the FMLDeactivationEvent to perform deactivation tasks. This does not affect administrative disabling through the system property fml.modStates or the config file fmlModState.properties. The mod will only be deactivated outside of a running game world - FML will never allow mod deactivation whilst a game server is running.
    
    Returns:
    
    if this mod can be deactivated whilst the game is open.
    
    Default:
    
    false
- - guiFactory
```
public abstract java.lang.String guiFactory
```
    An optional GUI factory for this mod. This is the name of a class implementing IModGuiFactory that will be instantiated on the client side, and will have certain configuration/options guis requested from it.
    
    Returns:
    
    The name of a class implementing IModGuiFactory
    
    Default:
    
    ""
- - updateJSON
```
public abstract java.lang.String updateJSON
```
    An optional URL to a JSON file that will be checked once per launch to determine if there is an updated version of this mod and notify the end user. For more information see ForgeVersion. Format is defined here: https://gist.github.com/LexManos/7aacb9aa991330523884
    
    Returns:
    
    URL to update metadata json
    
    Default:
    
    ""
- - customProperties
```
public abstract Mod.CustomProperty[] customProperties
```
    A list of custom properties for this mod. Completely up to the mod author if/when they want to put anything in here.
    
    Returns:
    
    an optional list of custom properties
    
    Default:
    
    {}

Annotation Type Mod

Required Element Summary

Optional Element Summary

Element Detail

modid

name

version

dependencies

useMetadata

clientSideOnly

serverSideOnly

acceptedMinecraftVersions

acceptableRemoteVersions

acceptableSaveVersions

certificateFingerprint

modLanguage

modLanguageAdapter

canBeDeactivated

guiFactory

updateJSON

customProperties