HuHoBot Mod Adapter

简体中文

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

A new-generation Minecraft server management bot solution, breaking through the limitations of traditional bot frameworks to provide a safer and more stable interactive experience.

🌟 Core Advantages

🚀 Features

Core Functions

• Seamless Binding: Instant server and control terminal binding via WebSocket
• Cross-Platform Support: Adapted for Fabric
• Smart Risk Control Avoidance: Event-driven non-intrusive communication protocol

Feature List

Advanced Features

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

📥 Installation Guide

Requirements

• Java 17+ Runtime
• Any supported Fabric core (including but not limited to versions 1.16+)

Quick Start

1. Visit GitHub Releases Page:

   • Open your browser and go to HuHoBot Releases
   • Download the latest version of the huhobot-vx.x.x-mcx.x.x-SNAPSHOT file

• Place Plugin File:

  • Put the downloaded huhobot-vx.x.x-mcx.x.x-SNAPSHOT file for the corresponding MC version into your server's mods directory

• Restart Server:

  • Restart your Minecraft server to load the new plugin

• Add the Bot

  • Join the community group, click on HuHo_Bot's avatar and add it to the group chat

• Complete Binding:

  • Follow the console prompts to complete the server and bot binding operation

Advanced Configuration (Optional)

• For custom functionality, please refer to ⚙️ Configuration Example for detailed settings

Notes:

• Ensure the server has Java 17+ runtime environment properly installed
• The plugin is compatible with all supported Fabric core versions. If no corresponding version is available, please compile the Mod yourself (see documentation for specific methods)

⚙️ Configuration Example

#Don't modify
serverId: null
#Don't modify
hashKey: null

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

motd:
  server_ip: "play.hypixel.net" #Motd image address when using "/查在线" (change to your server address)
  server_port: 25565 #Motd image port when using "/查在线" (change to your server port)
  api: "https://motdbe.blackbe.work/status_img/java?host={server_ip}:{server_port}" #Motd image address API when using "/查在线" (do not modify unless necessary) (must return an image)
  text: "Total {online} players online" #Motd text when using "/查在线", supports PlaceholderAPI, leave empty to not display
  output_online_list: true #Whether to display online list
  post_img: true #Whether to display Motd image

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

#Custom execution commands
customCommand:
  - key: "加白名" #Execution keyword, use "/执行 keyword parameter1 parameter2" to execute custom commands
    command: "whitelist add &1" #&1 is parameter placeholder, first parameter is &1, second is &2, and so on
    permission: 0 #0 is normal permission, greater than 0 is administrator permission

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

❓ Frequently Asked Questions

Configuring Custom Commands

Via Configuration File

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

• key: Trigger keyword for the command (string)
• command: Actual server command to execute (string)
• permission: Permission level (integer)

Example configuration:

customCommand:
  - key: "加白名" #Execution keyword, use "/执行 keyword parameter1 parameter2" to execute custom commands
    command: "whitelist add &1" #&1 is parameter placeholder, first parameter is &1, second is &2, and so on
    permission: 0 #0 is normal permission, greater than 0 is administrator permission

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

View Development Documentation

If you need 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 must comply with the following terms:

• Open Source Obligation: Any derivative works must remain open source
• Same License: Modified versions must use the same license
• Copyright Notice: Must retain original copyright notice

For the complete license text, please see the LICENSE file

🤝 Contributing

Welcome to submit PRs or make suggestions via Discussions