Package net.neoforged.fml.common

Annotation Interface Mod

@Retention(RUNTIME) @Target(TYPE) public @interface Mod
This defines a Mod to FML.

Any class found with this annotation applied will be loaded as a mod entrypoint for the mod with the given ID.
A mod loaded with the javafml language loader may have multiple entrypoints. Entrypoints with the least depends() are run first. Entrypoints for all dist()s are always run before entrypoints for a single dist().

  • Required Element Summary

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

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    depends
    A list of mod IDs which are all required to be present in order to load this mod entrypoint.
    net.neoforged.api.distmarker.Dist[]
    dist
    Returns the side to load this mod entrypoint on.

  • Element Details

    • value

      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.

    • dist

      net.neoforged.api.distmarker.Dist[] dist
      Returns the side to load this mod entrypoint on.
      Returns:
      the side to load this mod entrypoint on
      Default:
      {CLIENT, DEDICATED_SERVER}

    • depends

      String[] depends
      A list of mod IDs which are all required to be present in order to load this mod entrypoint.
      Default:
      {}