Package mindustry.mod

Class Mods.ModMeta

java.lang.Object
mindustry.mod.Mods.ModMeta
Enclosing class:
Mods
public static class Mods.ModMeta extends Object
Mod metadata information.

  • Field Details

    • name

      public String name
      Name as defined in mod.json. Stripped of colors, but may contain spaces.

    • internalName

      public String internalName
      Name without spaces in all lower case.

    • minGameVersion

      public String minGameVersion
      Minimum game version that this mod requires, e.g. "140.1"

    • displayName

      @Nullable public String displayName

    • author

      @Nullable public String author

    • description

      @Nullable public String description

    • subtitle

      @Nullable public String subtitle

    • version

      @Nullable public String version

    • main

      @Nullable public String main

    • repo

      @Nullable public String repo

    • dependencies

      public arc.struct.Seq<String> dependencies

    • softDependencies

      public arc.struct.Seq<String> softDependencies

    • hidden

      public boolean hidden
      Hidden mods are only server-side or client-side, and do not support adding new content.

    • java

      public boolean java
      If true, this mod should be loaded as a Java class mod. This is technically optional, but highly recommended.

    • iosCompatible

      public boolean iosCompatible
      If true, this script mod is compatible with iOS. Only set this to true if you don't use extend()/JavaAdapter.

    • texturescale

      public float texturescale
      To rescale textures with a different size. Represents the size in pixels of the sprite of a 1x1 block.

    • pregenerated

      public boolean pregenerated
      If true, bleeding is skipped and no content icons are generated.

    • contentOrder

      public String[] contentOrder
      If set, load the mod content in this order by content names.

    • legacyCompatible

      public boolean legacyCompatible
      Mod from an older major version that is compatible with the latest one as well.

  • Constructor Details

    • ModMeta

      public ModMeta()

  • Method Details

    • shortDescription

      public String shortDescription()

    • cleanup

      public void cleanup()

    • getMinMajor

      public int getMinMajor()

    • toString

      public String toString()
      Overrides:
      toString in class Object