docs: update translations of README
This commit is contained in:
Soulter
287
README_en.md
287
README_en.md
@@ -1,182 +1,233 @@
|
|||||||
<p align="center">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
|
|
||||||
_✨ Easy-to-use Multi-platform LLM Chatbot & Development Framework ✨_
|
<br>
|
||||||
|
|
||||||
|
<div>
|
||||||
<a href="https://trendshift.io/repositories/12875" target="_blank"><img src="https://trendshift.io/api/badge/repositories/12875" alt="Soulter%2FAstrBot | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
|
<a href="https://trendshift.io/repositories/12875" target="_blank"><img src="https://trendshift.io/api/badge/repositories/12875" alt="Soulter%2FAstrBot | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
|
||||||
|
<a href="https://hellogithub.com/repository/AstrBotDevs/AstrBot" target="_blank"><img src="https://api.hellogithub.com/v1/widgets/recommend.svg?rid=d127d50cd5e54c5382328acc3bb25483&claim_uid=ZO9by7qCXgSd6Lp&t=2" alt="Featured｜HelloGitHub" style="width: 250px; height: 54px;" width="250" height="54" /></a>
|
||||||
[](https://github.com/AstrBotDevs/AstrBot/releases/latest)
|
|
||||||
<img src="https://img.shields.io/badge/python-3.10+-blue.svg" alt="python">
|
|
||||||
<a href="https://hub.docker.com/r/soulter/astrbot"><img alt="Docker pull" src="https://img.shields.io/docker/pulls/soulter/astrbot"/></a>
|
|
||||||
<a href="https://qm.qq.com/cgi-bin/qm/qr?k=wtbaNx7EioxeaqS9z7RQWVXPIxg2zYr7&jump_from=webapi&authKey=vlqnv/AV2DbJEvGIcxdlNSpfxVy+8vVqijgreRdnVKOaydpc+YSw4MctmEbr0k5"><img alt="Static Badge" src="https://img.shields.io/badge/QQ群-630166526-purple"></a>
|
|
||||||
[](https://wakatime.com/badge/user/915e5316-99c6-4563-a483-ef186cf000c9/project/018e705a-a1a7-409a-a849-3013485e6c8e)
|
|
||||||
|
|
||||||
[](https://codecov.io/gh/AstrBotDevs/AstrBot)
|
|
||||||
|
|
||||||
<a href="https://astrbot.app/">Documentation</a> ｜
|
|
||||||
<a href="https://github.com/AstrBotDevs/AstrBot/issues">Issue Tracking</a>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
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.
|
<br>
|
||||||
|
|
||||||
## ✨ Key Features
|
<div>
|
||||||
|
<img src="https://img.shields.io/github/v/release/AstrBotDevs/AstrBot?style=for-the-badge&color=76bad9" href="https://github.com/AstrBotDevs/AstrBot/releases/latest">
|
||||||
|
<img src="https://img.shields.io/badge/python-3.10+-blue.svg?style=for-the-badge&color=76bad9" alt="python">
|
||||||
|
<a href="https://hub.docker.com/r/soulter/astrbot"><img alt="Docker pull" src="https://img.shields.io/docker/pulls/soulter/astrbot.svg?style=for-the-badge&color=76bad9"/></a>
|
||||||
|
<a href="https://qm.qq.com/cgi-bin/qm/qr?k=wtbaNx7EioxeaqS9z7RQWVXPIxg2zYr7&jump_from=webapi&authKey=vlqnv/AV2DbJEvGIcxdlNSpfxVy+8vVqijgreRdnVKOaydpc+YSw4MctmEbr0k5"><img alt="QQ_community" src="https://img.shields.io/badge/QQ群-775869627-purple?style=for-the-badge&color=76bad9"></a>
|
||||||
|
<a href="https://t.me/+hAsD2Ebl5as3NmY1"><img alt="Telegram_community" src="https://img.shields.io/badge/Telegram-AstrBot-purple?style=for-the-badge&color=76bad9"></a>
|
||||||
|
<img src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.soulter.top%2Fastrbot%2Fplugin-num&query=%24.result&suffix=%E4%B8%AA&style=for-the-badge&label=%E6%8F%92%E4%BB%B6%E5%B8%82%E5%9C%BA&cacheSeconds=3600">
|
||||||
|
</div>
|
||||||
|
|
||||||
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).
|
<br>
|
||||||
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://dify.ai/) 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]
|
<a href="https://github.com/AstrBotDevs/AstrBot/blob/master/README.md">中文</a> ｜
|
||||||
> Dashboard Demo: [https://demo.astrbot.app/](https://demo.astrbot.app/)
|
<a href="https://github.com/AstrBotDevs/AstrBot/blob/master/README_ja.md">日本語</a> ｜
|
||||||
> Username: `astrbot`, Password: `astrbot` (LLM not configured for chat page)
|
<a href="https://astrbot.app/">Documentation</a> ｜
|
||||||
|
<a href="https://blog.astrbot.app/">Blog</a> ｜
|
||||||
|
<a href="https://astrbot.featurebase.app/roadmap">Roadmap</a> ｜
|
||||||
|
<a href="https://github.com/AstrBotDevs/AstrBot/issues">Issue Tracker</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
## ✨ Deployment
|
AstrBot is an open-source all-in-one Agent chatbot platform and development framework.
|
||||||
|
|
||||||
#### Docker Deployment
|
## Key Features
|
||||||
|
|
||||||
See docs: [Deploy with Docker](https://astrbot.app/deploy/astrbot/docker.html#docker-deployment)
|
1. **LLM Conversations**. Supports integration with various large language model services. Features include multimodal capabilities, tool calling, MCP, native knowledge base, character personas, and more.
|
||||||
|
2. **Multi-Platform Support**. Integrates with QQ, WeChat Work, WeChat Official Accounts, Feishu, Telegram, DingTalk, Discord, KOOK, and other platforms. Supports rate limiting, whitelisting, and Baidu content moderation.
|
||||||
|
3. **Agent Capabilities**. Fully optimized agentic features including multi-turn tool calling, built-in sandboxed code executor, web search, and more.
|
||||||
|
4. **Plugin Extensions**. Deeply optimized plugin mechanism supporting [plugin development](https://astrbot.app/dev/plugin.html) to extend functionality, with a rich community plugin ecosystem.
|
||||||
|
5. **Web UI**. Visual configuration and management of your bot with comprehensive features.
|
||||||
|
|
||||||
#### Windows Installer
|
## Deployment Methods
|
||||||
|
|
||||||
Requires Python (>3.10). See docs: [Windows Installer Guide](https://astrbot.app/deploy/astrbot/windows.html)
|
#### Docker Deployment (Recommended 🥳)
|
||||||
|
|
||||||
#### Replit Deployment
|
We recommend deploying AstrBot using Docker or Docker Compose.
|
||||||
|
|
||||||
|
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).
|
||||||
|
|
||||||
|
#### BT-Panel Deployment
|
||||||
|
|
||||||
|
AstrBot has partnered with BT-Panel and is now available in their marketplace.
|
||||||
|
|
||||||
|
Please refer to the official documentation: [BT-Panel Deployment](https://astrbot.app/deploy/astrbot/btpanel.html).
|
||||||
|
|
||||||
|
#### 1Panel Deployment
|
||||||
|
|
||||||
|
AstrBot has been officially listed on the 1Panel marketplace.
|
||||||
|
|
||||||
|
Please refer to the official documentation: [1Panel Deployment](https://astrbot.app/deploy/astrbot/1panel.html).
|
||||||
|
|
||||||
|
#### Deploy on RainYun
|
||||||
|
|
||||||
|
AstrBot has been officially listed on RainYun's cloud application platform with one-click deployment.
|
||||||
|
|
||||||
|
[](https://app.rainyun.com/apps/rca/store/5994?ref=NjU1ODg0)
|
||||||
|
|
||||||
|
#### Deploy on Replit
|
||||||
|
|
||||||
|
Community-contributed deployment method.
|
||||||
|
|
||||||
[](https://repl.it/github/AstrBotDevs/AstrBot)
|
[](https://repl.it/github/AstrBotDevs/AstrBot)
|
||||||
|
|
||||||
|
#### Windows One-Click Installer
|
||||||
|
|
||||||
|
Please refer to the official documentation: [Deploy AstrBot with Windows One-Click Installer](https://astrbot.app/deploy/astrbot/windows.html).
|
||||||
|
|
||||||
#### CasaOS Deployment
|
#### CasaOS Deployment
|
||||||
|
|
||||||
Community-contributed method.
|
Community-contributed deployment method.
|
||||||
See docs: [CasaOS Deployment](https://astrbot.app/deploy/astrbot/casaos.html)
|
|
||||||
|
Please refer to the official documentation: [CasaOS Deployment](https://astrbot.app/deploy/astrbot/casaos.html).
|
||||||
|
|
||||||
#### Manual Deployment
|
#### Manual Deployment
|
||||||
|
|
||||||
See docs: [Source Code Deployment](https://astrbot.app/deploy/astrbot/cli.html)
|
First, install uv:
|
||||||
|
|
||||||
## ⚡ Platform Support
|
```bash
|
||||||
|
pip install uv
|
||||||
|
```
|
||||||
|
|
||||||
| Platform | Status | Details | Message Types |
|
Install AstrBot via Git Clone:
|
||||||
| -------------------------------------------------------------- | ------ | ------------------- | ------------------- |
|
|
||||||
| 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/AstrBotDevs/AstrBot_plugin_telegram) | ✔ | Private/Group chats | Text, Images |
|
|
||||||
| [WeChat Work](https://github.com/AstrBotDevs/AstrBot_plugin_wecom) | ✔ | Private chats | Text, Images, Voice |
|
|
||||||
| Feishu | ✔ | Group chats | Text, Images |
|
|
||||||
| WeChat Open Platform | 🚧 | Planned | - |
|
|
||||||
| Discord | 🚧 | Planned | - |
|
|
||||||
| WhatsApp | 🚧 | Planned | - |
|
|
||||||
| Xiaomi Speakers | 🚧 | Planned | - |
|
|
||||||
|
|
||||||
## Provider Support Status
|
```bash
|
||||||
|
git clone https://github.com/AstrBotDevs/AstrBot && cd AstrBot
|
||||||
|
uv run main.py
|
||||||
|
```
|
||||||
|
|
||||||
| Name | Support | Type | Notes |
|
Or refer to the official documentation: [Deploy AstrBot from Source](https://astrbot.app/deploy/astrbot/cli.html).
|
||||||
|---------------------------|---------|------------------------|-----------------------------------------------------------------------|
|
|
||||||
| OpenAI API | ✔ | Text Generation | Supports all OpenAI API-compatible services including DeepSeek, Google Gemini, GLM, Moonshot, Alibaba Cloud Bailian, Silicon Flow, xAI, etc. |
|
|
||||||
| Claude API | ✔ | Text Generation | |
|
|
||||||
| Google Gemini API | ✔ | Text Generation | |
|
|
||||||
| Dify | ✔ | LLMOps | |
|
|
||||||
| DashScope (Alibaba Cloud) | ✔ | LLMOps | |
|
|
||||||
| Ollama | ✔ | Model Loader | Local deployment for open-source LLMs (DeepSeek, Llama, etc.) |
|
|
||||||
| LM Studio | ✔ | Model Loader | Local deployment for open-source LLMs (DeepSeek, Llama, etc.) |
|
|
||||||
| LLMTuner | ✔ | Model Loader | Local loading of fine-tuned models (e.g. LoRA) |
|
|
||||||
| OneAPI | ✔ | LLM Distribution | |
|
|
||||||
| Whisper | ✔ | Speech-to-Text | Supports API and local deployment |
|
|
||||||
| SenseVoice | ✔ | Speech-to-Text | Local deployment |
|
|
||||||
| OpenAI TTS API | ✔ | Text-to-Speech | |
|
|
||||||
| Fishaudio | ✔ | Text-to-Speech | Project involving GPT-Sovits author |
|
|
||||||
|
|
||||||
# 🦌 Roadmap
|
## 🌍 Community
|
||||||
|
|
||||||
> [!TIP]
|
### QQ Groups
|
||||||
> Suggestions welcome via Issues <3
|
|
||||||
|
|
||||||
- [ ] Ensure feature parity across all platform adapters
|
- Group 1: 322154837
|
||||||
- [ ] Optimize plugin APIs
|
- Group 3: 630166526
|
||||||
- [ ] Add default TTS services (e.g., GPT-Sovits)
|
- Group 5: 822130018
|
||||||
- [ ] Enhance chat features with persistent memory
|
- Group 6: 753075035
|
||||||
- [ ] i18n Planning
|
- Developer Group: 975206796
|
||||||
|
|
||||||
## ❤️ Contributions
|
### Telegram Group
|
||||||
|
|
||||||
All Issues/PRs welcome! Simply submit your changes to this project :)
|
<a href="https://t.me/+hAsD2Ebl5as3NmY1"><img alt="Telegram_community" src="https://img.shields.io/badge/Telegram-AstrBot-purple?style=for-the-badge&color=76bad9"></a>
|
||||||
|
|
||||||
For major features, please discuss via Issues first.
|
### Discord Server
|
||||||
|
|
||||||
## 🌟 Support
|
<a href="https://discord.gg/hAVk6tgV36"><img alt="Discord_community" src="https://img.shields.io/badge/Discord-AstrBot-purple?style=for-the-badge&color=76bad9"></a>
|
||||||
|
|
||||||
- Star this project!
|
## Supported Messaging Platforms
|
||||||
- Support via [Afdian](https://afdian.com/a/soulter)
|
|
||||||
- WeChat support: [QR Code](https://drive.soulter.top/f/pYfA/d903f4fa49a496fda3f16d2be9e023b5.png)
|
|
||||||
|
|
||||||
## ✨ Demos
|
**Officially Maintained**
|
||||||
|
|
||||||
> [!NOTE]
|
- QQ (Official Platform & OneBot)
|
||||||
> Code executor file I/O currently tested with Napcat(QQ)/Lagrange(QQ)
|
- Telegram
|
||||||
|
- WeChat Work Application & WeChat Work Intelligent Bot
|
||||||
|
- WeChat Customer Service & WeChat Official Accounts
|
||||||
|
- Feishu (Lark)
|
||||||
|
- DingTalk
|
||||||
|
- Slack
|
||||||
|
- Discord
|
||||||
|
- Satori
|
||||||
|
- Misskey
|
||||||
|
- WhatsApp (Coming Soon)
|
||||||
|
- LINE (Coming Soon)
|
||||||
|
|
||||||
<div align='center'>
|
**Community Maintained**
|
||||||
|
|
||||||
<img src="https://github.com/user-attachments/assets/4ee688d9-467d-45c8-99d6-368f9a8a92d8" width="600">
|
- [KOOK](https://github.com/wuyan1003/astrbot_plugin_kook_adapter)
|
||||||
|
- [VoceChat](https://github.com/HikariFroya/astrbot_plugin_vocechat)
|
||||||
|
- [Bilibili Direct Messages](https://github.com/Hina-Chat/astrbot_plugin_bilibili_adapter)
|
||||||
|
- [wxauto](https://github.com/luosheng520qaq/wxauto-repost-onebotv11)
|
||||||
|
|
||||||
_✨ Docker-based Sandboxed Code Executor (Beta) ✨_
|
## Supported Model Services
|
||||||
|
|
||||||
<img src="https://github.com/user-attachments/assets/0378f407-6079-4f64-ae4c-e97ab20611d2" height=500>
|
**LLM Services**
|
||||||
|
|
||||||
_✨ Multimodal Input, Web Search, Text-to-Image ✨_
|
- OpenAI and Compatible Services
|
||||||
|
- Anthropic
|
||||||
|
- Google Gemini
|
||||||
|
- Moonshot AI
|
||||||
|
- Zhipu AI
|
||||||
|
- DeepSeek
|
||||||
|
- Ollama (Self-hosted)
|
||||||
|
- LM Studio (Self-hosted)
|
||||||
|
- [CompShare](https://www.compshare.cn/?ytag=GPU_YY-gh_astrbot&referral_code=FV7DcGowN4hB5UuXKgpE74)
|
||||||
|
- [302.AI](https://share.302.ai/rr1M3l)
|
||||||
|
- [TokenPony](https://www.tokenpony.cn/3YPyf)
|
||||||
|
- [SiliconFlow](https://docs.siliconflow.cn/cn/usecases/use-siliconcloud-in-astrbot)
|
||||||
|
- [PPIO Cloud](https://ppio.com/user/register?invited_by=AIOONE)
|
||||||
|
- ModelScope
|
||||||
|
- OneAPI
|
||||||
|
|
||||||
<img src="https://github.com/user-attachments/assets/8ec12797-e70f-460a-959e-48eca39ca2bb" height=100>
|
**LLMOps Platforms**
|
||||||
|
|
||||||
_✨ Natural Language TODO Lists ✨_
|
- Dify
|
||||||
|
- Alibaba Cloud Bailian Applications
|
||||||
|
- Coze
|
||||||
|
|
||||||
<img src="https://github.com/user-attachments/assets/e137a9e1-340a-4bf2-bb2b-771132780735" height=150>
|
**Speech-to-Text Services**
|
||||||
<img src="https://github.com/user-attachments/assets/480f5e82-cf6a-4955-a869-0d73137aa6e1" height=150>
|
|
||||||
|
|
||||||
_✨ Plugin System Showcase ✨_
|
- OpenAI Whisper
|
||||||
|
- SenseVoice
|
||||||
|
|
||||||
<img src="https://github.com/user-attachments/assets/592a8630-14c7-4e06-b496-9c0386e4f36c" width=600>
|
**Text-to-Speech Services**
|
||||||
|
|
||||||
_✨ Web Dashboard ✨_
|
- OpenAI TTS
|
||||||
|
- Gemini TTS
|
||||||
|
- GPT-Sovits-Inference
|
||||||
|
- GPT-Sovits
|
||||||
|
- FishAudio
|
||||||
|
- Edge TTS
|
||||||
|
- Alibaba Cloud Bailian TTS
|
||||||
|
- Azure TTS
|
||||||
|
- Minimax TTS
|
||||||
|
- Volcano Engine TTS
|
||||||
|
|
||||||
|
## ❤️ Contributing
|
||||||
|
|
||||||
_✨ Built-in Web Chat Interface ✨_
|
Issues and Pull Requests are always welcome! Feel free to submit your changes to this project :)
|
||||||
|
|
||||||
</div>
|
### How to Contribute
|
||||||
|
|
||||||
|
You can contribute by reviewing issues or helping with pull request reviews. Any issues or PRs are welcome to encourage community participation. Of course, these are just suggestions—you can contribute in any way you like. For adding new features, please discuss through an Issue first.
|
||||||
|
|
||||||
|
### Development Environment
|
||||||
|
|
||||||
|
AstrBot uses `ruff` for code formatting and linting.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/AstrBotDevs/AstrBot
|
||||||
|
pip install pre-commit
|
||||||
|
pre-commit install
|
||||||
|
```
|
||||||
|
|
||||||
|
## ❤️ Special Thanks
|
||||||
|
|
||||||
|
Special thanks to all Contributors and plugin developers for their contributions to AstrBot ❤️
|
||||||
|
|
||||||
|
<a href="https://github.com/AstrBotDevs/AstrBot/graphs/contributors">
|
||||||
|
<img src="https://contrib.rocks/image?repo=AstrBotDevs/AstrBot" />
|
||||||
|
</a>
|
||||||
|
|
||||||
|
Additionally, the birth of this project would not have been possible without the help of the following open-source projects:
|
||||||
|
|
||||||
|
- [NapNeko/NapCatQQ](https://github.com/NapNeko/NapCatQQ) - The amazing cat framework
|
||||||
|
|
||||||
## ⭐ Star History
|
## ⭐ Star History
|
||||||
|
|
||||||
> [!TIP]
|
> [!TIP]
|
||||||
> If this project helps you, please give it a star <3
|
> If this project has helped you in your life or work, or if you're interested in its future development, please give the project a Star. It's the driving force behind maintaining this open-source project <3
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
|
|
||||||
[](https://star-history.com/#AstrBotDevs/AstrBot&Date)
|
[](https://star-history.com/#astrbotdevs/astrbot&Date)
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## Disclaimer
|
</details>
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
<!-- ## ✨ ATRI [Beta]
|
|
||||||
|
|
||||||
Available as plugin: [astrbot_plugin_atri](https://github.com/AstrBotDevs/AstrBot_plugin_atri)
|
|
||||||
|
|
||||||
1. Qwen1.5-7B-Chat Lora model fine-tuned with ATRI character data
|
|
||||||
2. Long-term memory
|
|
||||||
3. Meme understanding & responses
|
|
||||||
4. TTS integration
|
|
||||||
-->
|
|
||||||
|
|
||||||
|
|
||||||
_私は、高性能ですから!_
|
_私は、高性能ですから!_
|
||||||
|
|
||||||
|
|||||||
270
README_ja.md
270
README_ja.md
@@ -1,167 +1,233 @@
|
|||||||
<p align="center">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
|
|
||||||
_✨ 簡単に使えるマルチプラットフォーム LLM チャットボットおよび開発フレームワーク ✨_
|
<br>
|
||||||
|
|
||||||
|
<div>
|
||||||
<a href="https://trendshift.io/repositories/12875" target="_blank"><img src="https://trendshift.io/api/badge/repositories/12875" alt="Soulter%2FAstrBot | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
|
<a href="https://trendshift.io/repositories/12875" target="_blank"><img src="https://trendshift.io/api/badge/repositories/12875" alt="Soulter%2FAstrBot | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
|
||||||
|
<a href="https://hellogithub.com/repository/AstrBotDevs/AstrBot" target="_blank"><img src="https://api.hellogithub.com/v1/widgets/recommend.svg?rid=d127d50cd5e54c5382328acc3bb25483&claim_uid=ZO9by7qCXgSd6Lp&t=2" alt="Featured｜HelloGitHub" style="width: 250px; height: 54px;" width="250" height="54" /></a>
|
||||||
[](https://github.com/AstrBotDevs/AstrBot/releases/latest)
|
|
||||||
<img src="https://img.shields.io/badge/python-3.10+-blue.svg" alt="python">
|
|
||||||
<a href="https://hub.docker.com/r/soulter/astrbot"><img alt="Docker pull" src="https://img.shields.io/docker/pulls/soulter/astrbot.svg"/></a>
|
|
||||||
<img alt="Static Badge" src="https://img.shields.io/badge/QQ群-630166526-purple">
|
|
||||||
[](https://wakatime.com/badge/user/915e5316-99c6-4563-a483-ef186cf000c9/project/018e705a-a1a7-409a-a849-3013485e6c8e)
|
|
||||||
|
|
||||||
[](https://codecov.io/gh/AstrBotDevs/AstrBot)
|
|
||||||
|
|
||||||
<a href="https://astrbot.app/">ドキュメントを見る</a> ｜
|
|
||||||
<a href="https://github.com/AstrBotDevs/AstrBot/issues">問題を報告する</a>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
AstrBot は、疎結合、非同期、複数のメッセージプラットフォームに対応したデプロイ、使いやすいプラグインシステム、および包括的な大規模言語モデル（LLM）接続機能を備えたチャットボットおよび開発フレームワークです。
|
<br>
|
||||||
|
|
||||||
## ✨ 主な機能
|
<div>
|
||||||
|
<img src="https://img.shields.io/github/v/release/AstrBotDevs/AstrBot?style=for-the-badge&color=76bad9" href="https://github.com/AstrBotDevs/AstrBot/releases/latest">
|
||||||
|
<img src="https://img.shields.io/badge/python-3.10+-blue.svg?style=for-the-badge&color=76bad9" alt="python">
|
||||||
|
<a href="https://hub.docker.com/r/soulter/astrbot"><img alt="Docker pull" src="https://img.shields.io/docker/pulls/soulter/astrbot.svg?style=for-the-badge&color=76bad9"/></a>
|
||||||
|
<a href="https://qm.qq.com/cgi-bin/qm/qr?k=wtbaNx7EioxeaqS9z7RQWVXPIxg2zYr7&jump_from=webapi&authKey=vlqnv/AV2DbJEvGIcxdlNSpfxVy+8vVqijgreRdnVKOaydpc+YSw4MctmEbr0k5"><img alt="QQ_community" src="https://img.shields.io/badge/QQ群-775869627-purple?style=for-the-badge&color=76bad9"></a>
|
||||||
|
<a href="https://t.me/+hAsD2Ebl5as3NmY1"><img alt="Telegram_community" src="https://img.shields.io/badge/Telegram-AstrBot-purple?style=for-the-badge&color=76bad9"></a>
|
||||||
|
<img src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.soulter.top%2Fastrbot%2Fplugin-num&query=%24.result&suffix=%E4%B8%AA&style=for-the-badge&label=%E6%8F%92%E4%BB%B6%E5%B8%82%E5%9C%BA&cacheSeconds=3600">
|
||||||
|
</div>
|
||||||
|
|
||||||
1. **大規模言語モデルの対話**。OpenAI API、Google Gemini、Llama、Deepseek、ChatGLM など、さまざまな大規模言語モデルをサポートし、Ollama、LLMTuner を介してローカルにデプロイされた大規模モデルをサポートします。多輪対話、人格シナリオ、多モーダル機能を備え、画像理解、音声からテキストへの変換（Whisper）をサポートします。
|
<br>
|
||||||
2. **複数のメッセージプラットフォームの接続**。QQ（OneBot）、QQ チャンネル、Feishu、Telegram への接続をサポートします。今後、DingTalk、Discord、WhatsApp、Xiaoai 音響をサポートする予定です。レート制限、ホワイトリスト、キーワードフィルタリング、Baidu コンテンツ監査をサポートします。
|
|
||||||
3. **エージェント**。一部のエージェント機能をネイティブにサポートし、コードエグゼキューター、自然言語タスク、ウェブ検索などを提供します。[Dify プラットフォーム](https://dify.ai/)と連携し、Dify スマートアシスタント、ナレッジベース、Dify ワークフローを簡単に接続できます。
|
|
||||||
4. **プラグインの拡張**。深く最適化されたプラグインメカニズムを備え、[プラグインの開発](https://astrbot.app/dev/plugin.html)をサポートし、機能を拡張できます。複数のプラグインのインストールをサポートします。
|
|
||||||
5. **ビジュアル管理パネル**。設定の視覚的な変更、プラグイン管理、ログの表示などをサポートし、設定の難易度を低減します。WebChat を統合し、パネル上で大規模モデルと対話できます。
|
|
||||||
6. **高い安定性と高いモジュール性**。イベントバスとパイプラインに基づくアーキテクチャ設計により、高度にモジュール化され、低結合です。
|
|
||||||
|
|
||||||
> [!TIP]
|
<a href="https://github.com/AstrBotDevs/AstrBot/blob/master/README.md">中文</a> ｜
|
||||||
> 管理パネルのオンラインデモを体験する: [https://demo.astrbot.app/](https://demo.astrbot.app/)
|
<a href="https://github.com/AstrBotDevs/AstrBot/blob/master/README_en.md">English</a> ｜
|
||||||
>
|
<a href="https://astrbot.app/">ドキュメント</a> ｜
|
||||||
> ユーザー名: `astrbot`, パスワード: `astrbot`。LLM が設定されていないため、チャットページで大規模モデルを使用することはできません。（デモのログインパスワードを変更しないでください 😭）
|
<a href="https://blog.astrbot.app/">Blog</a> ｜
|
||||||
|
<a href="https://astrbot.featurebase.app/roadmap">ロードマップ</a> ｜
|
||||||
|
<a href="https://github.com/AstrBotDevs/AstrBot/issues">Issue</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
## ✨ 使用方法
|
AstrBot は、オープンソースのオールインワン Agent チャットボットプラットフォーム及び開発フレームワークです。
|
||||||
|
|
||||||
#### Docker デプロイ
|
## 主な機能
|
||||||
|
|
||||||
公式ドキュメント [Docker を使用して AstrBot をデプロイする](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot) を参照してください。
|
1. **大規模言語モデル対話**。多様な大規模言語モデルサービスとの統合をサポート。マルチモーダル、ツール呼び出し、MCP、ネイティブナレッジベース、キャラクター設定などの機能を搭載。
|
||||||
|
2. **マルチメッセージプラットフォームサポート**。QQ、WeChat Work、WeChat公式アカウント、Feishu、Telegram、DingTalk、Discord、KOOK などのプラットフォームと統合可能。レート制限、ホワイトリスト、Baidu コンテンツ審査をサポート。
|
||||||
|
3. **Agent**。完全に最適化された Agentic 機能。マルチターンツール呼び出し、内蔵サンドボックスコード実行環境、Web 検索などの機能をサポート。
|
||||||
|
4. **プラグイン拡張**。深く最適化されたプラグインメカニズムで、[プラグイン開発](https://astrbot.app/dev/plugin.html)による機能拡張をサポート。豊富なコミュニティプラグインエコシステム。
|
||||||
|
5. **WebUI**。ビジュアル設定とボット管理、充実した機能。
|
||||||
|
|
||||||
#### Windows ワンクリックインストーラーのデプロイ
|
## デプロイ方法
|
||||||
|
|
||||||
コンピュータに Python（>3.10）がインストールされている必要があります。公式ドキュメント [Windows ワンクリックインストーラーを使用して AstrBot をデプロイする](https://astrbot.app/deploy/astrbot/windows.html) を参照してください。
|
#### Docker デプロイ（推奨 🥳）
|
||||||
|
|
||||||
#### Replit デプロイ
|
Docker / Docker Compose を使用した AstrBot のデプロイを推奨します。
|
||||||
|
|
||||||
|
公式ドキュメント [Docker を使用した AstrBot のデプロイ](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot) をご参照ください。
|
||||||
|
|
||||||
|
#### 宝塔パネルデプロイ
|
||||||
|
|
||||||
|
AstrBot は宝塔パネルと提携し、宝塔パネルに公開されています。
|
||||||
|
|
||||||
|
公式ドキュメント [宝塔パネルデプロイ](https://astrbot.app/deploy/astrbot/btpanel.html) をご参照ください。
|
||||||
|
|
||||||
|
#### 1Panel デプロイ
|
||||||
|
|
||||||
|
AstrBot は 1Panel 公式により 1Panel パネルに公開されています。
|
||||||
|
|
||||||
|
公式ドキュメント [1Panel デプロイ](https://astrbot.app/deploy/astrbot/1panel.html) をご参照ください。
|
||||||
|
|
||||||
|
#### 雨云でのデプロイ
|
||||||
|
|
||||||
|
AstrBot は雨云公式によりクラウドアプリケーションプラットフォームに公開され、ワンクリックでデプロイ可能です。
|
||||||
|
|
||||||
|
[](https://app.rainyun.com/apps/rca/store/5994?ref=NjU1ODg0)
|
||||||
|
|
||||||
|
#### Replit でのデプロイ
|
||||||
|
|
||||||
|
コミュニティ貢献によるデプロイ方法。
|
||||||
|
|
||||||
[](https://repl.it/github/AstrBotDevs/AstrBot)
|
[](https://repl.it/github/AstrBotDevs/AstrBot)
|
||||||
|
|
||||||
|
#### Windows ワンクリックインストーラーデプロイ
|
||||||
|
|
||||||
|
公式ドキュメント [Windows ワンクリックインストーラーを使用した AstrBot のデプロイ](https://astrbot.app/deploy/astrbot/windows.html) をご参照ください。
|
||||||
|
|
||||||
#### CasaOS デプロイ
|
#### CasaOS デプロイ
|
||||||
|
|
||||||
コミュニティが提供するデプロイ方法です。
|
コミュニティ貢献によるデプロイ方法。
|
||||||
|
|
||||||
公式ドキュメント [ソースコードを使用して AstrBot をデプロイする](https://astrbot.app/deploy/astrbot/casaos.html) を参照してください。
|
公式ドキュメント [CasaOS デプロイ](https://astrbot.app/deploy/astrbot/casaos.html) をご参照ください。
|
||||||
|
|
||||||
#### 手動デプロイ
|
#### 手動デプロイ
|
||||||
|
|
||||||
公式ドキュメント [ソースコードを使用して AstrBot をデプロイする](https://astrbot.app/deploy/astrbot/cli.html) を参照してください。
|
まず uv をインストールします:
|
||||||
|
|
||||||
## ⚡ メッセージプラットフォームのサポート状況
|
```bash
|
||||||
|
pip install uv
|
||||||
|
```
|
||||||
|
|
||||||
| プラットフォーム | サポート状況 | 詳細 | メッセージタイプ |
|
Git Clone で AstrBot をインストール:
|
||||||
| -------- | ------- | ------- | ------ |
|
|
||||||
| QQ(公式ロボットインターフェース) | ✔ | プライベートチャット、グループチャット、QQ チャンネルプライベートチャット、グループチャット | テキスト、画像 |
|
|
||||||
| QQ(OneBot) | ✔ | プライベートチャット、グループチャット | テキスト、画像、音声 |
|
|
||||||
| WeChat(個人アカウント) | ✔ | WeChat 個人アカウントのプライベートチャット、グループチャット | テキスト、画像、音声 |
|
|
||||||
| [Telegram](https://github.com/Soulter/astrbot_plugin_telegram) | ✔ | プライベートチャット、グループチャット | テキスト、画像 |
|
|
||||||
| [WeChat(企業 WeChat)](https://github.com/Soulter/astrbot_plugin_wecom) | ✔ | プライベートチャット | テキスト、画像、音声 |
|
|
||||||
| Feishu | ✔ | グループチャット | テキスト、画像 |
|
|
||||||
| WeChat 対話オープンプラットフォーム | 🚧 | 計画中 | - |
|
|
||||||
| Discord | 🚧 | 計画中 | - |
|
|
||||||
| WhatsApp | 🚧 | 計画中 | - |
|
|
||||||
| Xiaoai 音響 | 🚧 | 計画中 | - |
|
|
||||||
|
|
||||||
# 🦌 今後のロードマップ
|
```bash
|
||||||
|
git clone https://github.com/AstrBotDevs/AstrBot && cd AstrBot
|
||||||
|
uv run main.py
|
||||||
|
```
|
||||||
|
|
||||||
> [!TIP]
|
または、公式ドキュメント [ソースコードから AstrBot をデプロイ](https://astrbot.app/deploy/astrbot/cli.html) をご参照ください。
|
||||||
> Issue でさらに多くの提案を歓迎します <3
|
|
||||||
|
|
||||||
- [ ] 現在のすべてのプラットフォームアダプターの機能の一貫性を確保し、改善する
|
## 🌍 コミュニティ
|
||||||
- [ ] プラグインインターフェースの最適化
|
|
||||||
- [ ] GPT-Sovits などの TTS サービスをデフォルトでサポート
|
|
||||||
- [ ] "チャット強化" 部分を完成させ、永続的な記憶をサポート
|
|
||||||
- [ ] i18n の計画
|
|
||||||
|
|
||||||
## ❤️ 貢献
|
### QQ グループ
|
||||||
|
|
||||||
Issue や Pull Request を歓迎します！このプロジェクトに変更を加えるだけです :)
|
- 1群:322154837
|
||||||
|
- 3群:630166526
|
||||||
|
- 5群:822130018
|
||||||
|
- 6群:753075035
|
||||||
|
- 開発者群:975206796
|
||||||
|
|
||||||
新機能の追加については、まず Issue で議論してください。
|
### Telegram グループ
|
||||||
|
|
||||||
## 🌟 サポート
|
<a href="https://t.me/+hAsD2Ebl5as3NmY1"><img alt="Telegram_community" src="https://img.shields.io/badge/Telegram-AstrBot-purple?style=for-the-badge&color=76bad9"></a>
|
||||||
|
|
||||||
- このプロジェクトに Star を付けてください！
|
### Discord サーバー
|
||||||
- [愛発電](https://afdian.com/a/soulter)で私をサポートしてください！
|
|
||||||
- [WeChat](https://drive.soulter.top/f/pYfA/d903f4fa49a496fda3f16d2be9e023b5.png)で私をサポートしてください~
|
|
||||||
|
|
||||||
## ✨ デモ
|
<a href="https://discord.gg/hAVk6tgV36"><img alt="Discord_community" src="https://img.shields.io/badge/Discord-AstrBot-purple?style=for-the-badge&color=76bad9"></a>
|
||||||
|
|
||||||
> [!NOTE]
|
## サポートされているメッセージプラットフォーム
|
||||||
> コードエグゼキューターのファイル入力/出力は現在 Napcat(QQ)、Lagrange(QQ) でのみテストされています
|
|
||||||
|
|
||||||
<div align='center'>
|
**公式メンテナンス**
|
||||||
|
|
||||||
<img src="https://github.com/user-attachments/assets/4ee688d9-467d-45c8-99d6-368f9a8a92d8" width="600">
|
- QQ (公式プラットフォーム & OneBot)
|
||||||
|
- Telegram
|
||||||
|
- WeChat Work アプリケーション & WeChat Work インテリジェントボット
|
||||||
|
- WeChat カスタマーサービス & WeChat 公式アカウント
|
||||||
|
- Feishu (Lark)
|
||||||
|
- DingTalk
|
||||||
|
- Slack
|
||||||
|
- Discord
|
||||||
|
- Satori
|
||||||
|
- Misskey
|
||||||
|
- WhatsApp (近日対応予定)
|
||||||
|
- LINE (近日対応予定)
|
||||||
|
|
||||||
_✨ Docker ベースのサンドボックス化されたコードエグゼキューター（ベータテスト中）✨_
|
**コミュニティメンテナンス**
|
||||||
|
|
||||||
<img src="https://github.com/user-attachments/assets/0378f407-6079-4f64-ae4c-e97ab20611d2" height=500>
|
- [KOOK](https://github.com/wuyan1003/astrbot_plugin_kook_adapter)
|
||||||
|
- [VoceChat](https://github.com/HikariFroya/astrbot_plugin_vocechat)
|
||||||
|
- [Bilibili ダイレクトメッセージ](https://github.com/Hina-Chat/astrbot_plugin_bilibili_adapter)
|
||||||
|
- [wxauto](https://github.com/luosheng520qaq/wxauto-repost-onebotv11)
|
||||||
|
|
||||||
_✨ 多モーダル、ウェブ検索、長文の画像変換（設定可能）✨_
|
## サポートされているモデルサービス
|
||||||
|
|
||||||
<img src="https://github.com/user-attachments/assets/8ec12797-e70f-460a-959e-48eca39ca2bb" height=100>
|
**大規模言語モデルサービス**
|
||||||
|
|
||||||
_✨ 自然言語タスク ✨_
|
- OpenAI および互換サービス
|
||||||
|
- Anthropic
|
||||||
|
- Google Gemini
|
||||||
|
- Moonshot AI
|
||||||
|
- 智谱 AI
|
||||||
|
- DeepSeek
|
||||||
|
- Ollama (セルフホスト)
|
||||||
|
- LM Studio (セルフホスト)
|
||||||
|
- [優云智算](https://www.compshare.cn/?ytag=GPU_YY-gh_astrbot&referral_code=FV7DcGowN4hB5UuXKgpE74)
|
||||||
|
- [302.AI](https://share.302.ai/rr1M3l)
|
||||||
|
- [小馬算力](https://www.tokenpony.cn/3YPyf)
|
||||||
|
- [硅基流動](https://docs.siliconflow.cn/cn/usercases/use-siliconcloud-in-astrbot)
|
||||||
|
- [PPIO 派欧云](https://ppio.com/user/register?invited_by=AIOONE)
|
||||||
|
- ModelScope
|
||||||
|
- OneAPI
|
||||||
|
|
||||||
<img src="https://github.com/user-attachments/assets/e137a9e1-340a-4bf2-bb2b-771132780735" height=150>
|
**LLMOps プラットフォーム**
|
||||||
<img src="https://github.com/user-attachments/assets/480f5e82-cf6a-4955-a869-0d73137aa6e1" height=150>
|
|
||||||
|
|
||||||
_✨ プラグインシステム - 一部のプラグインの展示 ✨_
|
- Dify
|
||||||
|
- Alibaba Cloud 百炼アプリケーション
|
||||||
|
- Coze
|
||||||
|
|
||||||
<img src="https://github.com/user-attachments/assets/592a8630-14c7-4e06-b496-9c0386e4f36c" width="600">
|
**音声認識サービス**
|
||||||
|
|
||||||
_✨ 管理パネル ✨_
|
- OpenAI Whisper
|
||||||
|
- SenseVoice
|
||||||
|
|
||||||
|
**音声合成サービス**
|
||||||
|
|
||||||
_✨ 内蔵 Web Chat、オンラインでボットと対話 ✨_
|
- OpenAI TTS
|
||||||
|
- Gemini TTS
|
||||||
|
- GPT-Sovits-Inference
|
||||||
|
- GPT-Sovits
|
||||||
|
- FishAudio
|
||||||
|
- Edge TTS
|
||||||
|
- Alibaba Cloud 百炼 TTS
|
||||||
|
- Azure TTS
|
||||||
|
- Minimax TTS
|
||||||
|
- Volcano Engine TTS
|
||||||
|
|
||||||
</div>
|
## ❤️ コントリビューション
|
||||||
|
|
||||||
|
Issue や Pull Request は大歓迎です!このプロジェクトに変更を送信してください :)
|
||||||
|
|
||||||
|
### コントリビュート方法
|
||||||
|
|
||||||
|
Issue を確認したり、PR(プルリクエスト)のレビューを手伝うことで貢献できます。どんな Issue や PR への参加も歓迎され、コミュニティ貢献を促進します。もちろん、これらは提案に過ぎず、どんな方法でも貢献できます。新機能の追加については、まず Issue で議論してください。
|
||||||
|
|
||||||
|
### 開発環境
|
||||||
|
|
||||||
|
AstrBot はコードのフォーマットとチェックに `ruff` を使用しています。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/AstrBotDevs/AstrBot
|
||||||
|
pip install pre-commit
|
||||||
|
pre-commit install
|
||||||
|
```
|
||||||
|
|
||||||
|
## ❤️ Special Thanks
|
||||||
|
|
||||||
|
AstrBot への貢献をしていただいたすべてのコントリビューターとプラグイン開発者に特別な感謝を ❤️
|
||||||
|
|
||||||
|
<a href="https://github.com/AstrBotDevs/AstrBot/graphs/contributors">
|
||||||
|
<img src="https://contrib.rocks/image?repo=AstrBotDevs/AstrBot" />
|
||||||
|
</a>
|
||||||
|
|
||||||
|
また、このプロジェクトの誕生は以下のオープンソースプロジェクトの助けなしには実現できませんでした:
|
||||||
|
|
||||||
|
- [NapNeko/NapCatQQ](https://github.com/NapNeko/NapCatQQ) - 素晴らしい猫猫フレームワーク
|
||||||
|
|
||||||
## ⭐ Star History
|
## ⭐ Star History
|
||||||
|
|
||||||
> [!TIP]
|
> [!TIP]
|
||||||
> このプロジェクトがあなたの生活や仕事に役立った場合、またはこのプロジェクトの将来の発展に関心がある場合は、プロジェクトに Star を付けてください。これはこのオープンソースプロジェクトを維持するためのモチベーションです <3
|
> このプロジェクトがあなたの生活や仕事に役立ったり、このプロジェクトの今後の発展に関心がある場合は、プロジェクトに Star をください。これがこのオープンソースプロジェクトを維持する原動力です <3
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
|
|
||||||
[](https://star-history.com/#soulter/astrbot&Date)
|
[](https://star-history.com/#astrbotdevs/astrbot&Date)
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## スポンサー
|
</details>
|
||||||
|
|
||||||
[<img src="https://api.gitsponsors.com/api/badge/img?id=575865240" height="20">](https://api.gitsponsors.com/api/badge/link?p=XEpbdGxlitw/RbcwiTX93UMzNK/jgDYC8NiSzamIPMoKvG2lBFmyXhSS/b0hFoWlBBMX2L5X5CxTDsUdyvcIEHTOfnkXz47UNOZvMwyt5CzbYpq0SEzsSV1OJF1cCo90qC/ZyYKYOWedal3MhZ3ikw==)
|
|
||||||
|
|
||||||
## 免責事項
|
|
||||||
|
|
||||||
1. このプロジェクトは `AGPL-v3` オープンソースライセンスの下で保護されています。
|
|
||||||
2. このプロジェクトを使用する際は、現地の法律および規制を遵守してください。
|
|
||||||
|
|
||||||
<!-- ## ✨ ATRI [ベータテスト]
|
|
||||||
|
|
||||||
この機能はプラグインとしてロードされます。プラグインリポジトリのアドレス：[astrbot_plugin_atri](https://github.com/Soulter/astrbot_plugin_atri)
|
|
||||||
|
|
||||||
1. 《ATRI ~ My Dear Moments》の主人公 ATRI のキャラクターセリフを微調整データセットとして使用した `Qwen1.5-7B-Chat Lora` 微調整モデル。
|
|
||||||
2. 長期記憶
|
|
||||||
3. ミームの理解と返信
|
|
||||||
4. TTS
|
|
||||||
-->
|
|
||||||
|
|
||||||
_私は、高性能ですから!_
|
_私は、高性能ですから!_
|
||||||
|
|||||||
Reference in New Issue
Block a user