HuHoBot-Spigot

HuHoBot Spigot Adapter

GitHub Release

License

Build Status

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

- Folia Support: Instant binding between server and control terminal via WebSocket - Folia Support: Compatible with all Spigot/Paper versions 1.8+ - Folia Support: Event-driven non-intrusive communication protocol - Folia Support: Works with Folia server cores

Feature List

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 Visit the GitHub Releases page - Download the latest version of the `HuHoBot-vx.x.x-Spigot.jar` file

2. Place the plugin file: - Move the downloaded `HuHoBot-vx.x.x-Spigot.jar` file into the server's `plugins` directory

3. Restart the server: - Restart your Minecraft server to load the new plugin

4. Add the bot: - Add the bot, click on the avatar of "HuHo_Bot" and add it to the group chat

5. 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

```yaml

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

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:

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

Example configuration is as follows:

```yaml 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:

- Copyright Notice: All derivative works must remain open source - Copyright Notice: 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.