[+] Added QuestionAnswererPlugin to automatic answer question on 2b2t.xin for speeding up login process.

[#] Fixed the bug that "findMostSimilarColor" algorithm could not parse by color serializer.
[+] Added a demo plugin for template.
[#] Improved example plugin developing guideline.
[#] Updated README.md.
[#] Improved logging.

Author: NeonAngelThreads

PluginDocumentation.md

@@ -2,8 +2,9 @@
 # Customized Plugin Developing Guide
 In this section, you will learn:
 - **1. Plugin Jar Structures**
-- **2. Understand Plugin Lifecycles**  
-- **3. To Create a Simple Plugin**  
+- **2. To Create a Simple Plugin**
+- **3. Understand Plugin Lifecycles**  
+
 
 ## 1. Plugin Structure
   Plugin jar files are supposed to be contained the plugin manifest file `plugin.json` inside the root of jar file.  
@@ -20,7 +21,7 @@ In this section, you will learn:
   **An example for configuring the `plugin.json`:**
   ````json
    {
-      "entry": "MyPluginClassName",
+      "entry": "org.me.plugin.MyPlugin",
       "name": "MyPlugin",
       "version": "1.0.0"
    }
@@ -30,6 +31,10 @@ In this section, you will learn:
     it will scan all classes that extends `AbstractPlugin`, if class not found, it will skip and ignore this plugin.  
 
 ## 2. Build A Simple Plugin
+  Before start, you need to add DolphinAPI dependency. There are following steps:  
+  - Download `DolphinBot-<NEWEST-VERSION>-RELEASE.jar` jar archive.  
+  - Add this archive as dependency to your project.     
+
   Every single plugin entry class needs to extend the `AbstractPlugin` class:
 
    ````java
@@ -79,6 +84,9 @@ In this section, you will learn:
     }
 
    ````
+  - You can also refer to the example plugin in folder `/example-plugin/example_plugin` for help, or you can base on this demo plugin as your template to develop your own plugin.  
+  - After you package your plugin, put the packaged plugin in folder `/plugins`.  
+
   **1. Deep Understand DolphinAPIs:**  
     In above plugin code, at `onEnable()` method, we used `getListeners()` method to get the collection of packet listeners in this plugin.  
 

README.md

@@ -1,23 +1,38 @@
 # DolphinMinecraftBot-Reloaded
-Dolphin bot is an advanced server robot for minecraft, with high-scalability and performance.It integrated plugin loaders like bukkit and easy-used interface styled APIs, allows you to customize event handles.
+A lightweight, reliable, intelligent MC bot for general minecraft server, with high-scalability and performance. It integrated plugin loaders like bukkit and easy-used interface styled APIs, allows you to customize event handles.
 
-## **Shortcuts**: [Custom plugin developing guideline](PluginDocumentation.md)
 
-# How-to-Use
+## Why DolphinBot?
+   - **High performance**, DolphinBot allows you to start multiple bot instances at one client with low CPU usage.   
+   - **High reliability**, ability to bypass 2b2t's human verification, auto-reconnect when disconnected, long term running with no worries for losing connection.  
+   - **High extensibility**, DolphinBot embedded mature DolphinAPI that contains variety of `packet listeners`, `event systems` and easy-used `event handlers` based on `mc protocol lib`,
+     It integrates a bukkit-like plugin API, allowing you to develop custom plugins at very short time.  
+   - **Advanced logging system**, DolphinAPI also implemented `TextComponent` serializer to parse rich colors and styles for server messages, with more useful information.
+   - **Easy to use**, directly run, you can put the bot profile(s) into config file instead of defining on command-line, fast start.
+### **Shortcuts**: [Custom plugin developing guideline](PluginDocumentation.md)
+## Features:
+   - Bypassing human verification in most servers including `2b2t.xin`.
+   - Supporting to configure the bot clusters, and start at once.
+   - Supporting colourful console logging strings expression `colorizeText("&6Hello &lWorld")`.
+   - Automatic answer questions in `2b2t.xin` for speeding up login process.
+## Getting Started
 In this section, you will understand below how-tos:  
-- **1. How to directly start a single bot with command-line.**  
-- **2. How to specify bot profile with config file without command-line.**  
-- **3. How to start multiple bot simultaneously**  
-- **4. How to configure advanced options**  
-- **5. How to make a custom plugin**
+  - **1. How to directly start a single bot with command-line.**  
+  - **2. How to specify bot profile with config file without command-line.**  
+  - **3. How to start multiple bot simultaneously**  
+  - **4. How to configure advanced options**  
+  - **5. How to make a custom plugin**  
+
 1. **Download the Client**  
    Download the jar archive file: `DolphinBot-[version].jar`.  
    Requirements: **Java version >= 17**
 2. **Configuration of the Bot**
    1. **Configuring Bot Profile**  
       There are two different ways to set bot config:  
+   
       - If you want to quickly start for simplicity and only one bot started, you can use **Command-line setting**  
-      - If you would like to start multiple bot at once, and access advanced options, you can use **Config file setting**
+      - If you would like to start multiple bot at once, and access advanced options, you can use **Config file setting**    
+      
       1. **Command-line Setting**  
            In-game profile should be defined on below boot command-line.  
            An example of argument list:

example-plugins/empty/org/me/plugin/MyPlugin.java

@@ -0,0 +1,5 @@
+{
+  "entry": "org.me.plugin.MyPlugin",
+  "name": "MyPlugin",
+  "version": "1.0.0"
+}

example-plugins/empty/plugin.json

@@ -0,0 +1,5 @@
+{
+  "entry": "test.plugin.TestPlugin",
+  "name": "MyPlugin",
+  "version": "1.0.0"
+}

example-plugins/example_plugin/plugin.json

@@ -0,0 +1,39 @@
+package test.plugin;
+
+import org.angellock.impl.AbstractRobot;
+import org.angellock.impl.events.packets.PlayerLogInfo;
+import org.angellock.impl.events.packets.SystemChatHandler;
+import org.angellock.impl.providers.AbstractPlugin;
+
+public class TestPlugin extends AbstractPlugin {
+    @Override
+    public String getPluginName() {
+        return "TestPlugin";
+    }
+
+    @Override
+    public String getVersion() {
+        return "1.0.0";
+    }
+
+    @Override
+    public String getDescription() {
+        return "TestPlugin";
+    }
+
+    @Override
+    public void onDisable() {
+
+    }
+
+    @Override
+    public void onLoad() {
+    }
+
+    @Override
+    public void onEnable(AbstractRobot abstractRobot) {
+        getListeners().add(new SystemChatHandler().addExtraAction((clientboundSystemChatPacket) -> {
+            System.out.println("Hello world!");
+        }));
+    }
+}

example-plugins/example_plugin/test/plugin/TestPlugin.java

@@ -14,6 +14,8 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.util.ArrayDeque;
+import java.util.Queue;
 import java.util.Random;
 
 public abstract class AbstractRobot implements ISendable, SessionProvider, IOptionalProcedures {
@@ -32,6 +34,7 @@ public abstract class AbstractRobot implements ISendable, SessionProvider, IOpti
     protected final Random randomizer = new Random();
     protected long connectDuration = 0;
     protected boolean isByPassedVerification = true;
+    private ChatMessageManager messageManager;
 
     public AbstractRobot(ConfigManager configManager, PluginManager pluginManager){
         this.config = configManager;
@@ -72,9 +75,14 @@ public String getPassword(){
         return this.password;
     }
 
+    public ChatMessageManager getMessageManager() {
+        return messageManager;
+    }
+
     public void connect(){
         onPreLogin();
         this.serverSession = new TcpClientSession(this.server, this.port, minecraftProtocol);
+        this.messageManager = new ChatMessageManager(this.serverSession);
 
         this.serverSession.addListener((IConnectListener) event -> onJoin());
 
@@ -91,10 +99,11 @@ public void connect(){
 
         while (true) {
             try {
-                Thread.sleep(19L);
+                Thread.sleep(500L);
                 if (!this.serverSession.isConnected()){
                     this.connectDuration = System.currentTimeMillis();
                 }
+                this.messageManager.pollMessage();
 
 //                if (!serverSession.isConnected()){
 //                    this.connectTime = System.currentTimeMillis();

src/main/java/org/angellock/impl/AbstractRobot.java

@@ -0,0 +1,51 @@
+package org.angellock.impl;
+
+import org.angellock.impl.util.ConsoleTokens;
+import org.geysermc.mcprotocollib.network.Session;
+import org.geysermc.mcprotocollib.protocol.codec.MinecraftPacket;
+import org.geysermc.mcprotocollib.protocol.packet.ingame.serverbound.ServerboundChatPacket;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.time.Instant;
+import java.util.ArrayDeque;
+import java.util.BitSet;
+import java.util.LinkedList;
+import java.util.Queue;
+
+public class ChatMessageManager implements ISendable{
+
+    protected static final Logger log = LoggerFactory.getLogger(ConsoleTokens.colorizeText("&7ChatMessageManager"));
+    private final Queue<String> chatMessageQueue = new ArrayDeque<>();
+    private final Session serverSession;
+
+    public ChatMessageManager(Session serverSession) {
+        this.serverSession = serverSession;
+    }
+
+    public void putMessage(String msg){
+        this.chatMessageQueue.offer(msg);
+    }
+
+    public void pollMessage(){
+        String removal = this.chatMessageQueue.poll();
+        if(removal != null) {
+            this.sendMessagePacket(removal);
+        }
+    }
+
+    private void sendMessagePacket(String message){
+        MinecraftPacket msgPacket = new ServerboundChatPacket(message, Instant.now().toEpochMilli(), 0L, null, 0, new BitSet());
+        log.info(ConsoleTokens.colorizeText("&7Sending in-game chat message: &b&l&o{}"), message);
+        this.sendPacket(msgPacket);
+    }
+
+    public Queue<String> getChatMessageQueue() {
+        return chatMessageQueue;
+    }
+
+    @Override
+    public void sendPacket(MinecraftPacket packet) {
+        this.serverSession.send(packet);
+    }
+}

src/main/java/org/angellock/impl/ChatMessageManager.java

@@ -0,0 +1,15 @@
+package org.angellock.impl.events.packets;
+
+import org.angellock.impl.events.AbstractEventProcessor;
+import org.geysermc.mcprotocollib.protocol.codec.MinecraftPacket;
+import org.geysermc.mcprotocollib.protocol.packet.ingame.clientbound.ClientboundPlayerChatPacket;
+import org.geysermc.mcprotocollib.protocol.packet.ingame.clientbound.inventory.ClientboundContainerSetContentPacket;
+import org.geysermc.mcprotocollib.protocol.packet.ingame.clientbound.inventory.ClientboundContainerSetSlotPacket;
+import org.geysermc.mcprotocollib.protocol.packet.ingame.clientbound.inventory.ClientboundOpenScreenPacket;
+
+public class ContainerPacketHandler extends AbstractEventProcessor<ClientboundOpenScreenPacket> {
+    @Override
+    protected boolean isTargetPacket(MinecraftPacket packet) {
+        return (packet instanceof ClientboundOpenScreenPacket);
+    }
+}

src/main/java/org/angellock/impl/events/packets/ContainerPacketHandler.java

@@ -4,6 +4,7 @@
 import net.kyori.adventure.text.TextComponent;
 import org.angellock.impl.AbstractRobot;
 import org.angellock.impl.events.IDisconnectListener;
+import org.angellock.impl.events.packets.ContainerPacketHandler;
 import org.angellock.impl.events.packets.LoginHandler;
 import org.angellock.impl.events.packets.SystemChatHandler;
 import org.angellock.impl.events.packets.TitlePacketHandler;
@@ -12,13 +13,19 @@
 import org.angellock.impl.util.TextComponentSerializer;
 import org.geysermc.mcprotocollib.protocol.data.game.entity.player.GameMode;
 import org.geysermc.mcprotocollib.protocol.data.game.entity.player.Hand;
+import org.geysermc.mcprotocollib.protocol.data.game.inventory.ContainerAction;
+import org.geysermc.mcprotocollib.protocol.data.game.inventory.ContainerActionType;
+import org.geysermc.mcprotocollib.protocol.data.game.item.ItemStack;
 import org.geysermc.mcprotocollib.protocol.packet.ingame.serverbound.ServerboundChatCommandPacket;
+import org.geysermc.mcprotocollib.protocol.packet.ingame.serverbound.inventory.ServerboundContainerButtonClickPacket;
+import org.geysermc.mcprotocollib.protocol.packet.ingame.serverbound.inventory.ServerboundContainerClickPacket;
 import org.geysermc.mcprotocollib.protocol.packet.ingame.serverbound.player.ServerboundSetCarriedItemPacket;
 import org.geysermc.mcprotocollib.protocol.packet.ingame.serverbound.player.ServerboundUseItemPacket;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.time.Instant;
+import java.util.HashMap;
 
 public class PlayerVerificationPlugin extends AbstractPlugin {
     protected int verifyTimes = 0;
@@ -107,7 +114,7 @@ public void onEnable(AbstractRobot entityBot) {
                             break;
                         }
 
-                        log.info(this.serverGamemode.name());
+                        //log.info(this.serverGamemode.name());
                         if (!this.hasLoggedIn) {
                             entityBot.sendPacket(new ServerboundChatCommandPacket("login " + entityBot.getPassword()));
                         }else if (this.serverGamemode != GameMode.SURVIVAL){
@@ -126,6 +133,13 @@ public void onEnable(AbstractRobot entityBot) {
             });
         }
 
+        getListeners().add(new ContainerPacketHandler().addExtraAction((packet -> {
+            String title = ConsoleTokens.colorizeText(((TextComponent)packet.getTitle()).content().strip());
+            log.info(ConsoleTokens.colorizeText("&7[Inventory] &7Container opened, with containerId: &9{}, &6Title: \"&l{}\""), packet.getContainerId(), title);
+            entityBot.sendPacket(new ServerboundContainerButtonClickPacket(packet.getContainerId(), 4));
+            entityBot.sendPacket(new ServerboundContainerClickPacket(packet.getContainerId(), 0, 4, ContainerActionType.CLICK_ITEM, (ContainerAction) () -> 0, new ItemStack(0), new HashMap<>()));
+        })));
+
         getListeners().add(new SystemChatHandler().addExtraAction((packet) -> {
             TextComponentSerializer componentSerializer = new TextComponentSerializer();
             String msg = componentSerializer.serialize(packet.getContent());