NGCBot is a feature-rich WeChat robot designed for personal and group chat automation, targeting users who want to enhance their WeChat experience with AI integration, information retrieval, and automated tasks. It offers a wide array of functionalities, including security news pushes, vulnerability lookups, AI-powered conversations and image generation, and various utility functions, aiming to be user-friendly for beginners.
How It Works
The bot leverages a Hook mechanism, specifically utilizing the WeChatFerry library, to intercept and process WeChat messages. It operates as a Python application that runs on Windows, interacting with a WeChat client. The architecture is modular, with distinct servers for API handling, bot functions, message processing, database operations, and push services, allowing for extensibility and organized development. It supports multiple domestic AI models for chat and image generation, integrating them via API keys.
Quick Start & Requirements
- Installation: Clone the repository and install dependencies using
pip install -r requirements.txt
.
- Prerequisites:
- Windows operating system.
- Python 3.8.10 to 3.13.
- Specific WeChat client versions compatible with
wcferry
(e.g., 39.4.2.2 for WeChatSetup-3.9.12.17).
- API keys for various AI services (e.g., Spark, Qianfan, Hunyuan, DeepSeek, Doubao) and other utilities.
- Setup: Requires cloning the repository, installing Python packages, downloading a compatible WeChat client, and configuring API keys in
Config.yaml
.
- Links:
Highlighted Details
- Supports multiple AI models for chat (GPT, Spark, Qianfan, Hunyuan, Moonshot, Zhipu, DeepSeek, Doubao) and image generation.
- Features automated group management, including keyword-based invitations and welcome messages.
- Integrates with security news sources like FreeBuf, Xianzhi, AnquanKe, and QiAnXin.
- Includes utility functions such as vulnerability lookup, phone number origin query, weather forecasts, and video parsing.
- Offers a points system for users and administrators.
Maintenance & Community
- The project is under active development with frequent updates and new feature additions.
- Community interaction is encouraged via a WeChat group for discussion and bug reporting.
- Links to official WeChat public accounts are provided for updates and support.
Licensing & Compatibility
- The project is open-source.
- Explicitly states that users should not engage in illegal activities.
- No specific license (e.g., MIT, GPL) is mentioned in the README, which could imply a custom or unspecified license.
Limitations & Caveats
- Strictly limited to Windows operating systems; not compatible with Linux.
- Requires specific, older versions of the WeChat client, which may pose compatibility or security risks.
- Some advanced features, like automatic friend acceptance and automatic transfer reception, are noted as incompatible with certain
wcferry
versions.
- The project mentions a paid "member group" for configuration and development assistance, which might indicate a tiered support model.