General Introduction
NGCBot is a HOOK mechanism based on the development of WeChat robot open source project, created by the developer ngc660sec (Yunshan/eXM) and hosted on GitHub. after two years of iteration, the current version of the V2.3, the function of the initial simple push to cover the initial simple push to cover the safety of the news pushes timed, AI intelligent dialog, group chat automation management and a wealth of entertainment tools. The projectDesigned for WindowsNGCBot is completely free and open source, and can be easily deployed and customized by Python. NGCBot is not only suitable for users concerned about network security information, but also meets the diversified needs of group chat management, daily entertainment, and technology development, which can be used by beginners and customized by technology enthusiasts, making it both practical and flexible.
Function List
- Security News Push: Regularly grab and push the latest information from FreeBuf, Prophet, Security, and Chianxin attack and defense communities.
- AI Dialogue and Painting: Docking models such as GPT, Starfire, Thousand Sails, Mixed Meta, DeepSeek, etc., supporting intelligent responses and image generation.
- Group Chat Management: Provide automated functions such as keyword pulling people into groups, welcome to groups, automatic group messaging and so on.
- Entertainment Tools: Includes KFC copywriting, dog licking diary, petting calendar, randomized images/videos, emoji generation, etc.
- Useful Queries: Support vulnerability query, cell phone number attribution, weather forecast, horoscope, micro-step threat intelligence and so on.
- point system: Users sign in or interact to accumulate points and unlock advanced features such as AI services.
- video number resolution: Parse and download WeChat Video Number content with convenient links.
- Highly customizable: Support for adjusting push time, keyword triggers, function switches, etc. Code is open for secondary development.
Using Help
Installation process
NGCBot needs to run on a Windows system, here are the detailed deployment steps:
1. Preparing the environment
- Installing Git: Download from git-scm.com for code.
- Installing Python: Recommended version 3.8.10 (range 3.8.10-3.12), downloaded from python.org and added to the PATH.
- Download WeChat Client: Recommended WeChatSetup-3.9.10.27 (corresponds to wcferry==39.2.4.0) from the GitHub Releases Get.
2. Access to project code
- Enter the following command at the command line to clone the code:
git clone https://github.com/ngc660sec/NGCBot.git
- Or click "Download ZIP" on the GitHub page to download and unzip it.
3. Installation of dependencies
- Go to the project catalog:
cd NGCBot
- Use domestic mirrors to speed up the installation of dependencies:
pip config set global.index-url https://mirrors.tuna.tsinghua.edu.cn/pypi/web/simple
python -m pip install --upgrade pip
pip install -r requirements.txt
- Make sure the WCF version matches the WeChat version (e.g. wcferry==39.2.4.0 corresponds to WeChatSetup-3.9.10.27).
4. Activation of the robot
- Close the microsoft client and run the startup command:
python main.py
- The program automatically opens WeChat, use the cell phone to scan the code to log in, the command line displays "Initialization of the necessary files is complete" that is successful.
5. Configuration functions
- show (a ticket)
Config/config.yaml
file for the necessary configuration: - super-administrator: send a message to the bot to get the wxid, fill in the
SuperAdmin
(Multiple supported, separated by commas). - AI Key::
- Starfire: Visit the official website to create an app, fill in APPID, APISecret, APIKey.
- Chifan: Get the Access Key and Secret Key from Baidu Chifan.
- Other models (e.g., Hybrid, DeepSeek) are similar, refer to the official guidelines.
- Push settings: in
PushTime
Set the news push time (e.g. "08:00"). - Group Chat Management: Configuration
RoomKey
(Keyword pull group),WelcomeMsg
(Welcome to the group), etc.
Operation of the main functions
Security News Push
- exist
config.yaml
Set the push time (e.g. "08:00") and source in the - Add the bot to the group chat and activate it by sending "Enable Push".
- The bot pushes daily timings such as "[FreeBuf] Latest Vulnerability Alert: XXX".
AI Dialogue and Painting
- dialogues::
- Configure the AI key and turn it on
AiSwitch
The - Send a message (e.g. "Beijing weather") and the bot replies "Beijing sunny, 5-15°C".
- paint::
- Configure the Chifan Painting key.
- Send "Draw a cat" and the robot generates and returns a picture.
- If it fails, check if there are enough points (normal users need to consume points).
Group Chat Management
- Keyword pulling group::
- Send "get group chat id" to get roomid.
- exist
RoomKey
Set the keyword (e.g. "enter group") and roomid. - The user sends "Enter Group" and is automatically pulled into the designated group.
- welcome to the group::
- exist
WelcomeMsg
Set the text (e.g. "Welcome aboard, no swiping please"). - Support card form, need to fill in title, url and other parameters.
- automatic mass mailing::
- exist
AutoMsg
Set the content (e.g., "Daily Security Reminder") and time. - The bot is sent to the designated group chat on time.
entertainment function
- Mapping Calendar: Send "Fishing Calendar" to return a picture of the month's Fishing Calendar.
- KFC CopywritingSend "KFC" to return randomized funny text (e.g. "It's Thursday, have a chicken wing to calm down").
- emoji::
- (of a computer) run
meme download
Download the resource. - Send "Random Emoji" to get dynamic emoji (requires WCF ≥ 39.2.4.0).
- video number resolution: Send a link to the video number and the robot returns the download address.
point system
- sign in: Send a "check-in" to get daily points (default 10 points, adjustable).
- consult (a document etc): Send "Points Inquiry" to check your remaining points.
- utilization: Points are consumed for AI conversations/painting, etc., but are not consumed by administrators.
Inquiry tool
- climatic: Send "Beijing Weather" to return to the day's forecast.
- Vulnerability Search: Send "CVE-2023-1234" to return vulnerability details.
- threat intelligence: Send an IP address to query MicroStep Intelligence.
caveat
- version compatibility: The version of WeChat and WCF need to be the same, otherwise the startup will fail.
- hardware requirement: 4 cores and 8GB of RAM are recommended to avoid lagging in high-frequency calls.
- problem screening::
- Startup failure: check
logs/wcf.txt
Log, close microsoft and retry. - Function Failure: Verify that the configuration file is filled out completely (e.g., AI key).
- video tutorial: OfficialProvide tutorials on Website B, covering installation and development.
NGCBot is simple and intuitive to deploy and use, with configuration files adjusted for personalized functionality. Whether it's pushing news, managing group chats, or entertaining interactions, users can get started quickly, and tech enthusiasts can go deeper with open source code.