bukkit Tutoriel
Démarrer avec bukkit

Remarques

Versions

Créer un plugin

Conditions préalables

• JDK 7 ou supérieur (recommandé: JDK 8+)

Ajout de Bukkit en tant que dépendance

La méthode la plus simple pour ajouter l'API Bukkit à votre projet consiste à télécharger Bukkit.jar directement à partir du référentiel Spigot et à l'ajouter au classpath de votre projet. Les versions héritées de Bukkit sont disponibles dans le référentiel Bukkit .

L'autre consiste à l'ajouter en tant que dépendance Maven, en ajoutant les lignes suivantes à votre pom.xml :

<repositories>
    <repository>
        <id>spigot-repo</id>
        <url>https://hub.spigotmc.org/nexus/content/repositories/snapshots/</url>
    </repository>
</repositories>
<dependencies>
    <!--Bukkit API-->
    <dependency>
        <groupId>org.bukkit</groupId>
        <artifactId>bukkit</artifactId>
        <version>{VERSION}</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

Classe principale

La classe principale du plugin est le point d'entrée pour que Bukkit charge une interaction avec votre plugin. C'est une classe qui étend JavaPlugin et une seule instance devrait être créée par votre plugin. Par convention, il est bon de donner à cette classe le même nom que votre plugin.

Voici un exemple de classe de plugin principale pour le plugin "MyPlugin":

package com.example.myplugin; //{$TopLevelDomain}.{$Domain}.{$PluginName};

import org.bukkit.plugin.java.JavaPlugin;

public final class MyPlugin extends JavaPlugin {

    @Override
    public void onEnable() {
        //Called when the plugin is enabled
        getLogger().info("onEnable has been invoked!");
    }

    @Override
    public void onDisable() {
        //Called when the plugin is disabled
        getLogger().info("onDisable has been invoked!");
    }

}

Pour accéder à votre instance de plug-in à partir d'une autre classe, vous devez stocker l'instance de votre classe MyPlugin créée par Bukkit afin qu'elle soit accessible depuis l'extérieur de la classe.

public class MyPlugin extends JavaPlugin {

    private static MyPlugin instance; //Effectively final variable containing your plugin's instance

    public MyPlugin(){
        if(MyPlugin.instance != null) { //Unnecessary check but ensures your plugin is only initialized once.
            throw new Error("Plugin already initialized!");
        }

        MyPlugin.instance = this; //A plugin's constructor should only be called once
    }

    public static MyPlugin getInstance(){ //Get's your plugin's instance
        return instance;
    }

    //your other code...
}

Ensuite, pour accéder à votre classe principale à partir d'une autre classe, utilisez simplement MyPlugin.getInstance()

public class MyOtherClass {

    public void doSomethingWithMainClass(){
        MyPlugin.getInstance().getLogger().info("We just used MyPlugin");
    }

}

Créer un plugin.yml

Le fichier plugin.yml va à la racine de votre fichier jar final et fournit des informations essentielles à Bukkit pour charger votre plugin. Le plugin.yml le plus simple ressemble à ceci

name: {$PluginName}               //The name of the plugin
main: {$PackageName}.{$MainClass} //The fully qualified name of the main class.
version: {$Version}               //The plugin's version

Par exemple avec la classe MyPlugin ci-dessus

name: MyPlugin
main: com.example.myplugin.MyPlugin
version: 1.0

Créer un serveur de test sous Windows

Pour pouvoir créer un serveur, vous devez disposer du fichier spigot ou du fichier jar bukkit. Reportez-vous à la rubrique des versions pour sélectionner votre fichier.

1. Tout d'abord, créez un nouveau dossier. Dans ce dossier, placez le fichier jar spigot / bukkit.
2. Cliquez avec le bouton droit dans le dossier et choisissez Nouveau> Document texte.
3. Nommez le nouveau document start.bat, faites un clic droit dessus et cliquez sur Modifier.
4. Ajoutez le code suivant:

@echo off
java -Xms512M -Xmx1G -XX:+UseConcMarkSweepGC -jar {YOUR_JAR.jar}
pause

N'oubliez pas de changer {YOUR_JAR.jar} pour le fichier jar que vous avez téléchargé avant de démarrer ces rubriques.

5. Vous pouvez éditer -Xms pour changer la RAM minimum autorisée (Ex: -Xms1024M = 1024MB, -Xms1G = 1GB). Vous pouvez également modifier -Xmx pour modifier la RAM maximale autorisée. Assurez-vous que le maximum est plus grand que le minimum.
6. Enregistrez le fichier, fermez la fenêtre et démarrez votre fichier start.bat . Votre serveur devrait maintenant s'ouvrir. Pour exécuter le serveur, vous devez accepter le CLUF .
7. Si vous acceptez le CLUF , ouvrez eula.txt change eula=false en eula=true Cliquez sur "Enregistrer" et vous devriez maintenant pouvoir démarrer votre serveur.
8. Pour vous connecter à votre serveur, lancez start.bat , ouvrez Minecraft, ajoutez un serveur et placez localhost comme adresse IP.

