Communiquer de Forge à Bukkit (Packets)

[DiabolicaTrix]

Sommaire

• Introduction
• Pré-requis
• Forge
  • Enregistrer le channel
  • L’handler
  • L’envoi
• Bukkit
  • Enregistrer le channel
  • Le PacketListener (Handler)
• Résultat
• Crédits

Introduction

J’ai récemment rencontré une situation où une communication entre Forge et un plugin Bukkit/Spigot était nécessaire. J’aurais aimé faire autrement, mais il est indéniable que les plugins sont présents dans beaucoup de serveurs et que leur économie est souvent basée sur un plugin et non un mod. C’est dans cette optique que j’ai décidé de vous partager une façon de communiquer avec un plugin, même si un mélange de mod et de plugins n’est pas forcément recommandé pour un serveur.

Pré-requis

• Avoir une base des techniqualités des Packets.
• Avoir une base en Java.
• Avoir une base avec Bukkit/Spigot et avec Forge.

Forge

Enregistrer le channel Forge:

Pour débuter, rendez vous à l’endroit où vous enregistrez vos packets ajoutez la ligne suivante:

NetworkRegistry.INSTANCE.newChannel("ForgeToBukkit", new PacketHandler());

Cette simple ligne sert à créer un nouveau channel que j’ai nommé “ForgeToBukkit” (Il est possible de lui donner le nom que vous voulez) et à déclare l’handler. L’handler servira à traiter un packet lors de sa réception.

L’handler:

En théorie, l’handler n’est pas réellement nécessaire car, dans ce tutoriel, nous ne traiterons que l’envoi de packets. Cependant, il sera utile pour obtenir une réponse du plugin. Il faut donc créer une classe qui, dans mon cas, sera nommée PacketHandler et lui implémenter l’interface ChannelHandler. Ensuite, ajoutez ces trois méthodes :

@Override
public void handlerAdded(ChannelHandlerContext ctx) throws Exception {
}
 
@Override
public void handlerRemoved(ChannelHandlerContext ctx) throws Exception {
}
 
@Override
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
 
}

La première méthode est appelée lorsqu’un packet est ajoutée à la liste. La deuxième est l’inverse de la première car elle est appelée lorsqu’un packet est retiré de la liste. La dernière, quant à elle, est appelée lorsqu’une exception est levée pendant le traitement d’un packet. Cette classe ne sera pas utile pour l’instant, elle sera modifiée dans la partie Bonus.

L’envoi:

Une fois que le channel est en place, il est possible d’envoyer des packets.

ByteArrayDataOutput out = ByteStreams.newDataOutput();
out.writeUTF("Hello World!");
C17PacketCustomPayload packet = new C17PacketCustomPayload("ForgeToBukkit", out.toByteArray());
playerMP.sendQueue.addToSendQueue(packet);

Dans cet extrait de code, on commence par créer un nouveau ByteStream qui permettera d’envoyer les données nécessaires. Ensuite, on lui ajoute les données que nous voulons envoyer avec le packet. Dans mon cas, j’envoie une chaîne de caractère avec la méthode writeUTF. Dans la troisième ligne, nous créons un packet et nous lui fournissons en paramètres le channel dans lequel il doit être envoyé ainsi que les données à envoyer. Finalement, nous ajoutons le packet à la file d’attente pour qu’il soit envoyé.

NB: L’instance du joueur doit être EntityClientPlayerMP. Sur serveur, il est possible de convertir un EntityPlayer en EntityClientPlayerMP en le castant tout simplement. Voici un exemple :

EntityClientPlayerMP playerMP = (EntityClientPlayerMP) player;

Bukkit

Enregistrer le channel:

À partir de maintenant, le tutoriel se déroule dans votre plugin.

Dans votre event onEnable de votre classe principale, ajoutez la ligne suivante:

Bukkit.getMessenger().registerIncomingPluginChannel(this, "ForgeToBukkit", new PacketListener());

Cette ligne sert à enregistrer le channel comme entrant (incoming). On lui fourni ensuite en paramètre l’instance du plugin, le channel qui doit être le même que tout à l’heure et le PacketListener qui traitera les packets reçus.

Packet Listener (Handler):

Le PacketListener sert à traiter les packets lorsqu’ils arrivent. Je vous invite à créer une nouvelle classe nommée PacketListener qui implémente PluginMessageListener. Ajoutez ensuite le code suivant:

@Override
public void onPluginMessageReceived(String channel, Player player, byte[] message) {
ByteArrayDataInput in = ByteStreams.newDataInput(message);
    if(channel.equals("ForgeToBukkit"))
    {
        player.sendMessage(in.readUTF());
    }
}

