Gewechat  by Devo919

WeChat bot framework for personal account development

created 1 year ago
3,363 stars

Top 14.8% on sourcepulse

GitHubView on GitHub
Project Summary

Gewechat provides an open-source framework for personal WeChat secondary development, enabling automated messaging, contact management, and integration with AI models via a RESTful API. It targets developers and users looking to build custom WeChat bots and automation tools without requiring local WeChat installations or phone plugins, offering a stable, scan-to-login approach.

How It Works

The framework utilizes a Dockerized environment that handles WeChat login via QR code scanning, abstracting the complexities of WeChat's protocols. It exposes a RESTful API for interacting with WeChat functionalities, including sending/receiving messages, managing contacts and groups, and handling user profiles. This API-driven design allows integration with any programming language, simplifying development and deployment.

Quick Start & Requirements

  • Install: Follow Docker installation steps for CentOS/Ubuntu.
  • Run: docker run -itd -v /root/temp:/root/temp -p 2531:2531 -p 2532:2532 --privileged=true --name=gewe gewe /usr/sbin/init
  • Prerequisites: Docker (version 26.1.4 recommended), CentOS 7 or Ubuntu 22.04, 4-core 8GB RAM recommended. Server must have external network access and ports 2531/2532 open. Users must deploy on a server within the same province as their WeChat account for stability.
  • Docs: API Documentation

Highlighted Details

  • Supports sending various message types (text, image, file, mini-program, etc.).
  • Enables group and contact management (adding, deleting, remarking, inviting).
  • Facilitates integration with AI models like ChatGPT and Sora.
  • Offers features for managing favorites and personal profile settings.

Maintenance & Community

The project states it is no longer actively maintained due to limited resources and warns of potential account bans due to outdated versions. Users are advised to use with caution. A QQ group is available for community exchange.

Licensing & Compatibility

The project is licensed under a free, open-source model for learning and technical research. It explicitly prohibits commercial or illegal use.

Limitations & Caveats

The project is not actively maintained and may lead to account bans due to outdated versions. Users must deploy on a server in the same province as their WeChat account for stability. The framework is intended for personal entertainment and not for commercial use.

Health Check
Last commit

3 months ago

Responsiveness

Inactive

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

Explore Similar Projects

Feedback? Help us improve.