ChatGPT-wechat-bot  by AutumnWhj

WeChat bot using ChatGPT

created 2 years ago
4,733 stars

Top 10.7% on sourcepulse

GitHubView on GitHub
Project Summary

This project provides a WeChat bot powered by ChatGPT, enabling users to engage in contextual conversations with the AI through their WeChat client. It's designed for individual users and developers looking to integrate ChatGPT's capabilities into their personal messaging experience.

How It Works

The bot leverages Puppeteer to control a WeChat web instance, allowing it to interact with messages. It processes user input, sends it to the OpenAI API (via a configurable reverse proxy), and relays the ChatGPT response back to WeChat. Key features include maintaining conversation context, resetting context with a keyword, and responding to mentions in group chats.

Quick Start & Requirements

  • Install dependencies and run: npm i then npm run dev (or pnpm i and pnpm run dev).
  • Requires Node.js >= 16.8.
  • An OpenAI API key is mandatory.
  • A reverse proxy URL for the OpenAI API is recommended.
  • Puppeteer may require additional system dependencies (e.g., chromium-browser on Ubuntu).
  • See OpenAI Platform for API key acquisition.

Highlighted Details

  • Supports contextual conversations and context reset via a keyword.
  • Can be triggered by mentioning the bot in group chats.
  • Offers configurable keywords for private and group chats.
  • groupReplyMode is enabled by default, including the original question in group replies.

Maintenance & Community

The project welcomes contributions. Links to community channels are not explicitly provided in the README.

Licensing & Compatibility

The project's license is not specified in the README. Compatibility for commercial use or closed-source linking is not detailed.

Limitations & Caveats

The bot may produce incomplete replies due to ChatGPT's length limits, requiring users to prompt for continuation. Troubleshooting for Puppeteer's browser launch issues on Unix-like systems is linked to the Puppeteer documentation. There's a note about deleting WechatEveryDay.memory-card to log out.

Health Check
Last commit

11 months ago

Responsiveness

1 day

Pull Requests (30d)
0
Issues (30d)
0
Star History
25 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.