Cette méthode sera appelée lorsqu’un packet est reçu. Quand ça arrive, on commence par vérifier si le channel est bien celui que nous voulons écouter. Si c’est le cas, on crée un ByteStream d’entrée qui nous permettera de lire les données. Ensuite, on écrit dans le chat les données présentes dans le packet.

Crédits

Rédaction et correction:

• DiabolicaTrix

Ce tutoriel de Minecraft Forge France est mis à disposition selon les termes de la licence Creative Commons Attribution - Pas d’Utilisation Commerciale - Partage dans les Mêmes Conditions 4.0 International

Retour vers le sommaire des tutoriels

[Ama]

Pourrais-tu préciser la version de ton tutoriel ?

[DiabolicaTrix]

Je croyais avoir mis la balise 1.7.10? Même si je crois que ça peut fonctionner avec 1.6.x et 1.8.x, il faudrait que je le test.

EDIT: je croyais vraiment l’avoir mis, maintenant c’est fait, désolé

[Ama]

Je crois pas qu’avec la 1.8 ton tutoriel fonctionne (après j’ai pas test)

[DiabolicaTrix]

Honnêtement, moi non plus, faudrait tester.

PS: Ça fonctionne en 1.8/1.9/1.10, seulement le nom du packet n’est pas le même, il me semble que c’est CPacketCustomPayload (Client->Serveur) et SPacketCustomPayload (Serveur->Client)

[Folgansky]

Oui bonjour, je viens sur le tuto légitime concernant les packets entre Forge et Bukkit (trololo inside, mais Benjamin Loison m’a bien aidé tout de même en ayant un exemple précis et identique au sujet qui me fait venir ici, bref)

Je voudrais qu’à l’accomplissement d’un succès en jeu (ou achievement), une commande soit exécutée, plus précisément le fameux /eco give player amount.

Je vous montre ma classe un peu allégée car rébarbative et je vous indique que mon soucis réside dans le fait que la méthode n’est pas appelée. L’achievement a bien lieu et les loots sont bien drop, le reste c’est du vent. Je me trompe simplement peut-être, le plugin n’est pas encore fait, mais si le system.out n’est pas appelé sur le mod… Autant résoudre ce soucis en premier.

J’ai essayé à deux endroits clés dans le code pourtant.

Voici ma classe event:

@SubscribeEvent
    public void onEntityKilled(LivingDeathEvent event)
    {
        EntityPlayer player = (EntityPlayer)event.source.getEntity();
 
        Random rand = new Random();
//[…]
//[Liste des loots possibles]
//[…]
        if(event.source.getEntity() instanceof EntityPlayer && player != null)
        {
            int killR1 = player.getEntityData().getInteger("killR1");
            int killR2 = player.getEntityData().getInteger("killR2");
            int killR3 = player.getEntityData().getInteger("killR3");
            int killR4 = player.getEntityData().getInteger("killR4");
            int killR5 = player.getEntityData().getInteger("killR5");
            int killR6 = player.getEntityData().getInteger("killR6");
 
            if(event.entityLiving instanceof EntityR1Cac || event.entityLiving instanceof EntityR1Ranged)
            {
                killR1++;
                player.getEntityData().setInteger("killR1", killR1);
                if(killR1 == 10)
                {
                    player.triggerAchievement(ModPg2.achievementKillR1a);
                    if(player.worldObj.isRemote) //Tout ceci est non appelé
                    {
                        System.out.println("WAOW ENFIN");
                        player.addChatComponentMessage(new ChatComponentText(EnumChatFormatting.DARK_AQUA + "Power Game"));
 
                        ByteArrayDataOutput out = ByteStreams.newDataOutput();
                        out.writeUTF("achievementKillR1a accomplis par " + player.getDisplayName());
                        ((EntityClientPlayerMP)player).sendQueue.addToSendQueue(new C17PacketCustomPayload("achievementKillR1a", out.toByteArray()));
                    }
                }
                if(killR1 == 100)
                {
                    player.triggerAchievement(ModPg2.achievementKillR1b);
                }
                if(killR1 == 300)
                {
                    player.triggerAchievement(ModPg2.achievementKillR1c);
                }
                if(killR1 == 1000)
                {
                    player.triggerAchievement(ModPg2.achievementKillR1d);
                }
 
                for(int j = 0; j < 2; ++j)  //Les loots de certains mobs
                {
                    if(event.entityLiving instanceof EntityR1Cac && !player.worldObj.isRemote)
                    {
                        int randInt = rand.nextInt(100);
                        if(randInt <= 5)
                        {   // 5/100
                            event.entityLiving.entityDropItem(stack9, 1);
                        }
                        if(randInt > 5 && randInt <= 40)
                        {   // 35/100
                            event.entityLiving.entityDropItem(stack3, 1);
                        }
                        if(randInt > 40 && randInt <= 50)
                        {   // 10/100
                            event.entityLiving.entityDropItem(stack2, 1);
                        }
                        if(randInt > 50)
                        {   // 50/100
                            event.entityLiving.entityDropItem(stack1, 1);
                        }
                    }
                    if(event.entityLiving instanceof EntityR1Ranged && !player.worldObj.isRemote)
                    {
                        int randInt = rand.nextInt(100);
                        if(randInt <= 10)
                        {   // 10/100
                            event.entityLiving.entityDropItem(stack9, 1);
                        }
                        if(randInt > 10 && randInt <= 30)
                        {   // 20/100
                            event.entityLiving.entityDropItem(stack3, 1);
                        }
                        if(randInt > 30 && randInt <= 50)
                        {   // 20/100
                            event.entityLiving.entityDropItem(stack2, 1);
                        }
                        if(randInt > 50)
                        {   // 50/100
                            event.entityLiving.entityDropItem(stack1, 1);
                        }
                    }
                }
            }
//[…]
//[Plein d'autres loots et achievements]
//[…]
 
            if(player != null && player.worldObj.isRemote)  //Tout ceci est non appelé
            { 
                if(killR1 == 10)
                {
                    System.out.println("Test concluant ou non");
 
                    player.addChatComponentMessage(new ChatComponentText(EnumChatFormatting.DARK_AQUA + "Power Game"));
 
                    ByteArrayDataOutput out = ByteStreams.newDataOutput();
                    out.writeUTF("achievementKillR1a accomplis par " + player.getDisplayName());
                    ((EntityClientPlayerMP)player).sendQueue.addToSendQueue(new C17PacketCustomPayload("achievementKillR1a", out.toByteArray()));
                }
[…]
            }
        }
    }

