The following file is the description, author and etc info about your mod. This file is based on the JSON language to define a list of mods and various properties for each. Multiple mods can listed in the same mcmod.info file.
[ { "modid": "TXMMC", "name": "TXM-MC", "description": "Testing to create my first Mod.", "version": "1.5", "mcversion": "1.7.10", "url": "https://TXM-MC.homeserver.com/", "updateUrl": "https://TXM-MC.homeserver.com/mods/TXM-MC/", "authorList": [ "TXM-MC", "The_X_Master", "Jesper 'TXM-MC' Johansson" ], "credits": "Thanks for testing TXM-MC's new mod", "logoFile": "server-icon.png", "screenshots": [], "dependencies": [] } ]
| Property | Type | Description |
|---|---|---|
| "modid" | string | Ties the individual data sections together with their respective mods. Non-existent mods mentioned in the file are ignored. |
| "name" | string | The mod's human-readable name |
| "description" | string | A simple paragraph that explains what your mod can do and/or contains. |
| "version" | string | The mod's version. This can contain letters due to it's a "string". Eg. "TXM-MC 1.1.20 Alpha" or simplified: "1.1.20" |
| "mcversion" | string | The Minecraft's version. witch version the mod are coded for, eg. "1.7.10". |
| "url" | string | The mod's website, forum thread, GitHub project link, or whatever page you'll reference to. eg. "https://TXM-MC.homeserver.com/" |
| "updateUrl" | string | Currently unusable cause it's unimplemented but will eventually be used to get automatic updates from the mod creator. |
| "authorList" | array | The mod's authors in an list (Array) format separated with a , (comma). eg. "authorList": ["TXM-MC", "Jesper 'TXM-MC' Johansson"] |
| "credits" | string | Whatever you like to acknowledge but keep it short as this text-field is not wrapped in the mod-list. |
| "logoFile" | string | The resource path for the logo image file to display as an "Icon" for the mod. simply add the icon where this file is located and just type the name and file type. eg. "TXM-MC-Mod_logo.png". Logo usually is 128x128 pixels and most commonly in .png (Portable Network Graphics). |
| "screenshots" | array | Currently unusable cause it's unimplemented but will eventually be used to be displayed in the info screen. |
| "parent" | string | Used to connect multiple "SubMods" together under a single "Top Level Entry". Avoids cluttering up the info screen with mods that don't do anything on their own but are rather modules or libraries of other mods. |
| "requireMods" | array | The list of mods used to run this mod. Any mods listed here but not installed/found will prevent this mod from loading. Minecraft will shut down with an error screen explaining the cause to the user. This is more user-friendly than simply crashing. It's recommended to include "Forge" if your mod uses Forge methods (as opposed to just FML methods). This will NOT specify mod-loading order, in other meaning your mod might load before any depending mods required for your mod load without any errors. use "dependencies" to specify mod-loading order. |
| "dependencies" | array | List of optional mods that SHOULD load BEFORE your mod. If a mod is listed in both "requireMods" and "dependencies" will ALWAYS load before your mod. |
| "dependants" | array | List of optional mods that SHOULD load AFTER your mod. If you created like an permission mod and would load before other permission mods, you should list them here. |
| "useDependencyInformation" | boolean | Normally should be set to "true", if not or if the property is not defined, the previous three properties will be ignored entirely. Dependency info can also be "overriden" by using a @Mod(useMetadata=false, dependencies= in the Java code annotation for FML mods. |