Utiliser le système de recherche de mise à jour de Forge

AymericRed

Sommaire

Introduction
Pré-requis
Code
- Fichier json
- Classe principale
Bonus
Résultat
Crédits

Introduction

Dans ce mini-tutoriel, je vais vous montrer comment utiliser le système de recherche de mise à jour de Forge pour votre mod qui existe depuis la 1.8.

Pré-requis

Créer la base de son mod
Avoir un hébergeur (github, dropbox…) pour y mettre le fichier json qui contiendra les versions

Code

Le fichier json :

Forge va utiliser un fichier json où vos versions seront listées afin de trouver les mises à jour, ce fichier doit avoir une certaine organisation :
Voici le fichier “nu” :

   {
     "homepage": "Url ou se trouvent les versions de votre mod",
     "promos": {
       "1.8.9-latest" : "1.2.4",
       "1.8.9-recommended" : "1.1.0"
     },
     "1.8.9" : {
       "1.2.0" : "Ajout du bloc de MFF et de son item",
       "1.1.0" : "Autre chose"
     }
   }

La valeur de “homepage” sera l’url de la page où sont listées les versions de votre mod, ce sera affiché dans la description de votre mod dans le menu “Mods”.

Dans “promos” seront listées les versions de votre mods, pour chaque version de Minecraft de votre mod, la version de Minecraft doit être suivie de “-latest” pour indiquer que c’est la dernière version ou de “-recomended” pour indiquer que la version est recommandée (il n’y aucun bug (ou presque)).

Ensuite, dans “1.8.9” (à changer en fonction de votre version de Minecraft) seront listées les versions de votre mod avec les changements qu’elles contiennent (c’est un changelog).

Ce fichier devra être hébergé sur internet (github/dropbox…), vous pouvez lui donnez le nom que vous voulez.
Vous pouvez aussi utiliser un plugin gradlew qui permet de générer le fichier automatiquement (voir le Bonus).

La classe principale :

Il ne reste plus qu’à indiquer à Forge d’utiliser le fichier que vous venez de créer, dans l’annotation @Mod, ajoutez

updateJSON="url du fichier json"

Veillez à mettre l’url du fichier “raw”, c’est à dire l’url du fichier nu, sinon Forge ne pourra pas correctement lire le json.

Bonus

Vous pouvez utiliser le ForgeGradlew plugin qui permet de générer automatiquement ce fichier et le changelog du mod.

Résultat

Dans la liste des mods, Forge indiquera le changelog de votre mod et l’url où trouver les versions et si il n’est pas à jour, un “U” vert sera affiché à côté du mod.

Vous allez dire que il faut aller le chercher pour savoir qu’une mise à jour est disponible, mais heuresement, à partir de la 1.9-12.16.1.1887 (donc aussi en 1.10 et +), une gemme pour dire qu’il y a une mise à jour est affiché sur le menu principal.

Crédits

Rédaction :

AymericRed

Correction :

BrokenSwing qui a trouvé une petite faute ^^

Ce tutoriel de AymericRed publié sur Minecraft Forge France est mis à disposition selon les termes de la licence Creative Commons Attribution - Pas d’Utilisation Commerciale - Partage dans les Mêmes Conditions 4.0 International

Sommaire des tutoriels

SCAREX

Moi en bonus je mettrai mon plugin gradle, je dis ça je dis rien…

AymericRed

Ta as raison ^^ C’est chose faite

RedRelay

Est-ce que Forge avertis l’utilisateur qu’une mise a jour est disponible ?

AymericRed

Pas en 1.8.9, c’est juste un “U” vert dans la liste des mods, peut-être dans des versions ultérieures (en 1.10 il me semble, à vérifier).
EDIT : Oui, à partir de la 1.9-12.16.1.1887 : “Nouvelle gemme de mise à jour de mod dans le menu principal, elle est similaire à la gemme de notification Realms.”

robin4002

comme ça :