[AymericRed]

Je pense que le problème est que l’event ne doit pas être appelé côté serveur, du coup, faudrait que tu exécutes directement la commande.

[Folgansky]

Ma classe event est LivingEventHandler, la voici dans ma classe principale

@EventHandler
    public void init(FMLInitializationEvent event)
    {                
        MinecraftForge.EVENT_BUS.register(new LivingEventHandler());
[…]
        if(event.getSide().isClient())
        {
            FMLCommonHandler.instance().bus().register(new LivingEventHandler());  //Pour ItemTooltipEvent
[…]
        }
[…]
     }
 

C’est bien de ça dont tu voulais parler?

EDIT:

De ce que j’ai cru comprendre, l’event n’est pas appelé côté client… Je devrais avoir un NPE dans ce cas non?

[AymericRed]

Non, je voulais dire que l’event LivingDeathEvent n’est appelé que côté serveur (il me semble).

[Folgansky]

En effet, j’ai testé

System.out.println(player.worldObj.isRemote);

Et la magie du crash a opéré…

Edit:
Bon j’ai fais plusieurs edit de ce message mais avec de mauvaises idées (passer par l’affichage du GuiAchivement pour déclencher les récompenses/packets)

Mais au final je ne trouve pas de bonne solution…
Peut-être qu’un plugin pourrait récupérer la valeur des Integer stockés dans le joueur, chaque integer étant le nombre de chaque mob tué et pourrait déclencher en conséquenceles récompenses via une commande…

Ce qui m’embête c’est que l’achievement et la récompense ne se font pas ensemble…

[DiabolicaTrix]

Tu as deux solutions: Soit tu exécute directement la commande sans utiliser Bukkit ou bien tu utilises les packets. Dans ce cas, je crois qu’il existe déjà un packet payload serveur, par contre, tu ne peux pas vraiment envoyer un packet serveur forge vers serveur bukkit. Donc la première solution serait la plus simple. En fait, dans ton cas tu n’as pas réellement besoin de ce tutoriel, quand je l’ai écris j’avais plus en tête la compatibilité entre certaines API Bukkit et Forge (Vault).

[Folgansky]

J’ai déjà essayé d’exécuter la commande directement.
Sauf que la dite commande c’est /eco give player amount et donc j’ai cru comprendre que je serai obligé d’utiliser un packet puis un plugin pour l’exécuter (en mettant le joueur opé l’espace d’un instant)

[Benjamin Loison]

Ou tu éxécutes la commande avec la Console côté Plugin (donc pas besoin d’opé le joueur même pas un instant)