BuildTools

Qu'Est-ce que c'est?

BuildTools.jar est une solution pour construire Bukkit, CraftBukkit, Spigot et l'API Spigot. Tout cela se fait sur votre ordinateur! Quelques programmes préalables sont nécessaires, mais les instructions ci-dessous vous guideront à travers tout ce que vous devez faire.

Conditions préalables

Il existe deux applications nécessaires pour utiliser BuildTools: Git et Java.

les fenêtres

Git

Pour que BuildTools fonctionne sous Windows, vous devez installer Git. Pour Windows, il est distribué via git-scm, qui peut être téléchargé ici . Installez-le où vous voulez, il fournira git bash, qui sera utilisé pour exécuter le jar BuildTools. Continuez simplement à frapper lors de l'exécution du programme d'installation.

Java

Téléchargez JRE 8 à partir d' ici et installez-le. Continuez simplement à frapper lors de l'exécution du programme d'installation.

Linux

Les commandes git et Java, ainsi que les commandes util, peuvent être installées à l'aide d'une seule commande via votre gestionnaire de paquets.

Debian / Ubuntu: sudo apt-get install git openjdk-7-jre-headless tar

CentOS / RHEL: sudo dnf install git java-1.7.0-openjdk-devel tar

Arch: pacman -S jdk8-openjdk git

Mac

Git peut être téléchargé à partir de: http://sourceforge.net/projects/git-osx-installer/files/

Il se peut que Java doive être mis à jour à partir de la version distribuée d'Apple, et même s'il a déjà été mis à jour, il peut être nécessaire de le relier pour une utilisation en shell. Veuillez suivre les étapes trouvées ici: https://gist.github.com/johan/10590467

Lancer BuildTools

1. Télécharger BuildTools.jar depuis https://hub.spigotmc.org/jenkins/job/BuildTools/lastSuccessfulBuild/artifact/target/BuildTools.jar .

2. Ouvrez votre terminal si vous êtes sous Linux ou git bash sous Windows.

   1. Git bash se trouve sur le bureau ou dans le menu Démarrer sous le nom "git bash". Il est également possible de l'ouvrir en cliquant avec le bouton droit de la souris sur n'importe quoi, car il s'agit désormais d'un élément de votre menu contextuel.

3. Accédez à l'emplacement où vous avez téléchargé BuildTools.jar ou utilisez la ligne de commande pour télécharger le fichier jar dans votre répertoire actuel.

   1. Sous Windows, vous pouvez soit utiliser la commande cd pour modifier les répertoires, soit cliquer avec le bouton droit sur l'espace vide du dossier où se trouve BuildTools.jar (NE cliquez PAS sur BuildTools.jar lui-même) et cliquez sur "git bash" pour l'ouvrir. dans votre répertoire actuel.

4. Exécutez BuildTools.jar à partir du terminal (ne double-cliquez pas sur BuildTools.jar) en procédant comme suit:

   1. Sur Linux, exécutez git config --global --unset core.autocrlf, puis lancez java -jar BuildTools.jar dans bash ou un autre shell approprié.
   2. Sous Windows, exécutez la commande ci-dessous dans la fenêtre git bash qui s'ouvre: java -jar BuildTools.jar Veuillez noter que vous devez disposer de BuildTools # 35 ou version ultérieure, les anciennes versions ne fonctionneront pas.
   3. Sur Mac, exécutez les commandes ci-dessous, exportez MAVEN_OPTS = "- Xmx2G" java -Xmx2G -jar BuildTools.jar
   4. Si vous avez besoin d'une version antérieure, vous pouvez spécifier la version à l'aide de l'argument --rev dans BuildTools, par exemple pour 1.8.8: java -jar BuildTools.jar --rev 1.8.8

5. Attendez comme il construit vos pots. Dans quelques minutes, vous devriez avoir des bocaux fraîchement compilés!

6. Vous pouvez trouver CraftBukkit et Spigot dans le même répertoire que celui où vous avez exécuté le BuildTools.jar (pour la version 1.10 de minecraft, il s'agirait de craftbukkit-1.10.jar et de spigot-1.10.jar). Vous pouvez trouver Spigot-API dans \ Spigot \ Spigot-API \ target \ (pour la version 1.10 de minecraft, ce serait spigot-api-1.10-R0.1-SNAPSHOT.jar).