|
34 | 34 | </p> |
35 | 35 |
|
36 | 36 | ## Why DolphinBot? |
37 | | - - **High performance**, DolphinBot allows you to start multiple bot instances at one client with low CPU usage. |
38 | | - - **High reliability**, ability to bypass 2b2t's human verification, auto-reconnect when disconnected, long term running with no worries for losing connection. |
39 | | - - **High extensibility**, DolphinBot embedded mature DolphinAPI that contains variety of `packet listeners`, `event systems` and easy-used `event handlers` based on `mc protocol lib`, |
| 37 | + - **High reliability**, low network utilization, auto-reconnect when disconnected, long term running with no worries for losing connection. |
| 38 | + - **High programmability**, DolphinBot implemented a **SpringBoot**-like finite **StateMachines**, allows you to easily configure **multiple login-process** for different servers. |
| 39 | + - **High extensibility**, DolphinBot embedded a mature DolphinAPI that contains variety of `packet listeners`, `event systems` and easy-used `event handlers` based on `mc protocol lib`, |
40 | 40 | It integrates a bukkit-like plugin API, allowing you to develop custom plugins at very short time. |
41 | | - - **Advanced logging system**, DolphinAPI also implemented `TextComponent` serializer to parse rich colors and styles for server messages, with more useful information. |
| 41 | + - **Advanced logging system**, DolphinAPI also implemented `TextComponent` serializer to parse rich colors and styles for server messages, with more useful debug information. |
| 42 | + - **High performance**, DolphinBot allows you to start multiple bot instances at single client with low CPU and Memory usage. |
42 | 43 | - **Easy to use**, directly run, you can put the bot profile(s) into config file instead of defining on command-line, fast start. |
43 | 44 | ### **Shortcuts**: [Custom plugin developing guideline](PluginDocs.md) |
44 | 45 | ## Features: |
45 | | - - Easy to register custom commands starting with `!` by using CommandBuilder DolphinAPIs |
| 46 | + - Easy to register custom commands starting with `!` by using CommandBuilder DolphinAPIs. |
| 47 | + - Can **hot-inject** plugins during the connection of server. |
46 | 48 | - Bypassing human verification in most servers including `2b2t.xin`. |
47 | 49 | - Supporting to configure the bot clusters, and start at once. |
48 | 50 | - Supporting colourful console logging strings expression `colorizeText("&6Hello &lWorld")`. |
|
68 | 70 | - [`Player Events`](PluginDocs.md#player-events) |
69 | 71 | - [`Force Unicode Chat`](PluginDocs.md#unicode-string-helper) |
70 | 72 |
|
71 | | -Command-line Arguments |
| 73 | +## Interactions in Terminal |
| 74 | +- You can send in-game messages or execute commands form the dolphin bot terminal. |
| 75 | +- Built-in commands: |
| 76 | +- |
| 77 | + | Terminal Commands | Description | |
| 78 | + |---------------------------|----------------------------------| |
| 79 | + | `reload <Plugin Name>` | Hot-reloading a specified plugin | |
| 80 | +- For these commands, you can press `TAB` to complete automatically. |
72 | 81 | ## Getting Started |
73 | 82 | In this section, you will understand below how-tos: |
74 | 83 | - **1. How to directly start a single bot with command-line.** |
@@ -246,13 +255,9 @@ In this section, you will understand below how-tos: |
246 | 255 | | `reconnect-delay` | Min delay(millis) for cooling down when reconnect a server. | |
247 | 256 | | `msg-send-delay` | The delay of sending in-game messages. | |
248 | 257 | ## Hot Swapping Plugins In-Game |
249 | | -Dolphin bot supports you to hot-reload plugins in server, without quit the entire client and reconnecting to server. |
| 258 | +Dolphin bot supports you to **hot-reload** and **hot-load** (**hot injection**) plugins in server, without quit the entire client and reconnecting to server. |
250 | 259 | You can send `!reload <pluginName>` dolphin command in server chat. |
251 | | -Console controlling are still in-developing, currently. |
252 | | -
|
253 | | -## Interactions from Terminal (Beta) |
254 | | -- You can send in-game messages or execute commands form the dolphin bot terminal. |
255 | | -- Built-in commands (In-dev) |
| 260 | +Alternatively, you can type `reload plugin.jar` in the terminal to hot-reload plugins. |
256 | 261 |
|
257 | 262 | ## FAQ |
258 | 263 |
|
|
0 commit comments