Skip to content
This repository has been archived by the owner on May 26, 2018. It is now read-only.

FML mod information file

cpw edited this page Jul 22, 2012 · 25 revisions
[
{
  "modid": "mod_IronChest",
  "name": "Iron Chest",
  "description": "A simple mod adding some new chests with larger sizes, upgradeable in place. The feature chest is the crystal chest, which is see-through - this inventory contents can be viewed without opening the chest",
  "version": "3.1.1.21",
  "mcversion": "1.2.5",
  "url": "http://www.minecraftforum.net/topic/981855-",
  "updateUrl": "",
  "authors": [
    "cpw",
    "Lishid"
  ],
  "credits": "Authored by cpw, based on an original idea by Lishid",
  "logoFile": "/logo.png",
  "screenshots": [
    "shot1.png",
    "shot2.png"
  ],
  "parent":"mod_BuildCraftCore",
  
  "dependencies": [
     "mod_MinecraftForge",
     "mod_BuildCraftCore"
  ]
}
]

Inside a mod jar file, at the root, it should always be named mcmod.info. This is to simplify the info loading, and for good compatibility between launchers and FML.

If you are deploying your mod in another fashion it will search for "mod_name.info" on the classpath. This classpath search mechanism may well be removed in future, it is only to allow for visibility into the mod info panel for the many mods that still require base edits. Mods should be packaged as jars and shipped in the mods folder. If you need to perform a base modification you should request one added to forge or FML.

This file is a list- it can be more than one element in length. The modid ties the individual data sections together with their respective mods. Non-existent mods mentioned in the file are ignored. Please add all elements from the description above to avoid warning messages being logged when parsing the file.

Screenshots are currently unimplemented, but will be displayed in the panel eventually. Logos are read from the classpath- make sure the logo file is uniquely named. You are responsible for making it look good at various client screen sizes.

The "parent" property is used to connect multiple submods together under a single top level entry. URL is supposed to be a click through destination from the client (unimplemented), updateURL, currently hidden, is going to end up being a query URL where you can provide a version string that will indicate if an update is available (Protocol to follow). Authors is currently just turned into a list, but may change formatting later. Credits is a free form text field highlighted at the top of the panel where you can acknowledge whatever. It will be text wrapped in the future (but isn't at present).

A new version for the upcoming 1.3 FML. Note the version attribute, and some other minor structural changes. This is still in flux, expect changes. It is NOT readable by 1.2.5 FML.

{
  "modinfoversion": 2,
  "modlist" :
[
{
  "modid": "mod_IronChest",
  "name": "Iron Chest",
  "description": "A simple mod adding some new chests with larger sizes, upgradeable in place. The feature chest is the crystal chest, which is see-through - this inventory contents can be viewed without opening the chest",
  "version": "3.1.1.21",
  "mcversion": "1.2.5",
  "url": "http://www.minecraftforum.net/topic/981855-",
  "updateUrl": "",
  "authors": [
    "cpw",
    "Lishid"
  ],
  "credits": "Authored by cpw, based on an original idea by Lishid",
  "logoFile": "/logo.png",
  "screenshots": [
    "shot1.png",
    "shot2.png"
  ],
  "parent":"mod_BuildCraftCore",
  "requiredMods": [
     "mod_BuildCraftCore"
  ],
  "dependencies": [
     "mod_MinecraftForge",
     "mod_BuildCraftCore"
  ],
  "dependants": [
     "MySpecialSubMod",
  ],
  "useDependencyInformation": "true",
}
]
}
Clone this wiki locally