diff --git a/README.md b/README.md index 7b56c756a..607fd06c5 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,12 @@
| 💙 Role-playing & Emotional Companionship | +💙 Roleplay & Companionship | ✨ Proactive Agent | 🚀 General Agentic Capabilities | 🧩 1000+ Community Plugins | @@ -73,18 +73,18 @@ AstrBot is an open-source all-in-one Agent chatbot platform that integrates with ### One-Click Deployment -For users who want to quickly experience AstrBot, are familiar with command-line usage, and can install a `uv` environment on their own, we recommend the `uv` one-click deployment method ⚡️: +For users who want to quickly experience AstrBot, are familiar with the command line, and can install the `uv` environment themselves, we recommend using the `uv` one-click deployment method ⚡️. ```bash uv tool install astrbot -astrbot init # Only execute this command for the first time to initialize the environment +astrbot init # Run this command only for the first time to initialize the environment astrbot run ``` -> Requires [uv](https://docs.astral.sh/uv/) to be installed. +> Requires [uv](https://docs.astral.sh/uv/) installation. > [!NOTE] -> For macOS user: due to macOS security checks, the first run of the `astrbot` command may take longer (about 10-20s). +> For macOS users: Due to macOS security checks, running the `astrbot` command for the first time may take a long time (about 10-20 seconds). Update `astrbot`: @@ -94,134 +94,140 @@ uv tool upgrade astrbot ### Docker Deployment -For users familiar with containers and looking for a more stable, production-ready deployment method, we recommend deploying AstrBot with Docker / Docker Compose. +For users familiar with containers who prefer a more stable deployment method suitable for production environments, we recommend using Docker / Docker Compose to deploy AstrBot. -Please refer to the official documentation: [Deploy AstrBot with Docker](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot). +Please refer to the official documentation [Deploy AstrBot with Docker](https://astrbot.app/deploy/astrbot/docker.html). ### Deploy on RainYun -For users who want one-click deployment and do not want to manage servers themselves, we recommend RainYun's one-click cloud deployment service ☁️: +For users who want to deploy AstrBot with one click and do not want to manage servers themselves, we recommend RainYun's one-click cloud deployment service ☁️: [](https://app.rainyun.com/apps/rca/store/5994?ref=NjU1ODg0) -### Desktop Application Deployment +### Desktop Client Deployment -For users who want to use AstrBot on desktop and mainly use ChatUI, we recommend AstrBot App. +For users who wish to use AstrBot on the desktop and primarily use ChatUI as the entry point, we recommend using the AstrBot App. -Visit [AstrBot-desktop](https://github.com/AstrBotDevs/AstrBot-desktop) to download and install; this method is designed for desktop usage and is not recommended for server scenarios. +Go to [AstrBot-desktop](https://github.com/AstrBotDevs/AstrBot-desktop) to download and install; this method is intended for desktop use and is not recommended for server scenarios. ### Launcher Deployment -For desktop users who also want fast deployment and isolated multi-instance usage, we recommend AstrBot Launcher. +Also for desktop use, for users who want to quickly deploy and achieve environment isolation for multiple instances, we recommend AstrBot Launcher. -Visit [AstrBot Launcher](https://github.com/Raven95676/astrbot-launcher) to download and install. +Go to [AstrBot Launcher](https://github.com/Raven95676/astrbot-launcher) to download and install. ### Deploy on Replit -Replit deployment is maintained by the community and is suitable for online demos and lightweight trials. +The Replit deployment is maintained by the community and is suitable for online demonstrations and lightweight trial scenarios. [](https://repl.it/github/AstrBotDevs/AstrBot) ### AUR -AUR deployment targets Arch Linux users who prefer installing AstrBot through the system package workflow. +The AUR method is intended for Arch Linux users who wish to install AstrBot via the system package manager. -Run the command below to install `astrbot-git`, then start AstrBot in your local environment. +Run the following command in the terminal to install the `astrbot-git` package. Once installed, you can start using it. ```bash yay -S astrbot-git ``` -**More deployment methods** +**More Deployment Methods** -If you need panel-based management or deeper customization, see [BT-Panel Deployment](https://astrbot.app/deploy/astrbot/btpanel.html) for BT Panel app-store setup, [1Panel Deployment](https://astrbot.app/deploy/astrbot/1panel.html) for 1Panel app-market deployment, [CasaOS Deployment](https://astrbot.app/deploy/astrbot/casaos.html) for NAS/home-server visual deployment, and [Manual Deployment](https://astrbot.app/deploy/astrbot/cli.html) for fully custom source-based installation with `uv`. +If you need a panel-based or highly customized deployment, please refer to [BT Panel](https://astrbot.app/deploy/astrbot/btpanel.html) (BT Panel App Store installation), [1Panel](https://astrbot.app/deploy/astrbot/1panel.html) (1Panel App Store installation), [CasaOS](https://astrbot.app/deploy/astrbot/casaos.html) (NAS / Home Server visual deployment), and [Manual Deployment](https://astrbot.app/deploy/astrbot/cli.html) (Full custom installation based on source code and `uv`). ## Supported Messaging Platforms -Connect AstrBot to your favorite chat platform. +Connect AstrBot to your favorite chat platforms. | Platform | Maintainer | |---------|---------------| -| QQ | Official | -| OneBot v11 protocol implementation | Official | -| Telegram | Official | -| Wecom & Wecom AI Bot | Official | -| WeChat Official Accounts | Official | -| Feishu (Lark) | Official | -| DingTalk | Official | -| Slack | Official | -| Discord | Official | -| LINE | Official | -| Satori | Official | -| Misskey | Official | -| WhatsApp (Coming Soon) | Official | -| [Matrix](https://github.com/stevessr/astrbot_plugin_matrix_adapter) | Community | -| [KOOK](https://github.com/wuyan1003/astrbot_plugin_kook_adapter) | Community | -| [VoceChat](https://github.com/HikariFroya/astrbot_plugin_vocechat) | Community | +| **QQ** | Official | +| **OneBot v11** | Official | +| **Telegram** | Official | +| **WeCom App & Bot** | Official | +| **WeChat Customer Service & Official Account** | Official | +| **Lark (Feishu)** | Official | +| **DingTalk** | Official | +| **Slack** | Official | +| **Discord** | Official | +| **LINE** | Official | +| **Satori** | Official | +| **Misskey** | Official | +| **Whatsapp (Coming Soon)** | Official | +| [**Matrix**](https://github.com/stevessr/astrbot_plugin_matrix_adapter) | Community | +| [**KOOK**](https://github.com/wuyan1003/astrbot_plugin_kook_adapter) | Community | +| [**VoceChat**](https://github.com/HikariFroya/astrbot_plugin_vocechat) | Community | -## Supported Model Services +## Supported Model Providers -| Service | Type | +| Provider | Type | |---------|---------------| -| OpenAI and Compatible Services | LLM Services | -| Anthropic | LLM Services | -| Google Gemini | LLM Services | -| Moonshot AI | LLM Services | -| Zhipu AI | LLM Services | -| DeepSeek | LLM Services | -| Ollama (Self-hosted) | LLM Services | -| LM Studio (Self-hosted) | LLM Services | -| [AIHubMix](https://aihubmix.com/?aff=4bfH) | LLM Services (API Gateway, supports all models) | -| [CompShare](https://www.compshare.cn/?ytag=GPU_YY-gh_astrbot&referral_code=FV7DcGowN4hB5UuXKgpE74) | LLM Services | -| [302.AI](https://share.302.ai/rr1M3l) | LLM Services | -| [TokenPony](https://www.tokenpony.cn/3YPyf) | LLM Services | -| [SiliconFlow](https://docs.siliconflow.cn/cn/usercases/use-siliconcloud-in-astrbot) | LLM Services | -| [PPIO Cloud](https://ppio.com/user/register?invited_by=AIOONE) | LLM Services | -| ModelScope | LLM Services | -| OneAPI | LLM Services | -| Dify | LLMOps Platforms | -| Alibaba Cloud Bailian Applications | LLMOps Platforms | -| Coze | LLMOps Platforms | -| OpenAI Whisper | Speech-to-Text Services | -| SenseVoice | Speech-to-Text Services | -| OpenAI TTS | Text-to-Speech Services | -| Gemini TTS | Text-to-Speech Services | -| GPT-Sovits-Inference | Text-to-Speech Services | -| GPT-Sovits | Text-to-Speech Services | -| FishAudio | Text-to-Speech Services | -| Edge TTS | Text-to-Speech Services | -| Alibaba Cloud Bailian TTS | Text-to-Speech Services | -| Azure TTS | Text-to-Speech Services | -| Minimax TTS | Text-to-Speech Services | -| Volcano Engine TTS | Text-to-Speech Services | +| Custom | Any OpenAI API compatible service | +| OpenAI | LLM | +| Anthropic | LLM | +| Google Gemini | LLM | +| Moonshot AI | LLM | +| Zhipu AI | LLM | +| DeepSeek | LLM | +| Ollama (Local) | LLM | +| LM Studio (Local) | LLM | +| [AIHubMix](https://aihubmix.com/?aff=4bfH) | LLM (API Gateway, supports all models) | +| [Uyun AI](https://www.compshare.cn/?ytag=GPU_YY-gh_astrbot&referral_code=FV7DcGowN4hB5UuXKgpE74) | LLM (API Gateway, supports all models) | +| [SiliconFlow](https://docs.siliconflow.cn/cn/usercases/use-siliconcloud-in-astrbot) | LLM (API Gateway, supports all models) | +| [PPIO](https://ppio.com/user/register?invited_by=AIOONE) | LLM (API Gateway, supports all models) | +| [302.AI](https://share.302.ai/rr1M3l) | LLM (API Gateway, supports all models)| +| [TokenPony](https://www.tokenpony.cn/3YPyf) | LLM (API Gateway, supports all models)| +| ModelScope | LLM | +| OneAPI | LLM | +| Dify | LLMOps Platform | +| Aliyun Bailian | LLMOps Platform | +| Coze | LLMOps Platform | +| OpenAI Whisper | Speech-to-Text | +| SenseVoice | Speech-to-Text | +| OpenAI TTS | Text-to-Speech | +| Gemini TTS | Text-to-Speech | +| GPT-Sovits-Inference | Text-to-Speech | +| GPT-Sovits | Text-to-Speech | +| FishAudio | Text-to-Speech | +| Edge TTS | Text-to-Speech | +| Aliyun Bailian TTS | Text-to-Speech | +| Azure TTS | Text-to-Speech | +| Minimax TTS | Text-to-Speech | +| Volcengine TTS | Text-to-Speech | -## ❤️ Sponsors +## ❤️ Contribution -
|---|
| 💙 Jeux de rôle & Accompagnement émotionnel | -✨ Agent proactif | -🚀 Capacités agentiques générales | -🧩 1000+ Plugins de communauté | -
|---|---|---|---|
| 💙 Jeu de rôle & Compagnonnage | +✨ Agent Proactif | +🚀 Capacités Agentic Générales | +🧩 1000+ Plugins Communautaires | +
|---|---|---|---|
-### Serveur Discord
-
-
-
-| 💙 ロールプレイ & 感情的な対話 | -✨ プロアクティブ・エージェント (Proactive Agent) | -🚀 汎用 エージェント的能力 | +💙 ロールプレイング & 感情的な交友 | +✨ 能動的エージェント | +🚀 一般的な Agentic 機能 | 🧩 1000+ コミュニティプラグイン | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 💙 Ролевые игры & Эмоциональная поддержка | -✨ Проактивный Агент (Agent) | -🚀 Универсальные возможности Агента | +💙 Ролевые игры и Эмоциональное общение | +✨ Проактивный Агент | +🚀 Общие агентные возможности | 🧩 1000+ плагинов сообщества | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 💙 角色扮演 & 情感陪伴 | -✨ 主動式 Agent | -🚀 通用 Agentic 能力 | -🧩 1000+ 社區外掛程式 | -
|---|---|---|---|
| 💙 角色扮演 & 情感陪伴 | +✨ 主動式 Agent | +🚀 通用 Agentic 能力 | +🧩 1000+ 社區插件 | +
|---|---|---|---|
-### Discord 群組
-
-
-
-