API LaunchMyCraft

Cette API vous permet de créer, de modifier ou de supprimer un launcher depuis votre propre service.

Son utilisation est très simple et entièrement détaillée ci-dessous. Allez y jeter un oeil !

L'API de LaunchMyCraft est très simple d'utilisation. Il suffit d'envoyer une requête POST à l'adresse suivante :

http://www.launchmycraft.fr/api/{action}/{id}

{action} est l'action que vous souhaitez effectuer, et {id} l'ID du launcher concerné si nécessaire. Si jamais l'URL est malformée, vous tomberez sur la page d'erreur du site.

Il existe quatre actions :

Action Description
create Crée un nouveau launcher.
edit Modifie un launcher existant.
delete Supprime un launcher existant.
get Affiche les informations d'un launcher.

Dans la requête, vous devez inclure en données POST toutes les informations requises pour l'action en question. Par exemple, pour la création il faudra fournir le nom du serveur, son adresse... Pour la modification il faudra fournir tout ce qu'on veut modifier plus le mot de passe du launcher... Les données requises pour chaque action sont listées dans les catégories d'en dessous.

Lors d'une requête vers l'API, la page effectuera l'action demandée puis affichera une réponse en JSON pour donner le retour des opérations.

La réponse sera calquée sur ce modèle :

{ 'error' : false, 'message' : '', 'data' : {} }

Vous vous en doutez certainement, le champ error est un booléen disant si tout s'est bien passé ou non. En cas d'erreur, message contiendra un petit message indiquant du problème rencontré. Sinon, data contiendra toutes les informations nécessaires à la complétion de l'action, comme par exemple l'ID du module créé.

Le détail du contenu de data est, encore une fois, listé dans les catégories du dessous.

Voici la liste des paramètres (que ce soit ceux de la requête ou ceux du champ data de la réponse) utilisés pour l'API.

Attention ! Les révisions s'incrémentent toutes seules lors de la modification du launcher, vous n'avez donc pas à les modifier vous même.

Nom du paramètre Valeur / Description
servername Nom du serveur.
serveraddress Adresse du serveur.
serverlogo Adresse URL du logo du serveur.
serverlogofilename Est utilisé pour afficher le nom du fichier actuellement utilisé pour le logo du serveur, dans le formulaire de modification.
gameversion Nom de la version à utiliser. Laissez ce champ vide pour prendre la dernière version du jeu (et donc le mettre à jour dès qu'une nouvelle version sort). Vous pouvez récupérer la liste de toutes les versions disponibles à partir d'ici.
allowcracked 0 ou vide pour ne pas autoriser les versions crackées, 1 sinon.
customjarurl Adresse URL du fichier JAR moddé à utiliser pour le jeu. Laisser vide pour ne pas activer cette fonctionnalité.
customjarfilename Est utilisé pour afficher à l'utilisateur le nom du fichier JAR moddé actuellement utilisé lors de la modification du launcher. Il faut bien qu'il sache quel JAR est en ligne !
customjarrevision La révision actuelle du fichier JAR moddé.
customresourcesurl Adresse URL du fichier ZIP à utiliser pour les ressources supplémentaires. Laisser vide pour ne pas activer cette fonctionnalité.
customresourcesfilename Même chose que pour customjarfilename, mais pour les ressources supplémentaires.
customresourcesrevision La révision actuelle des ressources personnalisées.
enableautoconnection Faire en sorte (1) ou non (0) que le launcher se connecte automatiquement au serveur au lancement du jeu.
theme L'ID de l'apparence du launcher. La liste des correspondances entre les noms affichés dans le formulaire et leurs ID peut se récupérer ici.
password Le mot de passe à utiliser si jamais on veut modifier ce launcher.

Pour créer un launcher, vous devez utiliser l'action create. Les données POST doivent contenir toutes les informations du launcher à créer, le strict minimum étant de ne mettre que l'adresse du serveur et le mot de passe.

Le contenu du champ data de la réponse est très simple :

Nom du champ Valeur / Description
launcherid ID du launcher créé.

La modification d'un launcher est calquée sur la création. Elle se fait via l'action edit, suivie de l'ID du launcher concerné. Le champ password doit contenir, évidemment, le mot de passe du launcher. Et le data de la réponse est vide.

Pour supprimer un launcher, il faut utiliser l'action delete avec évidemment l'ID du launcher que l'on veut supprimer. Le seul paramètre à passer est le champ password, qui doit contenir le mot de passe du launcher. Ici aussi, data est vide.

L'obtention d'informations se fait via l'action get, encore une fois avec l'ID du launcher. Pour une fois, il n'y a aucun paramètre à passer. Par contre, data contient toutes les informations du launcher.

Si vous souhaitez télécharger un launcher sous sa forme exécutable, vous pouvez le faire à partir de cette URL :

http://www.launchmycraft.fr/getlauncher/{id}/executable/{type}?url={url}

id est, vous vous en doutez, l'ID du launcher à récupérer. Le type est soit jar (par défaut) ou exe, et url est l'adresse de la page de news à afficher dans le launcher (proprement encodée, donc avec par exemple des %20 à la place des espaces). L'adresse par défaut est celle des news officielles du jeu.

Si jamais l'adresse est invalide, vous tomberez sur la page d'erreur du site.

Si en revanche vous voulez récupérer l'URL de la page contenant l'applet d'un launcher, c'est simple, la voici :

http://www.launchmycraft.fr/getlauncher/applet?id={id}

Ici encore, {id} est l'ID du launcher en question.

Le générateur de logos de LaunchMyCraft s'utilise très facilement. En effet, les images se récupèrent comme des images normales stockées sur un site web, sauf qu'il n'y a pas de .png à la fin.

Voici l'adresse à utiliser pour récupérer les logos :

http://www.launchmycraft.fr/tools/logocreator/{texte}/{taille}

Vous l'aurez compris, {texte} est à remplacer par le texte de votre choix proprement encodé et {taille} par la taille de la police désirée. La seconde option est facultative, la taille par défaut étant de 150.

LaunchMyCraft intègre également un convertisseur de JAR en EXE, qui vous permet de spécifier la version minimale de Java nécessaire pour exécuter le programme ainsi qu'un icône pour l'exécutable.

Le EXE d'une archive JAR peut se récupérer à cette URL :

http://www.launchmycraft.fr/tools/jarconverter

Vous devez passer en paramètres l'archive à convertir (jarfile), la version minimale de Java requise (minjre) et éventuellement un icône au format ICO (iconfile).