This project provides a Node.js-based WeChat bot designed for personal use, primarily to send daily messages like weather updates and romantic quotes to a partner. It also includes features like an AI chatbot for conversation and a garbage classification lookup. The project targets users new to Node.js development, offering a simplified experience compared to more complex WeChat automation tools.

How It Works

The bot leverages the Wechaty framework, which allows Node.js applications to interact with WeChat. It utilizes Puppeteer for browser automation to manage WeChat web client interactions. For AI chat, it integrates with third-party APIs like TianXing and Turing, requiring users to obtain their own API keys. The core functionality revolves around scheduled tasks for sending messages and event-driven responses for chatbot interactions.

Quick Start & Requirements

• Install/Run: Docker is the recommended installation method.
  • docker pull aibotk/wechat-bot
  • Configure config/index.js with personal details and API keys.
  • Run: docker run -e TZ="Asia/Shanghai" --name=chatBot --volume="$(pwd)/config/":/bot/config aibotk/wechat-bot (foreground) or add -d for background.
• Prerequisites: Node.js (v16+ recommended), Docker.
• Setup: Docker deployment is straightforward, but initial Puppet download can be slow. Manual Node.js setup requires configuring npm registry to Taobao for faster Chromium downloads.
• Links: TianXing Data, Turing Robot

Highlighted Details

• Supports sending daily weather and romantic quotes.
• Integrates with TianXing and Turing for AI chatbot functionality.
• Includes a garbage classification lookup feature (query with ?垃圾名称).
• Docker support simplifies deployment and dependency management.

Maintenance & Community

The project has seen recent updates, including switching to wechat4u puppet (Jan 2023) and upgrading Wechaty to v1.x (July 2022). Docker support was added in May 2021. A technical exchange group is available via WeChat.

Licensing & Compatibility

The project is open-source, but the README notes that using web-based WeChat access may carry a risk of account login restrictions. It explicitly states that payment-related features (red packets, transfers) are not supported.

Limitations & Caveats

The project is intended for personal interest and technical exchange; users are warned about potential WeChat account restrictions for web login. The effectiveness of free AI chatbot APIs is noted as limited. The project is not responsible for any account bans resulting from usage.