https://github.com/itxtech/soyuz
The WebSocket API Server for Mirai Console
https://github.com/itxtech/soyuz
Last synced: 12 months ago
JSON representation
The WebSocket API Server for Mirai Console
- Host: GitHub
- URL: https://github.com/itxtech/soyuz
- Owner: iTXTech
- License: agpl-3.0
- Created: 2022-04-02T04:30:28.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-04-10T11:44:21.000Z (about 4 years ago)
- Last Synced: 2024-03-27T08:59:01.315Z (over 2 years ago)
- Language: Kotlin
- Size: 56.6 KB
- Stars: 12
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# iTXTech Soyuz - `Союз`
为 [Mirai Console](https://github.com/mamoe/mirai) 提供可扩展、轻量级的`Websocket API` 服务。
关于`开发`，`内置Handler`等，请 [查看文档](docs/README.md)。
## 特性
可扩展的架构，任何插件都可以在 `iTXTech Soyuz` 中注册 `Handler` 实现功能。
可通过 `Websocket` 客户端：
* 接入 `Mirai Console Terminal` 实时查看终端输出
* 接入 `Mirai Console` 执行命令，监控运行状态
* 接入 `Mirai Console Loader` 进行包管理 - 请安装 [MCL Addon](https://github.com/iTXTech/mcl-addon)
即将到来：
* 接入 `Mirai Web Panel` 使用 `WebUI` 管理 `Mirai Console`
## `/soyuz` 命令
```
/soyuz disconnect <连接ID> # 断开指定连接
/soyuz disconnectAll # 断开所有连接
/soyuz listConnections # 列出所有连接
/soyuz listHandlers # 列出所有Handler
/soyuz token [token] # 设置或重新生成 Access Token
```
## 安装
1. 使用MCL命令行
```
./mcl --update-package org.itxtech:soyuz
```
2. 从 [Release](https://github.com/iTXTech/soyuz/releases) 下载
## 开源许可证
iTXTech Soyuz
Copyright (C) 2022 iTX Technologies
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see .