Configurer IntelliJ IDEA

Cet article décrit comment configurer votre espace de travail IntelliJ IDEA pour le développement de plugins avec SpongeAPI et un build system comme Maven et Gradle ou le Plugin de Déveleoppement Minecraft.

Si vous souhaite créer votre projet à partir de zéro, passez jusqu’aux sections Gradle ou Maven. Utiliser le plugin Minecraft Dev configure un point de départ fonctionnel et élimine certaines suppositions lors de la mise en route de votre projet.

Utiliser le Plugin Minecraft Dev d’IDEA pour Créer un Point de Départ Fonctionnel

Le plugin Minecraft Development pour IntelliJ est un bon plugin créé par un membre de la communauté qui rend la création de projet de plugin bien plus simple tout en fournissent des fonctionnalités utiles pour le développement. Par défaut, ça va créer un projet qui utilise Gradle en build tool.

Installer le Plugin Minecraft Dev

Ce plugin est disponible sur le répertoire de plugins IntelliJ JetBrains.

Grâce à ça, vous pouvez installer le plugin à travers le navigateur de plugins interne d’IntelliJ. Naviguez vers File -> Settings -> Plugins puis cliquez sur le bouton Browse Repositories... en bas de la fenêtre. Dans la boîte de recherche, cherchez simplement Minecraft. Vous pouvez l’installez depuis ici et redémarrer IntelliJ pour activer le plugin.

Créer Votre Project à partir d’un Modèle

  • Ouvrez IntelliJ IDEA.

  • Cliquez sur Create New Project.

  • Sélectionnez Minecraft dans le popup.

  • Assurez-vous que votre Project SDK est défini à une version de Java 8/1.8.

  • Sélectionnez Sponge plugin pour votre type de projet, puis cliquez sur Next.

  • Entrez votre Group ID, Artifact ID, et Version.

    • Votre Group ID correspond généralement à votre nom de package Java. Voir Classe Principale du Plugin pour plus de détails.

    • Votre Artifact ID correspond généralement au plugin ID que vous avez choisi plus tôt, par exemple myplugin.

    • C’est à vous de choisir votre Version. Voir Numéros de Version pour plus de détails.

  • Sélectionnez votre build tool désiré, soit Gradle ou Maven, puis cliquez sur Next.

  • Vérifiez votre Plugin Name et Main Class Name pour vous assurez qu’ils ont les valeurs souhaitées.

  • Spécifiez les description, auteurs, site web et dépendances de votre plugin si vous le souhaitez.

  • Cliquez sur Next pour continuer.

  • Vérifiez le nom de votre projet, la position, et les informations de module, puis cliquez sur Finish.

  • Le plugin va créer un fichier java principal en point de départ, avec le logger déjà injecté. Vous pouvez ajouter une instruction logger.info() dans l’event handler onServerStart pour vérifier que votre plugin fonctionne lorsque vous le lancez.

Éditer la Configuration du Projet

Référez-vous aux sections de configuration Gradle ou Maven, dépendant de ce que vous avez choisi lors de la création du projet.

Créer un Plugin à partir de Zéro – Gradle

  • Ouvrez IntelliJ IDEA.

  • Cliquez sur Create New Project.

  • Sélectionnez Gradle dans le popup.

  • Si vous le souhaitez, sélectionnez des bibliothèques supplémentaires et les frameworks que vous désirez, par exemple Kotlin.

  • Assurez-vous que votre Project SDK est défini à une version de Java 8/1.8.

  • Cliquez sur Next pour continuer.

  • Entrez votre Group ID, Artifact ID, et Version.

    • Votre Group ID correspond généralement à votre nom de package Java. Voir Classe Principale du Plugin pour plus de détails.

    • Votre Artifact ID correspond généralement au plugin ID que vous avez choisi plus tôt, par exemple myplugin.

    • C’est à vous de choisir votre Version. Voir Numéros de Version pour plus de détails.

  • Cliquez sur Next deux fois, nommez votre projet puis cliquez sur Finish.

  • Le projet sera créé sans répertoire src. Si vous ajoutez des fichiers java au mauvais emplacement sous le projet, ils seront ignorés et non compilés, c’est alors une bonne idéee d’activer la case à cocher « Create directories for empty content roots », trouvée dans :

    • Windows: File -> Settings -> Build, Execution, Deployment -> Gradle

    • Mac: Intellij IDEA -> Preferences -> Build, Execution, Deployment -> Build Tools -> Gradle

  • Activer Use Auto-import au même endroit permettra de faire en sorte que les changements dans la configuration gradle seront rechargés automatiquement sans qu’IDEA vous demande à chaque fois.

  • Dès l’activation de ces paramètres, un dossier /src/main/java devrait être créé, où vous pouvez commencer à créer vos fichiers du plugin.

