cpw.mods.fml.common

Annotation Type Mod

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

The new mod style in FML 1.3

Author:

cpw

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	modid The unique mod identifier for this mod

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	acceptedMinecraftVersions The acceptable range of minecraft versions that this mod will load and run in The default ("empty string") indicates that only the current minecraft version is acceptable.
String	bukkitPlugin An optional bukkit plugin that will be injected into the bukkit plugin framework if this mod is loaded into the FML framework and the bukkit coremod is present.
String	certificateFingerprint Specifying this field allows for a mod to expect a signed jar with a fingerprint matching this value.
String	dependencies A simple dependency string for this mod (see modloader's "priorities" string specification)
String	modExclusionList Mods that this mod will not load with.
String	name A user friendly name for the mod
boolean	useMetadata Whether to use the mcmod.info metadata by default for this mod.
String	version A version string for this mod

Element Detail

modid

public abstract String modid

The unique mod identifier for this mod

name

public abstract String name

A user friendly name for the mod

Default:

""

version

public abstract String version

A version string for this mod

Default:

""

dependencies

public abstract String dependencies

A simple dependency string for this mod (see modloader's "priorities" string specification)

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

acceptedMinecraftVersions

public abstract String acceptedMinecraftVersions

The acceptable range of minecraft versions that this mod will load and run in The default ("empty string") indicates that only the current minecraft version is acceptable. 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:

""

bukkitPlugin

public abstract String bukkitPlugin

An optional bukkit plugin that will be injected into the bukkit plugin framework if this mod is loaded into the FML framework and the bukkit coremod is present. Instances of the bukkit plugin can be obtained via the BukkitPluginRef annotation on fields.

Returns:

The name of the plugin to load for this mod

Default:

""

modExclusionList

public abstract String modExclusionList

Mods that this mod will not load with. An optional comma separated string of (+|-)(*|modid[@value]) which specify mods that this mod will refuse to load with, resulting in the game failing to start. Entries can be prefixed with a + for a positive exclusion assertion, or - for a negative exclusion assertion. Asterisk is the wildcard and represents all mods. The only mods that cannot be excluded are FML and MCP, trivially. Other special values:

• +f indicates that the mod will accept a minecraft forge environment.
• -* indicates that the mod will not accept any other mods.

Some examples:

• -*,+f,+IronChest: Will run only in a minecraft forge environment with the mod IronChests. The -* forces all mods to be excluded, then the +f and +IronChest add into the "allowed list".
• +f,-IC2: Will run in a minecraft forge environment but will not run if IndustrialCraft 2 (IC2) is loaded alongside.
• -*: Will not run if any othe mod is loaded except MCP/FML itself.

If a mod is present on the excluded list, the game will stop and show an error screen. If the class containing the Mod annotation has a "getCustomErrorException" method, it will be called to retrieve a custom error message for display in this case. If two mods have a declared exclusion which is matched, the screen that is shown is indeterminate.

Returns:

A string listing modids to exclude from loading with this mod.

Default:

""

certificateFingerprint

public abstract 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 Mod.FingerprintWarning method firing prior to any other event on the mod.

Returns:

A certificate fingerprint that is expected for this mod.

Default:

""