[Folgansky]

Ouki, mais le gros dilemne que j’ai c’est que je ne peux pas envoyer le packet via mon event qui n’est que côté serveur.

Cela m’ennuie assez fortement que la récompense ne se déclenche pas en même temps que l’achievement accomplis.

Tronqué, mon event ressemble à ça

@SubscribeEvent
    public void onEntityKilled(LivingDeathEvent event)
    {
        EntityPlayer player = (EntityPlayer)event.source.getEntity();
 
        Random rand = new Random();
        ItemStack stack1 = new ItemStack(ModPg2.itemRandomMunition, 1); // Munition
 […]
        if(event.source.getEntity() instanceof EntityPlayer && player != null)
        {
            int killR1 = player.getEntityData().getInteger("killR1");
[…]
 
            if(event.entityLiving instanceof EntityR1Cac || event.entityLiving instanceof EntityR1Ranged)
            {
                killR1++;
                player.getEntityData().setInteger("killR1", killR1);
                if(killR1 == 10)
                {
                    player.triggerAchievement(ModPg2.achievementKillR1a);
//J'ai essayé de déclencher l'envoi du packet ici avant de me rendre compte que tout ne se passe que côté client, NPE sur EntityClientPlayerMP oblige
 
//edit:  cette portion de code
                 // ByteArrayDataOutput out = ByteStreams.newDataOutput();
                 // out.writeUTF("achievementKillR1a accomplis par " + player.getDisplayName());
                 // ((EntityClientPlayerMP)player).sendQueue.addToSendQueue(new C17PacketCustomPayload("achievementKillR1a", out.toByteArray()));
 
                }
                if(killR1 == 100)
                {
                    player.triggerAchievement(ModPg2.achievementKillR1b);
                }
[…]

[DiabolicaTrix]

En fait, j’ai peut-être une autre idée: Tu peux détecter quand un joueur reçoit un achievement grâce à un event (je crois) et tu envoies le packet à partir de cet event qui, lui, doit être client/serveur.

[Folgansky]

Cette classe là?

package net.minecraftforge.event.entity.player;
 
import net.minecraft.entity.player.EntityPlayer;
import net.minecraft.stats.Achievement;
import cpw.mods.fml.common.eventhandler.Cancelable;
import cpw.mods.fml.common.eventhandler.Event;
 
/**
 * When the player receives an achievement. If canceled the player will not receive anything.
 */
@Cancelable
public class AchievementEvent extends PlayerEvent {
 
    public final Achievement achievement;
    public AchievementEvent(EntityPlayer player, Achievement achievement)
    {
        super(player);
        this.achievement = achievement;
    }
}

[DiabolicaTrix]

Ouais, tu vérifies si c’est le bon achievement et tu envoies le packet.

[Folgansky]

Je pense avoir un peu compris mais pas tout…

Le problème étant qu’il m’est demandé d’initialiser ma variable achievement et je suis sûr que ce n’est pas la bonne façon de faire x]
Mais pour le reste, il me semble que c’est la bonne façon de récupérer mon achievement par exemple (qui est bien register sous ce nom là)

 @SubscribeEvent
    public void achievementEvent (AchievementEvent event)
    {
        EntityClientPlayerMP player = Minecraft.getMinecraft().thePlayer;
 
        AchievementEvent achievement = null; //euh, c'est grave docteur?
        if(achievement.equals(ModPg2.achievementKillR1a))
        {
            ByteArrayDataOutput out = ByteStreams.newDataOutput();
            out.writeUTF("achievementKillR1a accomplis par " + player.getDisplayName());
            ((EntityClientPlayerMP)player).sendQueue.addToSendQueue(new C17PacketCustomPayload("achievementKillR1a", out.toByteArray()));
        }
    }

[AymericRed]

Oui c’est un virus très grave, il s’appelle NPE ^^
achievement devrait être égal à quelque chose comme event.achievement ou event.getAchievement().

[DiabolicaTrix]

@SubscribeEvent
public void achievementEvent (AchievementEvent event)
{
EntityClientPlayerMP player = Minecraft.getMinecraft().thePlayer;
 
if(event.getAchievement().equals(ModPg2.achievementKillR1a))
{
ByteArrayDataOutput out = ByteStreams.newDataOutput();
out.writeUTF("achievementKillR1a accomplis par " + player.getDisplayName());
((EntityClientPlayerMP)player).sendQueue.addToSendQueue(new C17PacketCustomPayload("achievementKillR1a", out.toByteArray()));
}
}

N’oublie pas de l’exécuter client seulement!