yunzai-micro-plugin
Version:
Yunzai开发管理面板
169 lines (112 loc) • 6.57 kB
Markdown
# Micro-Plugin
<div align="center">
[](/LICENSE)
<br>
Yunzai-Bot开发管理系统
<br>
[English](EN_README.md) | 简体中文
</div>
## 快速开始
- [官方文档](https://v2233.github.io/zh/)
- [基本使用](docs/DOCS.md)
## WebUI模块
- 机器人列表信息
- 交互式数据大屏
- 日志查看
- 远程文件管理系统
- 支持多种语言高亮的代码编辑器
- 终端本地Shell会话和远程ssh连接
- 在线生成简易插件
- 支持编辑代码消息段，动态执行函数式插件
- 内置图片编辑器
- 基于Onebot11协议的仿真QQ客户端测试沙盒
- 在线管理Redis数据库
- 在线编辑机器人配置、插件配置、Onebot配置
- 提供后台多账号权限管理
- 面板提供贡献联系名单激励
## 环境准备
- Yunzai-next、Miao-Yunzai、Trss-Yunzai
- 如果你还没有安装此应用，请查看以下文档教程进行安装：<a href="https://yunzai-org.github.io/docs/">https://yunzai-org.github.io/docs/</a>
## 安装插件方式一(npm方式，yunzai-next支持)
- 下载依赖
```sh
yarn add yunzai-micro-plugin -W
```
- 如下示例写入配置文件
```ts
// yunzai.config.js
import { defineConfig } from 'yunzai'
import micro from 'yunzai-micro-plugin'
export default defineConfig({
// 应用
applications: [micro()],
})
```
## 安装插件方式二(git方式，通用)
- 下载源码
```sh
git clone --depth=1 https://github.com/V2233/micro-plugin.git ./plugins/micro-plugin
```
或者使用gitee镜像
```sh
git clone --depth=1 https://gitee.com/V2233/micro-plugin.git ./plugins/micro-plugin
```
- 安装依赖
```sh
pnpm i --filter ./plugins/micro-plugin
```
- 重启Yunzai
```sh
pnpm run restart
```
## 消息段
- 目前面板支持添加以下消息段，针对每种类型提供了便捷的添加方法：
| 消息段 | 支持情况 |
| ---------- | :------: |
| [文本] | 🟢 |
| [QQ 表情] | 🟢 |
| [图片] | 🟢 |
| [语音] | 🟢 |
| [视频] | 🟢 |
| [@某人] | 🟢 |
| [引用] | 🟢 |
| [戳一戳] | 🟢 |
| [骰子] | 🟢 |
| [猜拳] | 🟢 |
| [markdown] | 🔴 |
| [按钮] | 🔴 |
| [转发] | 🔴 |
- markdown和按钮模板已添加至web面板的开发板块，由于作者没有测试环境，如有报错请提issue或入群反馈。
## 指令
- ```小微帮助```
- ```小微设置面板Ip127.0.0.1```
- ```小微设置面板端口12345```
- ```小微（开启|重启|关闭）面板服务```注意关闭面板也会关闭反向ws连接
- ```小微指令列表```
- ```小微删除指令 + 序号```
## 后台使用方法
- 直接使用浏览器访问开机之后机器人向你发送的后台地址
> 注意：如果你使用的是云服务器，请使用公网地址进行访问，如果你使用的是内网服务器则可以使用内网地址进行访问
- 前往[Micro Panel下载地址](https://tianstudio.lanzoub.com/b004iib74j)下载Micro Panel的安卓APP（密码：micro）并填写服务器IP地址以及账号密码后进行访问
## 特性
- 小微插件允许你便捷地通过Web面板添加机器人的指令和预定义消息
- 插件特别对文本消息段和图片消息段进行了友好处理，即使没有写过代码，你也能快捷制作简易的插件
- 插件面板提供了可视化的图片编辑器，仅通过拖拉拽即可生成美观的图片，您可导出模板HTML或者直接添加到指令列表，后者将自动分配消息段的资源到Yunzai的data/micro-plugin/plugins目录，每个文件夹被视为一个插件包，包括HTML文件、图片、音频、视频、HTML工程文件等，当然面板提供的操作可以让你无视这个资源目录
- 您仍然可以使用模板字符串来插入符合JavaScript语法的变量或表达式，插件提供了消息事件的模板变量，只需要在文本处输入键盘符```/```即可唤出变量列表，这使得您可以制作动态的文本和图片
- 插件内置了简易的文件系统，但它能满足您基本的文件操作需求，包含上传、下载、新建、剪切、移动、复制、删除，您还可以通过点击文件名预览图片、音频、视频。当然，如果需要大批量上传文件，您需要使用其它专业的文件上传工具
- 您可以使用文件系统的代码编辑器来编辑您的项目文件，它附带了多个主题，并支持常见语言的高亮显示、语法检查、代码补全功能，支持的语言有```javascript```、```html```、```css```、```typescript```、```jsx```、```tsx```、```vue```、```json```、```yaml```、```java```、```golang```、```c/cpp```、```python```、```sh```、```markdown```
- 您可在日志面板分页查看机器人的日志
- 状态面板提供了酷酷的系统状态数据大屏，并友好支持移动端页面布局，您还可以在这里查看实时文本和图片消息，点击大屏的群号或好友让机器人快捷回复
- 内置标准输入输出和onebotv11适配器，可在面板配置启用
- 内置基于onebot协议的仿真QQ沙盒，涵盖onebot协议大部分的动作、事件和接口，你可以在免登录环境高效测试你的插件！
- 支持在线管理Redis数据库
## 联系
- 小微的崽窝: [397798018](http%3A%2F%2Fqm.qq.com%2Fcgi-bin%2Fqm%2Fqr%3F_wv%3D1027%26k%3D6qeMfgydE5k8e_nTorXz0ywmahixBTFw%26authKey%3D9iCyC5qsuluUfxwz4evh5xPmJb3YwlixjoMTxN9He%252BrGu7WiDf2dY8OGk7t%252BGaIu%26noverify%3D0%26group_code%3D397798018)
## 鸣谢
- [yunzaijs](https://github.com/yunzai-org/yunzaijs) 插件运行环境
- [Yenai-Plugin](https://gitee.com/yeyang52/yenai-plugin) 系统状态接口参考
- [es-drager](https://github.com/vangleer/es-drager) 拖拽组件
- [TianStudio](https://github.com/tiancra) Micro Panel安卓APP开发