Installation et configuration

Note: Ce guide conseille l'utilisation de Intellij comme editeur, ainsi que l'utilisation du plugin Minecraft Developement

Télécharger le plugin Kasterborous API

Le plugin Kasterborous est nécessaire pour pouvoir créer vos modules, il peut être installer de plusieurs manière. Toutes les ressources nécessaires sont disponible sur ce document.

Vous pouvez télécharger l'API ici

Ajouter la dépendance.

L'ajout de Kasterborous API comme dépendance est nécessaire. Ici nous l'ajouterons simple avec Intellij mais vous pouvez très bien le faire sur un autre éditeur, cependant ce guide n'inclut pas l'explication pour ces éditeurs.

Créer votre projet

Créer votre projet, ici avec l'éditeur Intellij. Il est conseiller de le faire avec le plugin Minecraft Developement, cela permettra que tout soit mis en place correctement pour vous. Sinon il faudra que vous ajoutiez manuellement vos fichier plugin.yml et config.yml, ainsi que vous mettiez en place votre fichier ressource. Rien d'insurmontable, mais plus simple avec le plugin Minecraft Developement.

Ajouter Kasterborous API comme dépendance

Il est important d'ajouter Kasterborous API comme dépendance. Sur l'éditeur Intellij voici comment faire. Il est recommandé de le faire avec Maven.

Gradle

Il faudra aller dans File/Project Structure/Module/Dependencies.

Puis ajouter la dépendance en renseignant l'emplacement du jar de Kasterborous API :

Il n'est pas nécessaire d'inclure Kasterborous API dans les fichiers compilés de votre plugin. L'onglet "scope" est donc en provided.

Maven

Premièrement il vous faudra faire une copie du projet GitHub de Kasterborous API.

Pour cela il vous faudra créer un nouveau projet en cliquant sur le bouton 'Get From VCS'

Ensuite indiquez le liens GitHub:

GitHub - KasterborousConstellation/KasterbourousUHCAPI: API pour UHC sur Minecraft.GitHub

Comme cela:

Après avoir cliqué sur le bouton Clone, ouvrez le menu Maven.

Puis dans l'onglet Lifecycle cliquez sur le bouton install.

Une fois, cela fait, la dernière version de Kasterborous API est installé localement. Les étapes précédentes ne sont donc plus nécessaire pour d'autre projet.

Vous pouvez donc ensuite ajouter dans votre fichier pom.xml les lignes suivantes:

<dependency>
    <groupId>KasterborousUHC</groupId>
    <artifactId>KasterborousUHC</artifactId>
    <version>1.4</version>
    <scope>provided</scope>
</dependency>

La version est bien sur modifiable, en fonction de la version de Kasterborous API que vous utilisez.

Et dans le fichier plugin.yml:

depend: [ KasterborousUHC ]

Ajouter la dépendance au plugin

Important: Cette étape est indispensable. Si vous avez des erreurs en console dès le démarrage de votre serveur c'est peut-être car cette étape n'a pas été faite correctement.

Il vous faut maintenant ajouter le plugin KasterborousAPI comme dépendance de votre plugin.

Voila comment il doit être ajouté et à quoi devrait ressembler votre plugin.yml:

Accéder à l'API

Pour cela il vous faudra accéder à l'instance de la classe KTBSAPI qui se trouve dans les services enregistrés de Bukkit.

Java

@Override
public void onEnable(){
    KtbsAPI api = Bukkit.getServicesManager().load(KtbsAPI.class);
}