Éditer le Script de Build

  • Ouvrez build.gradle dans le navigateur et ajoutez les dépendances.

  • Éditez le script de build conformément aux instructions à Configurer Gradle.

  • Ouvrez l”Onglet Gradle sur la droite de la fenêtre IntelliJ et appuyez sur le bouton refresh.

  • Gradle a bien été configuré! Maintenant vous pouvez commencer à coder votre plugin.

Créer un Plugin à partir de Zéro – Maven

Créer Votre Projet

  • Ouvrez IntelliJ IDEA.

  • Cliquez sur Create New Project.

  • Sélectionnez Maven dans le popup.

  • Assurez-vous que votre Project SDK est défini à une version de Java 8/1.8.

  • Cliquez sur Next pour continuer.

  • Entrez votre Group ID, Artifact ID, et Version.

    • Votre Group ID correspond généralement à votre nom de package Java. Voir Classe Principale du Plugin pour plus de détails.

    • Votre Artifact ID correspond généralement au plugin ID que vous avez choisi plus tôt, par exemple myplugin.

    • C’est à vous de choisir votre Version. Voir Numéros de Version pour plus de détails.

  • Cliquez sur Next.

  • Entrez le nom de votre projet et cliquez sur Finish.

Éditer la Configuration du Projet

  • Ouvrez pom.xml dans le navigateur.

  • Éditez la configuration de build conformément aux instructions à Configurer Gradle.

  • Actualisez votre projet Maven.

  • Importer les modifications Maven, si vous y êtes invité.

Tester Votre Plugin

Les instructions suivantes sont un moyen rapide de tester votre plugin, mais ne sera pas le moyen le plus efficace de développer de manière itérative.

Pour faire un fichier .jar, à l’aide de Gradle :

  • Allez dans View -> Tool Windows -> Gradle

  • Sous Tasks -> Build, cliquez sur jar

  • Le processus de build devrait créer le jar sous build\libs

Pour faire un fichier .jar, à l’aide de Maven :

  • Allez dans View -> Tool Windows -> Maven Projects

  • Dans la fenêtre Maven Projects, développez le nom de votre projet

  • Sous Plugins, développez jar

  • Double-cliquez sur jar:jar

  • Le processus de build devrait créer le jar sous target

Copiez votre fichier jar vers le dossier mods d’un serveur Sponge fonctionnel, puis redémarrezz le serveur pour tester.

Pour un processus de développement plus efficace, voir Debugging d’un plugin pour des instructions pour démarrer le serveur Sponge et votre plugin à partir d’IDEA. Ce processus autorise l’hot-swapping, vous permettant de changer le code du plugin sans redémarrer le serveur.

Importer Un Projet Existant (Gradle ou Maven)

Si vous avez déjà commencé votre projet et que vous souhaitez l’importer à nouveau à un stade ultérieur, vous devrez l’importer au lieu de le recréer à l’intérieur de votre IDE :

  • Cliquez sur File > Open ou Import Project.

  • Gradle : Naviguez vers le fichier build.gradle du projet et sélectionnez-le.

  • Maven : Naviguez vers le fichier pom.xml du projet et sélectionnez-le.

  • Assurez-vous que les paramètres correspondent à ce que vous souhaitez et cliquez sur Ok.

Intégration de Git

JetBrains donne une documentation en profondeur sur l’utilisation de leur intégration de Git:

https://www.jetbrains.com/help/idea/using-git-integration.html