Mods.toml
Le fichier mods.toml (contenu dans le dossier resources) définit les métadonnées de votre mod. Ses informations peuvent être consultées par les utilisateurs depuis l'écran principal du jeu, via le bouton "Mods". Un seul fichier d'information peut décrire plusieurs mods.
Généralement, il est structuré comme ceci :
danger
Le champ license du fichier mods.toml est obligatoire. S'il n'est pas fourni, une erreur se produira. Consultez les licences disponibles à l'adresse https://choosealicense.com/.
modLoader="javafml"
loaderVersion="[37,)"
license="All rights reserved"
[[mods]]
modId="monmod"
version="0.0.1"
displayName="Mon mod"
updateJSONURL="https://masuperurl.fr/updates.json"
displayURL="https://masuperurl.fr/monmod"
logoFile="monmod.png"
credits="Mon mod est en Java, merci !"
authors="Toute la communauté"
description='''
Cette description peut être très longue
et en plusieurs lignes !
'''
[[dependencies.monmod]]
modId="forge"
mandatory=true
versionRange="[37,)"
ordering="NONE"
side="BOTH"
[[dependencies.monmod]]
modId="minecraft"
mandatory=true
versionRange="[1.17.1,1.18)"
ordering="NONE"
side="BOTH"
Propriété | Type | Description |
---|---|---|
modid | String | Le modid du mod (doit correspondre avec celui de la classe principale). |
version | String | La version du mod. |
displayName | String | Le nom affiché pour le mod. |
updateJSONURL | String | L'URL vers le fichier JSON servant au système d'update checker de Forge |
displayURL | String | Le lien de la page du mod. |
logoFile | String | Le nom du fichier correspondant au logo du mod (celui-ci doit être placé dans le dossier resources). |
credits | String | Une chaines de caractère qui contient les remerciements que vous souhaitez mentionner. |
authors | String | Les auteurs du mod. |
description | String | La description du mod |
dependencies | List | La liste des dépendances du mod |