From a1a788dce8c8ed30b822c71dc3b3da4aa5a0746d Mon Sep 17 00:00:00 2001 From: yxw <3360776475@qq.com> Date: Fri, 28 Feb 2025 13:39:45 +0800 Subject: [PATCH] docs: add English README --- README_en.md | 164 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 164 insertions(+) create mode 100644 README_en.md diff --git a/README_en.md b/README_en.md new file mode 100644 index 000000000..531ed9ca6 --- /dev/null +++ b/README_en.md @@ -0,0 +1,164 @@ +

+ +![6e1279651f16d7fdf4727558b72bbaf1](https://github.com/user-attachments/assets/ead4c551-fc3c-48f7-a6f7-afbfdb820512) + +

+ +
+ +_✨ Easy-to-use Multi-platform LLM Chatbot & Development Framework ✨_ + +Soulter%2FAstrBot | Trendshift + +[![GitHub release (latest by date)](https://img.shields.io/github/v/release/Soulter/AstrBot)](https://github.com/Soulter/AstrBot/releases/latest) +python +Docker pull +Static Badge +[![wakatime](https://wakatime.com/badge/user/915e5316-99c6-4563-a483-ef186cf000c9/project/018e705a-a1a7-409a-a849-3013485e6c8e.svg)](https://wakatime.com/badge/user/915e5316-99c6-4563-a483-ef186cf000c9/project/018e705a-a1a7-409a-a849-3013485e6c8e) +![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.soulter.top%2Fastrbot%2Fstats&query=v&label=7%E6%97%A5%E6%B6%88%E6%81%AF%E4%B8%8A%E8%A1%8C%E9%87%8F&cacheSeconds=3600) +[![codecov](https://codecov.io/gh/Soulter/AstrBot/graph/badge.svg?token=FF3P5967B8)](https://codecov.io/gh/Soulter/AstrBot) + +Documentation ｜ +Issue Tracking +
+ +AstrBot is a loosely coupled, asynchronous chatbot and development framework that supports multi-platform deployment, featuring an easy-to-use plugin system and comprehensive Large Language Model (LLM) integration capabilities. + +## ✨ Key Features + +1. **LLM Conversations** - Supports various LLMs including OpenAI API, Google Gemini, Llama, Deepseek, ChatGLM, etc. Enables local model deployment via Ollama/LLMTuner. Features multi-turn dialogues, personality contexts, multimodal capabilities (image understanding), and speech-to-text (Whisper). +2. **Multi-platform Integration** - Supports QQ (OneBot), QQ Channels, WeChat (Gewechat), Feishu, and Telegram. Planned support for DingTalk, Discord, WhatsApp, and Xiaomi Smart Speakers. Includes rate limiting, whitelisting, keyword filtering, and Baidu content moderation. +3. **Agent Capabilities** - Native support for code execution, natural language TODO lists, web search. Integrates with [Dify Platform](https://astrbot.app/others/dify.html) for easy access to Dify assistants/knowledge bases/workflows. +4. **Plugin System** - Optimized plugin mechanism with minimal development effort. Supports multiple installed plugins. +5. **Web Dashboard** - Visual configuration management, plugin controls, logging, and WebChat interface for direct LLM interaction. +6. **High Stability & Modularity** - Event bus and pipeline architecture ensures high modularization and loose coupling. + +> [!TIP] +> Dashboard Demo: [https://demo.astrbot.app/](https://demo.astrbot.app/) +> Username: `astrbot`, Password: `astrbot` (LLM not configured for chat page) + +## ✨ Deployment + +#### Docker Deployment + +See docs: [Deploy with Docker](https://astrbot.app/deploy/astrbot/docker.html#docker-deployment) + +#### Windows Installer + +Requires Python (>3.10). See docs: [Windows Installer Guide](https://astrbot.app/deploy/astrbot/windows.html) + +#### Replit Deployment + +[![Run on Repl.it](https://repl.it/badge/github/Soulter/AstrBot)](https://repl.it/github/Soulter/AstrBot) + +#### CasaOS Deployment + +Community-contributed method. +See docs: [CasaOS Deployment](https://astrbot.app/deploy/astrbot/casaos.html) + +#### Manual Deployment + +See docs: [Source Code Deployment](https://astrbot.app/deploy/astrbot/cli.html) + +## ⚡ Platform Support + +| Platform | Status | Details | Message Types | +| -------------------------------------------------------------- | ------ | ------------------- | ------------------- | +| QQ (Official Bot) | ✔ | Private/Group chats | Text, Images | +| QQ (OneBot) | ✔ | Private/Group chats | Text, Images, Voice | +| WeChat (Personal) | ✔ | Private/Group chats | Text, Images, Voice | +| [Telegram](https://github.com/Soulter/astrbot_plugin_telegram) | ✔ | Private/Group chats | Text, Images | +| [WeChat Work](https://github.com/Soulter/astrbot_plugin_wecom) | ✔ | Private chats | Text, Images, Voice | +| Feishu | ✔ | Group chats | Text, Images | +| WeChat Open Platform | 🚧 | Planned | - | +| Discord | 🚧 | Planned | - | +| WhatsApp | 🚧 | Planned | - | +| Xiaomi Speakers | 🚧 | Planned | - | + +# 🦌 Roadmap + +> [!TIP] +> Suggestions welcome via Issues <3 + +- [ ] Ensure feature parity across all platform adapters +- [ ] Optimize plugin APIs +- [ ] Add default TTS services (e.g., GPT-Sovits) +- [ ] Enhance chat features with persistent memory +- [ ] i18n Planning + +## ❤️ Contributions + +All Issues/PRs welcome! Simply submit your changes to this project :) + +For major features, please discuss via Issues first. + +## 🌟 Support + +- Star this project! +- Support via [Afdian](https://afdian.com/a/soulter) +- WeChat support: [QR Code](https://drive.soulter.top/f/pYfA/d903f4fa49a496fda3f16d2be9e023b5.png) + +## ✨ Demos + +> [!NOTE] +> Code executor file I/O currently tested with Napcat(QQ)/Lagrange(QQ) + +
+ + + +_✨ Docker-based Sandboxed Code Executor (Beta) ✨_ + + + +_✨ Multimodal Input, Web Search, Text-to-Image ✨_ + + + +_✨ Natural Language TODO Lists ✨_ + + + + +_✨ Plugin System Showcase ✨_ + + + +_✨ Web Dashboard ✨_ + +![webchat](https://drive.soulter.top/f/vlsA/ezgif-5-fb044b2542.gif) + +_✨ Built-in Web Chat Interface ✨_ + +
+ +## ⭐ Star History + +> [!TIP] +> If this project helps you, please give it a star <3 + +
+ +[![Star History Chart](https://api.star-history.com/svg?repos=soulter/astrbot&type=Date)](https://star-history.com/#soulter/astrbot&Date) + +
+ +## Disclaimer + +1. Licensed under `AGPL-v3`. +2. WeChat integration uses [Gewechat](https://github.com/Devo919/Gewechat). Use at your own risk with non-critical accounts. +3. Users must comply with local laws and regulations. + + + + +_私は、高性能ですから!_ +