Metadata and litemod.json
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
dev:litemod.json [2014/12/23 21:28] mumfrey |
dev:litemod.json [2014/12/23 21:33] mumfrey |
||
|---|---|---|---|
| Line 5: | Line 5: | ||
| ========================= | ========================= | ||
| - | From 1.6 onwards, LiteLoader now supports much more comprehensive metadata to be packaged with the mod, some of which are required and other metadata are optional. The metadata are packaged in a file called [[litemod.json]] in the root of the litemod file, and this file replaces the legacy [[version.txt]] used for versioning in previous releases. | + | From 1.6 onwards, LiteLoader now supports much more comprehensive metadata to be packaged with the mod, some of which are required and other metadata are optional. The metadata are packaged in a file called ''litemod.json'' in the root of the litemod file, and this file replaces the legacy [[version.txt]] used for versioning in previous releases. |
| ====Required values==== | ====Required values==== | ||
| Line 25: | Line 25: | ||
| * **tweakClass** | * **tweakClass** | ||
| + | |||
| used to specify a [[info:tweak]] class within your mod's container. This allows your mod to take full advantage of [[info:tweak|Tweaker]] functionality by hooking into the tweak system directly. | used to specify a [[info:tweak]] class within your mod's container. This allows your mod to take full advantage of [[info:tweak|Tweaker]] functionality by hooking into the tweak system directly. | ||
| * **classTransformerClasses** | * **classTransformerClasses** | ||
| + | |||
| An array or comma-separated list of [[ClassTransformer]] class names which will be injected into the ClassLoader. | An array or comma-separated list of [[ClassTransformer]] class names which will be injected into the ClassLoader. | ||
| * **dependsOn** | * **dependsOn** | ||
| + | |||
| An array or comma-spearated list of mod **names** (as per the metadata "name" entry above) which must also be present to allow your mod to load. If a dependency is missing then the mod will not be loaded but it will be shown in the mods list and will indicate the missing dependencies which caused it to fail to load. | An array or comma-spearated list of mod **names** (as per the metadata "name" entry above) which must also be present to allow your mod to load. If a dependency is missing then the mod will not be loaded but it will be shown in the mods list and will indicate the missing dependencies which caused it to fail to load. | ||
| * **requiredAPIs** | * **requiredAPIs** | ||
| + | |||
| An array or comma-separated list of [[API]] ids. Used to declare that your mod requires one or more additional APIs in order to run. If a required API is missing then the mod will not be loaded but it will be shown in the mods list and will indicate the missing API which caused it to fail to load. | An array or comma-separated list of [[API]] ids. Used to declare that your mod requires one or more additional APIs in order to run. If a required API is missing then the mod will not be loaded but it will be shown in the mods list and will indicate the missing API which caused it to fail to load. | ||
| * **injectAt** | * **injectAt** | ||
| + | |||
| Alters the position in the classpath at which the mod will be injected. **Not currently working as at Minecraft 1.7.** | Alters the position in the classpath at which the mod will be injected. **Not currently working as at Minecraft 1.7.** | ||
| ====Extra values==== | ====Extra values==== | ||
| - | Additionally, there are some additional metadata which are standardised for the purposes of providing information to the in-game mod list provided by third party add-ons such as VoxelMenu and the Minecraft Forge "mods" list. These additional keys are: | + | Additionally, there are some extra metadata which are standardised for the purposes of providing information to the in-game mod list provided by third party add-ons such as VoxelMenu and the Minecraft Forge "mods" list. These additional keys are: |
| * **author** | * **author** | ||
