Modding : créer son premier plugin Hytale

Vous rêvez de personnaliser votre expérience Hytale, d’ajouter de nouvelles fonctionnalités ou de créer des mécaniques uniques ? Le développement de plugins en Java est la porte d’entrée vers des possibilités infinies. Ce guide est conçu pour vous accompagner pas à pas, en utilisant le template officiel de la communauté optimisé pour un démarrage rapide.

Le modding sur Hytale : une approche « Server-First »

Avant de commencer, comprenez bien une chose : sur Hytale, tout est géré côté serveur. Même en solo, votre partie tourne sur un serveur local. Vos plugins s’exécutent donc sur ce serveur, garantissant que tous les joueurs connectés vivent la même expérience sans avoir à installer de mods côté client.

Prérequis : Les outils indispensables

Pour suivre ce guide, vous devez installer deux éléments spécifiques :

1. Java 25 JDK : Hytale requiert cette version précise de Java. Assurez-vous d’avoir le JDK 25 installé.
2. IntelliJ IDEA : L’environnement de développement recommandé. La version Community (gratuite) suffit.

Étape 1 : Préparation du projet (Crucial !)

Pour éviter les erreurs techniques, nous utilisons un modèle préconfiguré. Suivez cet ordre précis :

1. Téléchargez le modèle : Récupérez le template depuis le dépôt GitHub.
2. Extrayez l’archive dans votre dossier de développement.
3. Configurez AVANT d’ouvrir IntelliJ :
   • Ouvrez le fichier settings.gradle avec un éditeur de texte (Bloc-notes, VS Code) et modifiez rootProject.name = 'MonPremierPlugin'.
   • Ouvrez gradle.properties pour définir votre maven_group (ex: com.pseudo).
   • Note : Cette étape est vitale pour éviter les conflits de cache dans IntelliJ.
4. Importez dans IntelliJ : Ouvrez IntelliJ, faites « Open », sélectionnez le dossier du projet et laissez Gradle télécharger les dépendances.

Étape 2 : Le Manifeste (manifest.json)

C’est la carte d’identité de votre plugin située dans src/main/resources/manifest.json. Assurez-vous que le champ « Main » pointe exactement vers votre classe Java.

{
  "Name": "MonPremierPlugin",
  "Version": "1.0.0",
  "Main": "com.hytalegame.monpremierplugin.MonPremierPlugin",
  "Description": "Mon premier plugin de test",
  "Authors": [ { "Name": "VotrePseudo" } ],
  "Dependencies": {},
  "OptionalDependencies": {}
}

Étape 3 : Le code Java (Cycle de vie)

Créez votre classe principale qui hérite de JavaPlugin.

Java

package com.hytalegame.monpremierplugin;

import com.hypixel.hytale.server.core.plugin.JavaPlugin;
import java.util.logging.Level;

public class MonPremierPlugin extends JavaPlugin {

    @Override
    public void start() {
        // Appelé au démarrage du plugin
        getLogger().at(Level.INFO).log("MonPremierPlugin a démarré avec succès !");
        
        // Enregistrement de la commande (voir étape 4)
        getCommandRegistry().registerCommand(new CommandeSimple());
    }

    @Override
    public void shutdown() {
        getLogger().at(Level.INFO).log("Arrêt du plugin.");
    }
}

Étape 4 : Votre première commande

Créez une classe CommandeSimple héritant de AbstractCommand.

Java

package com.hytalegame.monpremierplugin;

import com.hypixel.hytale.server.core.command.system.AbstractCommand;
import com.hypixel.hytale.server.core.command.system.CommandContext;
import com.hypixel.hytale.server.core.Message;
import java.util.concurrent.CompletableFuture;

public class CommandeSimple extends AbstractCommand {

    public CommandeSimple() {
        super("monplugin", "Affiche un message de bienvenue.");
    }

    @Override
    protected CompletableFuture<Void> execute(CommandContext context) {
        context.sender().sendMessage(Message.raw("Bravo ! Votre plugin fonctionne !"));
        return null;
    }
}

Étape 5 : Lancement et Authentification

C’est ici que la magie du template opère. Vous n’avez pas besoin de compiler manuellement le fichier JAR pour tester.

1. Lancer le serveur de test Une fois le projet importé, regardez en haut à droite d’IntelliJ. Vous devriez voir une configuration d’exécution nommée « HytaleServer ».

• Cliquez sur le bouton Play (Vert) à côté de « HytaleServer ».
• La console va s’ouvrir et le serveur va démarrer.

2. Authentifier le serveur (Premier lancement uniquement) Lors du tout premier lancement, vous ne pourrez pas vous connecter immédiatement. Regardez la console d’IntelliJ, le serveur va vous demander de vous authentifier.

• Tapez dans la console : auth login device
• Suivez le lien qui s’affiche pour vous connecter avec votre compte Hytale.
• Une fois validé, tapez : auth persistence Encrypted pour sauvegarder la connexion.

3. Tester en jeu

• Lancez votre client Hytale.
• Connectez-vous au serveur local (IP : 127.0.0.1 ou localhost).
• Tapez votre commande : /monplugin
• Admirez le résultat !

Étape 6 : Compiler pour distribuer

Une fois votre plugin terminé, si vous voulez le partager avec des amis ou le mettre sur un serveur de production :

1. Ouvrez l’onglet Gradle à droite dans IntelliJ.
2. Allez dans Tasks -> build -> build.
3. Récupérez votre fichier .jar dans le dossier build/libs/.
4. Déposez-le simplement dans le dossier Mods/ du serveur de destination.

Et maintenant ?

Félicitations, vous avez créé et testé votre premier plugin Hytale ! Vous maîtrisez désormais le flux de travail essentiel : Coder > Lancer via IntelliJ > Tester.

Mais ce n’est que la surface des possibilités offertes par l’API. Pour transformer vos idées en mods complets (gestion des inventaires, création d’entités, écouteurs d’événements complexes), vous aurez besoin de références précises.

🚀 Allez plus loin avec la documentation complète Pour découvrir des guides détaillés, des exemples de code avancés et les meilleures pratiques de développement, consultez la documentation officielle de la communauté : 👉 Hytale Modding Documentation

C’est votre ressource incontournable pour passer du statut de débutant à celui d’expert en modding Hytale. Bon code !