# Yunzai
**Repository Path**: adrae/Yunzai
## Basic Information
- **Project Name**: Yunzai
- **Description**: Yunzai 应用端，支持多账号，支持协议端：go-cqhttp、ComWeChat、GSUIDCore、ICQQ、QQBot、QQ频道、微信、KOOK、Telegram、Discord
- **Primary Language**: NodeJS
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: https://Yunzai.TRSS.me
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 136
- **Created**: 2024-03-16
- **Last Updated**: 2024-03-16
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# TRSS-Yunzai
Yunzai 应用端，支持多账号，支持协议端：OneBotv11、ComWeChat、GSUIDCore、ICQQ、QQBot、QQ频道、微信、KOOK、Telegram、Discord、OPQBot、Lagrange
[](https://github.com/TimeRainStarSky/Yunzai)
[](../../stargazers)
[](../../archive/main.tar.gz)
[](../../releases/latest)
[](https://github.com/TimeRainStarSky/Yunzai)
- 基于 [Miao-Yunzai](../../../../yoimiya-kokomi/Miao-Yunzai)
- 开发文档：[docs 分支](../../tree/docs)
## TRSS-Yunzai 后续计划
先刨坑，但也许会咕咕咕
- 完善现有协议端
- 支持更多协议端
项目仅供学习交流使用，严禁用于任何商业用途和非法行为
## 使用方法
### 建议使用 TRSS Script 一键安装管理
- [🌌 TRSS](https://TRSS.me)
- [🔼 Vercel](https://TRSS-Script.Vercel.app)
- [🐱 GitHub](https://TimeRainStarSky.GitHub.io/TRSS_Script)
- [🇬 Gitee](https://Gitee.com/TimeRainStarSky/TRSS_Script)
### 手动安装
> 环境准备： Windows or Linux，[Node.js(>=v18)](http://nodejs.cn/download)，[Redis](https://redis.io/docs/getting-started/installation)
1. Git Clone 项目
请根据网络情况选择使用 GitHub 或 Gitee 安装
```sh
git clone --depth 1 https://github.com/TimeRainStarSky/Yunzai
git clone --depth 1 https://gitee.com/TimeRainStarSky/Yunzai
cd Yunzai
```
2. 推荐安装插件(可选)
```sh
git clone --depth 1 https://github.com/TimeRainStarSky/Yunzai-genshin plugins/genshin
git clone --depth 1 https://github.com/yoimiya-kokomi/miao-plugin plugins/miao-plugin
git clone --depth 1 https://github.com/TimeRainStarSky/TRSS-Plugin plugins/TRSS-Plugin
```
```sh
git clone --depth 1 https://gitee.com/TimeRainStarSky/Yunzai-genshin plugins/genshin
git clone --depth 1 https://gitee.com/yoimiya-kokomi/miao-plugin plugins/miao-plugin
git clone --depth 1 https://Yunzai.TRSS.me plugins/TRSS-Plugin
```
3. 安装 [pnpm](https://pnpm.io/zh/installation) 和依赖
```sh
npm i -g pnpm
pnpm i
```
4. 前台运行
| 操作 | 命令 |
| ---- | ---- |
| 启动 | node . |
| 停止 | node . stop |
5. 启动协议端
WebSocket
OneBotv11
go-cqhttp
下载运行 [go-cqhttp](https://docs.go-cqhttp.org)，选择反向 WebSocket，修改 `config.yml`，以下为必改项：
```yaml
uin: 账号
password: '密码'
post-format: array
universal: ws://localhost:2536/OneBotv11
```
LLOneBot
下载安装 [LLOneBot](https://github.com/LLOneBot/LLOneBot)，启用反向 WebSocket，添加地址：
```
ws://localhost:2536/OneBotv11
```
Shamrock
下载安装 [Shamrock](https://whitechi73.github.io/OpenShamrock)，启用被动 WebSocket，添加地址：
```
ws://localhost:2536/OneBotv11
```
Lagrange
下载运行 [Lagrange.OneBot](https://lagrangedev.github.io/Lagrange.Doc/Lagrange.OneBot)，修改 `appsettings.json` 中 `Implementations`：
```json
{
"Type": "ReverseWebSocket",
"Host": "localhost",
"Port": 2536,
"Suffix": "/OneBotv11",
"ReconnectInterval": 5000,
"HeartBeatInterval": 5000,
"AccessToken": ""
}
```
ComWeChat
下载运行 [ComWeChat](https://justundertaker.github.io/ComWeChatBotClient)，修改 `.env`，以下为必改项：
```python
websocekt_type = "Backward"
websocket_url = ["ws://localhost:2536/ComWeChat"]
```
GSUIDCore
下载运行 [GenshinUID 插件](http://docs.gsuid.gbots.work/#/AdapterList)，GSUIDCore 连接地址 修改为：
```
ws://localhost:2536/GSUIDCore
```
OPQBot
下载运行 [OPQBot](https://opqbot.com)，启动参数添加：
```
-wsserver ws://localhost:2536/OPQBot
```
插件
- [ICQQ](../../../Yunzai-ICQQ-Plugin)
- [QQBot](../../../Yunzai-QQBot-Plugin)
- [WeChat](../../../Yunzai-WeChat-Plugin)
- [KOOK](../../../Yunzai-KOOK-Plugin)
- [Telegram](../../../Yunzai-Telegram-Plugin)
- [Discord](../../../Yunzai-Discord-Plugin)
- [Route](../../../Yunzai-Route-Plugin)
- [Lagrange](../../../Yunzai-Lagrange-Plugin)