Skip to content

Commit 5be2000

Browse files
[!] Fixed the file extracting error located to 'C:\Users\Administrator' on the cmd with different start path.
[+] Added Auto-Tab-Completer feature. [+] Added TerminalCommand.java and builder API for registering the terminal side commands. [+] Added ReloadCommandExecutor to reload & hot load plugins.(Hot Inject during the connection) [+] Added quit confirmation. [~] Improved code structure. [~] Optimized path fetch logic in getBaseConfigRoot() method. [~] Improved README.md
1 parent 253b894 commit 5be2000

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,17 @@
3434
</p>
3535

3636
## 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`,
4040
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.
4243
- **Easy to use**, directly run, you can put the bot profile(s) into config file instead of defining on command-line, fast start.
4344
### **Shortcuts**: [Custom plugin developing guideline](PluginDocs.md)
4445
## 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.
4648
- Bypassing human verification in most servers including `2b2t.xin`.
4749
- Supporting to configure the bot clusters, and start at once.
4850
- Supporting colourful console logging strings expression `colorizeText("&6Hello &lWorld")`.
@@ -68,7 +70,14 @@
6870
- [`Player Events`](PluginDocs.md#player-events)
6971
- [`Force Unicode Chat`](PluginDocs.md#unicode-string-helper)
7072

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.
7281
## Getting Started
7382
In this section, you will understand below how-tos:
7483
- **1. How to directly start a single bot with command-line.**
@@ -246,13 +255,9 @@ In this section, you will understand below how-tos:
246255
| `reconnect-delay` | Min delay(millis) for cooling down when reconnect a server. |
247256
| `msg-send-delay` | The delay of sending in-game messages. |
248257
## 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.
250259
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.
256261
257262
## FAQ
258263

0 commit comments

Comments
 (0)