✏️ 完善自述

starim00 · Aug 6, 2021 · 80265d6 · 80265d6
1 parent 70a9706
commit 80265d6
Showing 1 changed file with 54 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -1,34 +1,39 @@
 <div align="center">
   <img src=".github/yaya.jpg" width = "150" height = "150" alt="OneBot-YaYa"><br>
-  <h2>ZeroBot-Plugin</h2>
+  <h1>ZeroBot-Plugin</h1>
   ZeroBot-Plugin 是 ZeroBot 的 实用插件合集<br><br>
 
+  <img src="http://sayuri.fumiama.top/cmoe?name=ZeroBot-Plugin&theme=r34" />
+
 [![YAYA](https://img.shields.io/badge/OneBot-YaYa-green.svg?style=social&logo=appveyor)](https://github.com/Yiwen-Chan/OneBot-YaYa)
 [![GOCQ](https://img.shields.io/badge/OneBot-MiraiGo-green.svg?style=social&logo=appveyor)](https://github.com/Mrs4s/go-cqhttp)
 [![OICQ](https://img.shields.io/badge/OneBot-OICQ-green.svg?style=social&logo=appveyor)](https://github.com/takayama-lily/node-onebot)
 [![MIRAI](https://img.shields.io/badge/OneBot-Mirai-green.svg?style=social&logo=appveyor)](https://github.com/yyuueexxiinngg/onebot-kotlin)
 
 [![Go Report Card](https://goreportcard.com/badge/github.com/Yiwen-Chan/ZeroBot-Plugin?style=flat-square&logo=go)](https://goreportcard.com/report/github.com/github.com/Yiwen-Chan/ZeroBot-Plugin)
 [![Badge](https://img.shields.io/badge/onebot-v11-black?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAHAAAABwCAMAAADxPgR5AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAAxQTFRF////29vbr6+vAAAAk1hCcwAAAAR0Uk5T////AEAqqfQAAAKcSURBVHja7NrbctswDATQXfD//zlpO7FlmwAWIOnOtNaTM5JwDMa8E+PNFz7g3waJ24fviyDPgfhz8fHP39cBcBL9KoJbQUxjA2iYqHL3FAnvzhL4GtVNUcoSZe6eSHizBcK5LL7dBr2AUZlev1ARRHCljzRALIEog6H3U6bCIyqIZdAT0eBuJYaGiJaHSjmkYIZd+qSGWAQnIaz2OArVnX6vrItQvbhZJtVGB5qX9wKqCMkb9W7aexfCO/rwQRBzsDIsYx4AOz0nhAtWu7bqkEQBO0Pr+Ftjt5fFCUEbm0Sbgdu8WSgJ5NgH2iu46R/o1UcBXJsFusWF/QUaz3RwJMEgngfaGGdSxJkE/Yg4lOBryBiMwvAhZrVMUUvwqU7F05b5WLaUIN4M4hRocQQRnEedgsn7TZB3UCpRrIJwQfqvGwsg18EnI2uSVNC8t+0QmMXogvbPg/xk+Mnw/6kW/rraUlvqgmFreAA09xW5t0AFlHrQZ3CsgvZm0FbHNKyBmheBKIF2cCA8A600aHPmFtRB1XvMsJAiza7LpPog0UJwccKdzw8rdf8MyN2ePYF896LC5hTzdZqxb6VNXInaupARLDNBWgI8spq4T0Qb5H4vWfPmHo8OyB1ito+AysNNz0oglj1U955sjUN9d41LnrX2D/u7eRwxyOaOpfyevCWbTgDEoilsOnu7zsKhjRCsnD/QzhdkYLBLXjiK4f3UWmcx2M7PO21CKVTH84638NTplt6JIQH0ZwCNuiWAfvuLhdrcOYPVO9eW3A67l7hZtgaY9GZo9AFc6cryjoeFBIWeU+npnk/nLE0OxCHL1eQsc1IciehjpJv5mqCsjeopaH6r15/MrxNnVhu7tmcslay2gO2Z1QfcfX0JMACG41/u0RrI9QAAAABJRU5ErkJggg==)](https://github.com/howmanybots/onebot)
-[![Badge](https://img.shields.io/badge/zerobot-v1.2.1-black?style=flat-square&logo=go)](https://github.com/wdvxdr1123/ZeroBot)
+[![Badge](https://img.shields.io/badge/zerobot-v1.2.2-black?style=flat-square&logo=go)](https://github.com/wdvxdr1123/ZeroBot)
 [![License](https://img.shields.io/github/license/Yiwen-Chan/OneBot-YaYa.svg?style=flat-square&logo=gnu)](https://raw.githubusercontent.com/FloatTech/ZeroBot-Plugin/master/LICENSE)
 [![qq group](https://img.shields.io/badge/group-1048452984-red?style=flat-square&logo=tencent-qq)](https://jq.qq.com/?_wv=1027&k=QMb7x1mM)
 
+[![Compile ZeroBot-Plugin-linux](https://github.com/FloatTech/ZeroBot-Plugin/actions/workflows/linux.yml/badge.svg?branch=master)](https://github.com/FloatTech/ZeroBot-Plugin/actions/workflows/linux.yml)
+[![Compile ZeroBot-Plugin-windows](https://github.com/FloatTech/ZeroBot-Plugin/actions/workflows/windows.yml/badge.svg?branch=master)](https://github.com/FloatTech/ZeroBot-Plugin/actions/workflows/windows.yml)
+
 </div>
 
 
-### 功能
-- 聊天 `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_chat"`
+## 功能
+- **聊天** `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_chat"`
     - [x] [BOT名字]
     - [x] [戳一戳BOT]
     - [x] 空调开
     - [x] 空调关
     - [x] 群温度
     - [x] 设置温度[正整数]
-- ATRI `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_atri"`
+- **ATRI** `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_atri"`
     - [x] 具体指令看代码
     - 注：本插件基于 [ATRI](https://github.com/Kyomotoi/ATRI) ，为 Golang 移植版
-- 群管 `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_manager"`
+- **群管** `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_manager"`
     - [x] 禁言[@xxx][分钟]
     - [x] 解除禁言[@xxx]
     - [x] 我要自闭 [分钟]
@@ -54,54 +59,54 @@
     - [ ] 撤回[@xxx] [xxx]
     - [ ] 警告[@xxx]
     - [x] run[xxx]
-- GitHub仓库搜索 `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_github"`
+- **GitHub仓库搜索** `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_github"`
     - [x] >github [xxx] 
     - [x] >github -p [xxx] 
-- 在线代码运行 `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_runcode"`
+- **在线代码运行** `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_runcode"`
     - [x] >runcode help
     - [x] >runcode [on/off]
     - [x] >runcode [language] [code block] 
-- 点歌 `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_music"`
+- **点歌** `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_music"`
     - [x] 点歌[xxx]
     - [x] 网易点歌[xxx]
     - [x] 酷我点歌[xxx]
     - [x] 酷狗点歌[xxx]
-- shindan `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_shindan"`
+- **shindan** `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_shindan"`
     - [x] 今天是什么少女[@xxx] 
     - [x] 异世界转生[@xxx] 
     - [x] 卖萌[@xxx] 
-- 涩图 `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_setutime"`
+- **涩图** `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_setutime"`
     - [x] 来份[涩图/二次元/风景/车万]
     - [x] 添加[涩图/二次元/风景/车万][P站图片ID]
     - [x] 删除[涩图/二次元/风景/车万][P站图片ID]
     - [x] >setu status
-- lolicon `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_lolicon"`
+- **lolicon** `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_lolicon"`
     - [x] 来份萝莉
-- 搜图 `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_saucenao"`
+- **搜图** `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_saucenao"`
     - [x] 以图搜图|搜索图片|以图识图[图片]
     - [x] 搜图[P站图片ID]
-- 随机图片与AI点评 `github.com/FloatTech/ZeroBot-ACGImage`
+- **随机图片与AI点评** `github.com/FloatTech/ZeroBot-ACGImage`
     - [x] 随机图片(评级大于6的图将私发)
     - [x] 直接随机(无r18检测，务必小心，仅管理可用)
     - [x] 设置随机图片网址[url]
     - [x] 太涩了(撤回最近发的图)
     - [x] 评价图片(发送一张图片让bot评分)
-- bilibili `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_bilibili"`
+- **bilibili** `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_bilibili"`
     - [x] >bili info [名字]
-- 嘉然 `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_diana"`
+- **嘉然** `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_diana"`
     - [x] @BOT 小作文
     - [x] @BOT 发大病
     - [x] @BOT 教你一篇小作文[作文]
-- AIfalse `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_AIfalse"`
+- **AIfalse** `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_AIfalse"`
     - [x] 查询计算机当前活跃度 [身体检查]
     - [ ] 简易语音
     - [ ] 爬图合成 [@xxx]
-- minecraft `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_minecraft"`
+- **minecraft** `import _ "github.com/FloatTech/ZeroBot-Plugin/plugin_minecraft"`
     - [x] 具体指令看代码
     - [x] 注：此功能实现依赖[MCSManager](https://github.com/Suwings/MCSManager)项目对服务器的管理api，mc服务器如果没有在该管理平台部署此功能无效
-- TODO...
+- **TODO...**
 
-### 使用方法
+## 使用方法
 
 本项目符合 [OneBot](https://github.com/howmanybots/onebot) 标准，可基于以下项目与机器人框架/平台进行交互
 | 项目地址 | 平台 | 核心作者 | 备注 |
@@ -112,13 +117,16 @@
 | [yyuueexxiinngg/cqhttp-mirai](https://github.com/yyuueexxiinngg/cqhttp-mirai) | [Mirai](https://github.com/mamoe/mirai) | yyuueexxiinngg |  |
 | [takayama-lily/onebot](https://github.com/takayama-lily/onebot) | [OICQ](https://github.com/takayama-lily/oicq) | takayama |  |
 
-#### 本地运行
+### 本地运行
 1. 下载安装 [Go](https://studygolang.com/dl/golang/go1.16.2.windows-amd64.msi) 环境
-2. [clone](https://github.com/Yiwen-Chan/ZeroBot-Plugin/archive/master.zip) 本项目，本地解压
+2. 下载本项目[压缩包](https://github.com/Yiwen-Chan/ZeroBot-Plugin/archive/master.zip)，本地解压
 3. 编辑 main.go 文件，内容按需修改
 4. 双击 build.bat 文件 或 直接双击 run.bat 文件
 5. 运行 OneBot 框架，并同时运行本插件
 
+### 编译运行
+> 需要将`data`目录放置到与编译好的可执行文件相同目录下才可正常执行。
+
 #### 利用 Actions 在线编译 (推荐)
 1. 点击右上角 Fork 本项目，并转跳到自己 Fork 的仓库
 2. 点击仓库上方的 Actions 按钮，确认使用 Actions
@@ -127,7 +135,30 @@
 5. 运行 OneBot 框架，并同时运行本插件
 6. 啾咪~
 
-### 特别感谢
+#### 本地编译/交叉编译
+1. 下载安装 [Go](https://studygolang.com/dl/golang/go1.16.2.windows-amd64.msi) 环境
+2. clone 并进入本项目，下载所需包
+```bash
+git clone --depth=1 https://github.com/FloatTech/ZeroBot-Plugin.git
+cd ZeroBot-Plugin
+go version
+go env -w GOPROXY=https://goproxy.cn,direct
+go env -w GO111MODULE=auto
+go mod tidy
+```
+3. 编辑 main.go 文件，内容按需修改
+4. 按照平台输入命令编译，下面举了两个不太常见的例子
+```bash
+# 本机平台
+go build -ldflags "-s -w -extldflags '-static-libgo'" -o zerobot
+# armv6 Linux 平台 如树莓派 zero W
+GOOS=linux GOARCH=arm GOARM=6 CGO_ENABLED=0 go build -ldflags "-s -w -extldflags '-static-libgo'" -o zerobot
+# mips Linux 平台 如 路由器 wndr4300
+GOOS=linux GOARCH=mips GOMIPS=softfloat CGO_ENABLED=0 go build -ldflags "-s -w -extldflags '-static-libgo'" -o zerobot
+```
+5. 运行 OneBot 框架，并同时运行本插件
+
+## 特别感谢
 - [ZeroBot](https://github.com/wdvxdr1123/ZeroBot)
 - [ATRI](https://github.com/Kyomotoi/ATRI)