Créer un plugin – 1ère édition • Minecraft.fr – Resoudre les problemes d’un serveur MineCraft

Vous êtes l'administrateur d'un serveur Minecraft exécutant Bukkit et vous recherchez constamment LE plugin parfait pour vous et vos joueurs, sans résultats? Vous avez toujours rêvé de pouvoir créer le vôtre, mais les tutoriels en anglais vous ont toujours rebuté? Alors vous êtes au bon endroit!

Cette série d'articles sur la création de plugins pour Bukkit expliquera simplement et efficacement comment créer des plugins simples, le reste étant dans la documentation de l'API Bukkit. Dans cette première tranche, vous saurez comment créer un nouveau projet de plugin vide et le compiler sous forme de fichier JAR.

Veuillez noter que ces guides ne vous apprendront pas le langage Java utilisé pour programmer les plugins; il est préférable d'avoir quelques notions de base en programmation Java avant de commencer la lecture.

Commençons sans plus attendre!

Si vous avez déjà un peu touché Java, vous savez probablement que les IDE phares (environnement de développement) de ce langage sont NetBeans et Eclipse. C'est ce dernier que nous utiliserons pour créer notre plugin parfait. Alors commencez par le télécharger: allez sur ce site, regardez les liens de téléchargement à droite (Liens de téléchargement) et prenez celui qui convient à votre ordinateur. Si vous êtes sous Windows et que vous hésitez entre les versions 32bits et 64bits, prenez celle pour Windows 32bits.

Extrayez ensuite l'archive que vous venez de télécharger où vous voulez, allez dans ce dossier et lancez Eclipse. Définissez votre espace de travail (où tous les fichiers de tous vos projets seront stockés) où vous le souhaitez (rappelez-vous!) Et cochez "Utiliser ceci par défaut et ne me demandez plus" pour qu'il ne vous demande plus jamais où votre espace de travail est. Vous pouvez fermer Eclipse.

Vous devez maintenant télécharger l'API Bukkit, la bibliothèque Bukkit où se trouvent toutes les classes nécessaires pour créer un plugin digne de ce nom. Vous pouvez télécharger la dernière version à cette adresse. Placez le fichier téléchargé dans votre espace de travail Eclipe défini ci-dessus et renommez-le en "Bukkit API.jar" pour plus de clarté.

Vous êtes maintenant prêt à créer votre projet, alors allons-y!

