HuHoBot Spigot Adapter

This Mod/Plugin is only applicable to users who use Tencent QQ in the China region.

简体中文

A next-generation Minecraft server management bot solution that breaks through the limitations of traditional bot frameworks and provides a more secure and stable interactive experience.

🌟 Core Advantages

Feature	Traditional Solutions	HuHoBot
Account Security	❌ Requires a physical QQ account, with risk of account ban	✅ No dependency on third-party QQ clients, zero risk control issues
Deployment Complexity	❌ Requires setting up a complete bot framework	✅ Ready-to-use, one-click binding
Server Compatibility	❌ Not supported by some panel servers	✅ Cross-platform compatibility, works anywhere with internet
Protocol Update Impact	❌ Frequent adaptation to new protocols required	✅ Protocol-agnostic design, relatively stable

🚀 Functional Features

Core Functions

• Seamless Binding: Instant binding between server and control terminal via WebSocket
• Cross-Platform Support: Compatible with all Spigot/Paper versions 1.8+
• Intelligent Risk Control Avoidance: Event-driven non-intrusive communication protocol
• Folia Support: Works with Folia server cores

Feature List

📜 Click to View

Command	Description
/添加白名单	Add a whitelist entry to the server
/删除白名单	Remove a whitelist entry from the server
/绑定	Bind to the server
/设置名称	Set your cross-server-group display name
/发信息	Send a message from the group to the server
/执行命令	Send a command execution request to the server
/查白名单	Query the server's built-in whitelist
/查在线	Query the list of online players on the server
/在线服务器	Query online servers
/执行	Execute custom commands
/管理员执行	Run custom content with administrator privileges

Advanced Features

• Extended API
  • Custom command system (see details below)

📥 Installation Guide

Environment Requirements

• Java 8+ Runtime
• Any supported Spigot/Paper core (including but not limited to versions 1.8+)

Quick Start

1. Visit the GitHub Releases page:

• Open your browser and go to HuHoBot-SpigotAdapter Releases
• Download the latest version of the HuHoBot-vx.x.x-Spigot.jar file

1. Place the plugin file:

• Move the downloaded HuHoBot-vx.x.x-Spigot.jar file into the server's plugins directory

1. Restart the server:

• Restart your Minecraft server to load the new plugin

1. Add the bot:

• Join the support group, click on the avatar of "HuHo_Bot" and add it to the group chat

1. Complete the binding:

• Follow the console prompts to finish binding the server to the bot

Advanced Configuration (Optional)

• For customizing features, refer to the ⚙️ Configuration Example below for detailed settings

---

Notes:

• Ensure the server has the Java 8+ runtime environment installed correctly
• The plugin is compatible with all supported Spigot/Paper core versions; refer to the official documentation for specific version details

⚙️ Configuration Example

# Ignore this field
serverId: null
# Ignore this field
hashKey: null

chatFormat:
  from_game: "<{name}> {msg}" # Text format when in-game messages are forwarded to the group
  from_group: "群:<{nick}> {msg}" # Text format when group messages are forwarded to the server
  post_chat: true # Whether to forward group messages to the server
  post_prefix: "" # Prefix for group messages forwarded to the server

motd:
  server_ip: "play.hypixel.net" # MOTD image URL for "/查在线" (replace with your server address)
  server_port: 25565 # MOTD image port for "/查在线" (replace with your server port)
  api: "https://motdbe.blackbe.work/status_img/java?host={server_ip}:{server_port}" # MOTD image API for "/查在线" (do not modify unless necessary; must return an image)
  text: "共{online}人在线" # MOTD text for "/查在线" (supports PlaceholderAPI; leave empty to hide)
  output_online_list: true # Whether to display the online player list
  post_img: true # Whether to display the MOTD image

whiteList:
  add: "whitelist add {name}" # Command to add a whitelist entry
  del: "whitelist remove {name}" # Command to remove a whitelist entry

# Custom execution commands
customCommand:
  - key: "加白名" # Trigger keyword; use "/执行 关键词 参数1 参数2" to run the custom command
    command: "whitelist add &1" # &1 is a parameter placeholder (1st parameter = &1, 2nd = &2, etc.)
    permission: 0 # 0 = normal permission; values > 0 = administrator permission

  - key: "管理加白名"
    command: "whitelist add &1"
    permission: 1

❓ Frequently Asked Questions

🤔 Do I need to prepare a QQ account? Not at all! This solution uses an all-new communication protocol, completely eliminating dependencies on third-party chat platforms. 🛡️ Which server versions are supported? ✅ Tested versions: 1.8 - 1.21

✅ Theoretically supports all Spigot-based cores

🔧 How to update the configuration? Configuration hot-reload is supported: /huhobot reload 💬 About cross-communication between group and server When using /发信息, you can reply to the message up to 5 times within 5 minutes; the bot will prioritize the latest message for replying.
If no message available for replying is found, the message cannot be sent. 🌐 Does "/查在线" display information for other servers? Please modify the motdUrl field in the configuration file to your server address. Example: motdUrl: "play.yourserver.com:25565" 🔍 No response when using "/查在线"? Troubleshooting steps:

1. Check the connection status and reconnect using /huhobot reconnect

2. Try clearing the motdUrl field: "motdUrl": ""

⌨️ No response when executing commands? Note the difference in command formats:

• /执行 加白 → Used for custom command callbacks

• /执行命令 list → Sends commands to the console

👥 Allow players to add themselves to the whitelist? Configure the customCommand field as shown in the configuration example above.

Usage: /执行 加白 "玩家ID" (add quotes for parameters with spaces)

👮 How to set up administrators? Use the command in the group: /管理帮助 → View the list of administrator commands 🏰 Does it support multiple servers? The current version only supports binding one server per group. Multi-server binding is under development. For managing multiple servers, it is recommended to create a separate group for each server.

Configuring Custom Commands

Setting via Configuration File

In the config.yml file, you can define custom commands through the customCommand field. Each custom command includes the following attributes:

• key: The keyword to trigger the command (string)
• command: The actual server command to execute (string)
• permission: Permission level (integer)

Example configuration is as follows:

customCommand:
  - key: "加白名" # Trigger keyword; use "/执行 关键词 参数1 参数2" to run the custom command
    command: "whitelist add &1" # &1 is a parameter placeholder (1st parameter = &1, 2nd = &2, etc.)
    permission: 0 # 0 = normal permission; values > 0 = administrator permission

  - key: "管理加白名"
    command: "whitelist add &1"
    permission: 1

View Development Documentation

For more detailed development guides and advanced features, please refer to the Development Documentation.

📄 Open Source License

GNU General Public License v3.0 - Free to use, modify, and distribute, but subject to the following terms:

• Open Source Obligation: All derivative works must remain open source
• Same License: Modified versions must use the same license
• Copyright Notice: Original copyright notices must be retained

For the full text of the license, please refer to the LICENSE file.

🤝 Contributing

Contributions via PR are welcome. You can also submit suggestions through Discussions.