Une fois que tout ce qui précède est fait, je vous invite à rouvrir Eclipse et à créer un nouveau projet Java (Fichier> Nouveau> Projet Java). Appelez-le comme vous voulez (je vous conseille d'appeler votre projet comme plugin) et validez en cliquant sur Terminer.

Nous devons maintenant référencer (ajouter) l'API Bukkit dans votre projet. Pour ce faire, faites un clic droit dessus dans la fenêtre de l'explorateur de fichiers (Explorateur de packages) et accédez à Propriétés, tout en bas. Ensuite, allez dans Java Build Path, onglet Libraries et cliquez sur Add External JARs pour enfin sélectionner l'API Bukkit présente dans votre espace de travail. Validez et enregistrez le projet.

Nous devons maintenant créer un package qui contiendra toutes les sources de votre projet. Exécutez votre projet, toujours dans l'explorateur de packages, et cliquez avec le bouton droit sur le dossier src. puis sélectionnez Nouveau> Package. Dans Nom, mettez ce que vous voulez tant qu'il se présente sous la forme "com.xxx. ", Par exemple" com.natinusala.tutorielmcfr ". Si vous avez un nom de domaine / sous-domaine, il est conseillé de l'utiliser comme nom de package (par exemple" fr.minecraft.tutorielmcfr "). Confirmez avec Terminer et enregistrez le projet .

Vous devez maintenant créer la classe principale du projet, celle que Bukkit verra en premier lors de la lecture de votre plugin. Pour ce faire, faites un clic droit sur votre package créé ci-dessus et allez dans Nouveau> Classe. Appelez-le avec le même nom que votre plugin et validez.

Enfin, vous devez créer le fichier plugin.yml, qui contiendra toutes les informations dont le serveur a besoin pour utiliser votre plugin: son nom, sa version, son chemin vers la classe principale, la liste des commandes, les permissions, la description… Alors faites un clic droit sur votre projet, pas sur le dossier src ou votre package, et faites Nouveau> Fichier. Appelez ce fichier plugin.yml et validez. Ouvrez ce fichier en double-cliquant dessus et mettez-le dans:

Nom:
main: .
version:

Voici quelques explications au niveau de la main, le reste peut facilement être rempli sans mon aide. Vous devez mettre le nom de votre package suivi d'un point puis du nom de la classe principale. Ne vous inquiétez pas si vous avez deux fois le nom du plugin à la fin, c'est normal. Pour mon cas, le fichier ressemble à ceci:

nom: tutominecraftfr
principal: fr.minecraft.tutominecraftfr.tutominecraftfr
version: 0.1

La structure du projet est prête, il suffit d'ajouter du code lambda et de le compiler pour le tester.

Nous allons maintenant préparer la classe principale du plugin en insérant les codes d'importation de l'API Bukkit ainsi que deux méthodes essentielles à son bon fonctionnement.

Actuellement, votre classe principale de votre plugin devrait ressembler à ceci:

paquet ;

classe publique

Remplacez tout son contenu par cela, en mettant évidemment vos valeurs à la place de celles entre crochets:

paquet ;

import org.bukkit.plugin.java.JavaPlugin;
import java.util.logging.Logger;

classe publique étend JavaPlugin

Cela dira simplement que "ma classe est un plugin". Les importations sont utilisées pour utiliser le contenu de l'API Bukkit dans le vôtre tout en sélectionnant ce que vous voulez prendre (ici les bases d'un plugin et la fonction pour afficher du texte dans la console.

Ajoutez ensuite deux fonctions à l'intérieur de la classe, onEnable () et onDisable (), ce qui donne au final:

paquet ;

import org.bukkit.plugin.java.JavaPlugin;
import java.util.logging.Logger;

classe publique étend JavaPlugin

public void onEnable ()

public void onDisable ()

La fonction onEnable () sera exécutée par le serveur lorsque le plugin est activé, et inversement la fonction onDisable () sera exécutée lorsqu'il sera désactivé.

Plus tôt, je vous ai parlé de l'affichage du texte dans la console. C'est ce que nous allons faire, pour indiquer à l'utilisateur que le plugin a été activé.

Pour ce faire, vous devez l'ajouter à votre classe, avant la méthode onEnable (): Logger log;

Une fois cela fait, la méthode pour afficher le texte dans la console avec le préfixe [INFO] est log.info (chaîne); vous savez ce qu'il vous reste à faire! Pour mettre le préfixe [SEVERE], utilisez log.severe (chaîne).

Je vais détailler comment créer des commandes avec des autorisations et tout ce qui va avec dans une autre édition de ce guide, celle-ci étant juste sur la structure du projet et des extraits de code.

Maintenant que votre plugin est prêt, vous devez le compiler dans une archive JAR afin qu'il puisse être utilisé sur un serveur. Rien de plus simple! Enregistrez tout et allez dans Fichier> Exporter. Dans le menu qui apparaît, choisissez Fichier JAR (dans le dossier Java) puis continuez. Vérifiez ensuite le dossier src de votre projet en le déroulant dans le panneau de gauche puis le fichier plugin.yml dans le panneau de droite. Mettez l'emplacement de votre choix dans le fichier JAR, puis cliquez sur Terminer; votre plugin a été exporté là où vous l'avez indiqué!

Voilà, votre plugin est prêt à être déployé sur n'importe quel serveur exécutant Bukkit 1.1-R6 au moins ! Je vous reverrai dans le prochain épisode pour voir comment créer une commande associée à des autorisations. S'amuser.