feat: backup document

Signed-off-by: MiaoWoo <admin@yumc.pw>
2020-10-31 09:51:31 +08:00
parent e02f673c82
commit db8f2d9bc2
4 changed files with 175 additions and 29 deletions
--- a/packages/plugins/docs/MiaoBlockly.md
+++ b/packages/plugins/docs/MiaoBlockly.md
@@ -0,0 +1,67 @@
+# MiaoBlockly
+
+## 前言
+
+- 嗯 我又来了
+- 之前承诺的 MiaoScript 腐竹可以用的版本
+- 第一个 Demo 版本 MiaoBlockly 写完了
+
+### 什么是 MiaoBlockly
+
+#### ~~对于开发者~~(开发一般不会用这玩意儿)
+
+#### 对于腐竹
+- 可以在网页上开发一些简单的插件
+- 拖动方块就能实现了
+
+### 图片展示
+
+![image.png](https://i.loli.net/2020/10/22/R8nlf9WtVYDXoa3.png)
+
+### MiaoBlockly 的兼容性
+- 跨端兼容 Sponge Bukkit BungeeCord
+  - Bukkit 支持 1.12.2 +(由于1.12.2以下版本Netty版本过老需要适配 后续兼容到1.7.10)
+  - Sponge
+  - CatServer 1.12.2+
+  - BungeeCord
+
+### 安装教程
+- 安装 `MiaoConsole` [站内地址](https://www.mcbbs.net/thread-1129227-1-1.html) 没错 就是装 MiaoConsole
+- 因为 `MiaoBlockly` 底层还是运行的 js 只是用 `Blockly` 生成了代码而已
+- 需要 `MiaoConsole` 是因为需要和服务器通信
+
+### 使用教程
+- 查看启动日志 获取临时 `Token`
+  - 或者 执行 `mconsole token` 获得临时Token
+- 打开 `http://ms.yumc.pw/blockly.html`
+- 在地址栏输入服务器地址 需要带上端口
+- 在 Token 栏输入获取到的 Token
+- 点击链接即可
+
+### 编辑器使用
+- 默认界面有一个插件主体
+- 拖动积木 右侧会自动生成代码
+- 在代码界面 按下 `Ctrl + S` 代码会自动传送到服务器 并且重载插件
+- 更多功能还在开发
+
+### RoadMap
+- 开发聊天相关功能
+- 完善事件相关功能
+- 开发命令相关功能
+- 开发跨服相关功能
+- 统一各个端之间的事件(工作量较大 可能会咕咕咕)
+- 脚本商城 方便开发和腐竹之前的 PY 交易
+- 脚本打包成 Jar 方便部署
+
+### Miao系列插件
+
+- [[经济]MiaoReward —— 喵式奖励 让玩家看广告为服务器提供收入吧[1.7.10+全版本]](https://www.mcbbs.net/thread-1121423-1-1.html)
+- [[编程]MiaoBlockly —— 喵式积木 用简单的积木来写插件吧[1.12.2+全版本]](https://www.mcbbs.net/thread-1129411-1-1.html)
+- [[编程]MiaoConsole —— 喵式终端 通过MC端口直接控制服务器 调试插件[1.12.2+全版本]](https://www.mcbbs.net/thread-1129227-1-1.html)
+- [[管理]MiaoBind —— 喵式绑定 兼容SoulBound的绑定插件 支持自定义关键词[1.7+全版本]](https://www.mcbbs.net/thread-922072-1-1.html)
+- [[信息]MiaoBoard —— 喵式记分板 自定义动态记分板[1.7+全版本]](https://www.mcbbs.net/thread-631482-1-1.html)
+- [[聊天]MiaoChat —— 喵式聊天 多功能自定义聊天格式 新增支持跨服[1.7.10+全版本]](https://www.mcbbs.net/thread-631240-1-1.html)
+- [[菜单]MiaoMenu —— 喵式菜单 强大的自定义菜单 支持多种自定义操作[1.7+全版本]](https://www.mcbbs.net/thread-860047-1-1.html)
+- [[管理]YUM —— 全能的服务器插件管理工具 全自动安装插件 更新插件[1.7.2+全版本]](https://www.mcbbs.net/thread-701333-1-1.html)
+
+本插件所用所有代码均为原创,不存在借用/抄袭等行为
--- a/packages/plugins/docs/MiaoConsole.md
+++ b/packages/plugins/docs/MiaoConsole.md
@@ -1,12 +1,24 @@
+# MiaoConsole
+
 ## 前言

 > 各位开发 在调试Minecraft插件的时候 是不是经常面临下列情况
 - 编译等半天 重启等半天 测试找不到问题
 - 后台 IDE SCP/FTP 来回切换

-### 什么是MiaoConsole
- MiaoConsole 是 基于 MiaoScript 开发的 在线调试工具
- 通过复用 Minecraft的Netty 通道 实现服务器端口 在线调试(并不是Java的调试哦)
+> 各位腐竹 在开服的时候 是不是经常遇到下列情况
+- 修改一个配置文件 经常格式错误
+- 各种报错看不懂 插件依赖找不到
+
+### 什么是 MiaoConsole
+
+#### 对于开发者
+- MiaoConsole 是 基于 `MiaoScript` 开发的 在线调试工具
+- 通过复用 Minecraft 的 Netty 通道 实现服务器端口 `MiaoScript` 在线调试
+
+#### 对于腐竹
+- 可以在网页上实时看到服务器日志
+- 共享 Token 给插件开发者 让其帮助调试服务器

 ### 工具动图

@@ -16,8 +28,8 @@
 ### MiaoConsole 有哪些功能
 - 无需编译 上传等步骤 实时在线debug
 - 实时转发服务端日志 无需来回切换
- 基于Nashorn的动态脚本语言
- 基于TypeScript的自动补全逻辑(以实现BungeeCord Sponge Bukkit的API全自动补全)
+- 基于 Nashorn 的动态脚本语言
+- 基于 TypeScript 的自动补全逻辑(以实现BungeeCord Sponge Bukkit的API全自动补全)

 ### MiaoConsole 的兼容性
 - 跨端兼容 Sponge Bukkit BungeeCord
@@ -27,25 +39,27 @@
  - BungeeCord ~~终端转发暂未兼容~~ 已经能兼容了

 ### 安装教程
- 安装MiaoScript [下载地址](http://w.yumc.pw/free.html#MiaoScript-download)
- 首次启动 等待加载基础环境类库
- 执行 `mpm i MiaoConsole`
+- 安装 `MiaoScript` [站内地址](https://www.mcbbs.net/thread-774401-1-1.html)
+  - 如果你已经安装了 Yum 可以通过 Yum 快速安装 `/yum install MiaoScript`
+- 等待 MiaoScript 引擎启动完成(首次启动可能需要10-20秒 依赖于您的网络环境)
+- 执行 `mspm i MiaoConsole`

 ### 使用教程
- 执行 `mconsole token` 获得临时Token
+- 查看启动日志 获取临时 `Token`
+  - 或者 执行 `mconsole token` 获得临时Token
 - 打开 `http://ms.yumc.pw/console.html`
 - 在地址栏输入服务器地址 需要带上端口
- 在Token栏输入获取到的Token
+- 在 Token 栏输入获取到的 Token
 - 点击链接即可

 ### 终端使用
 - 支持实时传输服务器日志到终端
 - 直接在终端输入命令 会转发到服务器
- 目前暂不支持命令自动补全
+- 支持命令自动补全
 - 支持命令历史

 ### 代码编辑器使用
- 支持 Java 的 lang包和util包自动补全
+- 支持 Java 的类自动补全
 - 支持服务端所有代码补全
 - 注意 暂时不支持自动导入包 所以需要手动输入全类名
 - 快捷键说明(选中代码后 只会执行选中部分)
@@ -53,8 +67,27 @@
  - Ctrl + E 执行命令
  - Ctrl + Q 切换代码页

+## 插件源码
+
+- [MiaoScript包管理中心](https://git.yumc.pw/circlecloud/ms/src/branch/master/packages/plugins/src/MiaoConsole.ts)
+
 ### RoadMap
- 支持命令自动补全
- 支持常用的开发脚本
- 支持快捷操作服务器数据
+- 支持 Java 类的自动补全
+- 支持命令自动补全(已完成)
+- 支持常用的开发脚本(开发中)
+- 支持快捷操作服务器数据(开发中)
 - 支持在线编辑服务器文件(开发了一半)
+- 配置文件格式效验(开发中)
+
+### Miao系列插件
+
+- [[经济]MiaoReward —— 喵式奖励 让玩家看广告为服务器提供收入吧[1.7.10+全版本]](https://www.mcbbs.net/thread-1121423-1-1.html)
+- [[编程]MiaoBlockly —— 喵式积木 用简单的积木来写插件吧[1.12.2+全版本]](https://www.mcbbs.net/thread-1129411-1-1.html)
+- [[编程]MiaoConsole —— 喵式终端 通过MC端口直接控制服务器 调试插件[1.12.2+全版本]](https://www.mcbbs.net/thread-1129227-1-1.html)
+- [[管理]MiaoBind —— 喵式绑定 兼容SoulBound的绑定插件 支持自定义关键词[1.7+全版本]](https://www.mcbbs.net/thread-922072-1-1.html)
+- [[信息]MiaoBoard —— 喵式记分板 自定义动态记分板[1.7+全版本]](https://www.mcbbs.net/thread-631482-1-1.html)
+- [[聊天]MiaoChat —— 喵式聊天 多功能自定义聊天格式 新增支持跨服[1.7.10+全版本]](https://www.mcbbs.net/thread-631240-1-1.html)
+- [[菜单]MiaoMenu —— 喵式菜单 强大的自定义菜单 支持多种自定义操作[1.7+全版本]](https://www.mcbbs.net/thread-860047-1-1.html)
+- [[管理]YUM —— 全能的服务器插件管理工具 全自动安装插件 更新插件[1.7.2+全版本]](https://www.mcbbs.net/thread-701333-1-1.html)
+
+本插件所用所有代码均为原创,不存在借用/抄袭等行为
--- a/packages/plugins/docs/MiaoPlugin.md
+++ b/packages/plugins/docs/MiaoPlugin.md
@@ -0,0 +1,24 @@
+### Miao系列插件
+
+- [[经济]MiaoReward —— 喵式奖励 让玩家看广告为服务器提供收入吧[1.7.10+全版本]](https://www.mcbbs.net/thread-1121423-1-1.html)
+- [[编程]MiaoBlockly —— 喵式积木 用简单的积木来写插件吧[1.12.2+全版本]](https://www.mcbbs.net/thread-1129411-1-1.html)
+- [[编程]MiaoConsole —— 喵式终端 通过MC端口直接控制服务器 调试插件[1.12.2+全版本]](https://www.mcbbs.net/thread-1129227-1-1.html)
+- [[管理]MiaoBind —— 喵式绑定 兼容SoulBound的绑定插件 支持自定义关键词[1.7+全版本]](https://www.mcbbs.net/thread-922072-1-1.html)
+- [[信息]MiaoBoard —— 喵式记分板 自定义动态记分板[1.7+全版本]](https://www.mcbbs.net/thread-631482-1-1.html)
+- [[聊天]MiaoChat —— 喵式聊天 多功能自定义聊天格式 新增支持跨服[1.7.10+全版本]](https://www.mcbbs.net/thread-631240-1-1.html)
+- [[菜单]MiaoMenu —— 喵式菜单 强大的自定义菜单 支持多种自定义操作[1.7+全版本]](https://www.mcbbs.net/thread-860047-1-1.html)
+- [[管理]YUM —— 全能的服务器插件管理工具 全自动安装插件 更新插件[1.7.2+全版本]](https://www.mcbbs.net/thread-701333-1-1.html)
+
+[size=20px][b]Miao系列插件[/b][/size]
+
+[size=16px][list]
+[*][url=https://www.mcbbs.net/thread-1121423-1-1.html][经济]MiaoReward —— 喵式奖励 让玩家看广告为服务器提供收入吧[1.7.10+全版本][/url]
+[*][url=https://www.mcbbs.net/thread-1129411-1-1.html][编程]MiaoBlockly —— 喵式积木 用简单的积木来写插件吧[1.12.2+全版本][/url]
+[*][url=https://www.mcbbs.net/thread-1129227-1-1.html][编程]MiaoConsole —— 喵式终端 通过MC端口直接控制服务器 调试插件[1.12.2+全版本][/url]
+[*][url=https://www.mcbbs.net/thread-922072-1-1.html][管理]MiaoBind —— 喵式绑定 兼容SoulBound的绑定插件 支持自定义关键词[1.7+全版本][/url]
+[*][url=https://www.mcbbs.net/thread-631482-1-1.html][信息]MiaoBoard —— 喵式记分板 自定义动态记分板[1.7+全版本][/url]
+[*][url=https://www.mcbbs.net/thread-631240-1-1.html][聊天]MiaoChat —— 喵式聊天 多功能自定义聊天格式 新增支持跨服[1.7.10+全版本][/url]
+[*][url=https://www.mcbbs.net/thread-860047-1-1.html][菜单]MiaoMenu —— 喵式菜单 强大的自定义菜单 支持多种自定义操作[1.7+全版本][/url]
+[*][url=https://www.mcbbs.net/thread-701333-1-1.html][管理]YUM —— 全能的服务器插件管理工具 全自动安装插件 更新插件[1.7.2+全版本][/url][/list][/size]
+
+[size=16px]本插件所用所有代码均为原创,不存在借用/抄袭等行为[/size]
--- a/packages/plugins/docs/MiaoReward.md
+++ b/packages/plugins/docs/MiaoReward.md
@@ -6,7 +6,16 @@
 - 快来接入 喵式奖励
 - 通过QQ小程序广告 增加服务器收入

+### 先来一张近期的服务器提现订单
+
+![image.png](https://i.loli.net/2020/10/16/LmXAklot43WOy1P.png)
+
 ## 插件展示
+
+> 多图预警 折叠了
+
+`[spoiler]`
+
 - 插件帮助![image.png](https://i.loli.net/2020/09/12/uNbwO2sCVriZzJx.png)
 - 扫码绑定![image.png](https://i.loli.net/2020/09/13/hOtyV8bP9kGeuCD.png)
 - 查看个人信息![image.png](https://i.loli.net/2020/09/12/bTLGjQC7eqxAUSi.png)
@@ -20,6 +29,9 @@
 - 玩家扫码兑换完成![image.png](https://i.loli.net/2020/09/24/JG2SBtgHLzNeaEO.png)
 - 腐竹扫码确认![image.png](https://i.loli.net/2020/09/24/c7sS18KJvQ3MRuZ.png)
 - 腐竹扫码完成![image.png](https://i.loli.net/2020/09/24/RtsoSdV7j6OmE8Q.png)
+
+`[/spoiler]`
+
 ## 插件命令
 ```
 >mrd
@@ -38,6 +50,8 @@
 [17:56:54 INFO]: [MS][MRD] 比如 设置了0.001 那就是 玩家至少 1000喵币 才能兑换!
 ```

+## 接下来就是赚钱的操作
+
 ## 插件安装/配置

 ### 基础准备工作
@@ -46,23 +60,25 @@
  - 个人中心 => 配置面板 => 圈云盒子客服群
  - 打开群详情 加群

-### 接下来就是赚钱的操作
+### 申请账号
+- 打开 [圈云盒子管理后台](https://reward.yumc.pw)
+- 扫码登录 并且加入客服群
+- 创建一个服务器 等待管理员审核通过
+
+`[hide]`

 ### 服务器准备工作
- 打开 [圈云盒子管理后台](https://reward.yumc.pw)
- 先安装 `MiaoScript` [站内地址](https://www.mcbbs.net/thread-774401-1-1.html)
-  - 可以通过 Yum 快速安装 `/yum install MiaoScript`
+- 安装 `MiaoScript` [站内地址](https://www.mcbbs.net/thread-774401-1-1.html)
+  - 如果你已经安装了 Yum 可以通过 Yum 快速安装 `/yum install MiaoScript`
 - 等待 MiaoScript 引擎启动完成(首次启动可能需要10-20秒 依赖于您的网络环境)
- 执行 `/mspm install MiaoReward`
+- 执行 `/mspm install MiaoReward` 安装 MiaoReward 脚本插件
+- 完成安装

 ### 绑定服务器
- 由于当前框架存在BUG 请先执行 `/mspm reload MiaoReward` 生成配置文件
 - 执行 `/mrd bind server`
- 使用QQ扫码
- 选择需要绑定的服务器
- 完成绑定
+- 使用QQ扫码 => 选择需要绑定的服务器 => 完成绑定
 - 配置服务器兑换比例
- 执行 `/mrd ratio 0.001` (最低为 1:0.0001)
+- 执行 `/mrd ratio <兑换比例>` (最低为 1:0.0001)
 - 执行兑换比例确认指令
 - 执行 `/mrd server` 查看服务器信息
 - 如果群组服需要绑定多台服务器(前提是每个服务器都有玩家在)
@@ -118,12 +134,18 @@ prefix: '§6[§b广告系统§6]§r'

 ## 插件源码

- [MiaoScript包管理中心](http://ms.yumc.pw/api/plugin/download/name/MiaoReward)
+- [MiaoScript包管理中心](https://git.yumc.pw/circlecloud/ms/src/branch/master/packages/plugins/src/MiaoReward.ts)
+
+`[/hide]`
+
+## 更新日志
+- 2020-10-12 完成提现功能
+- 2020-10-06 使用发包的方式展示地图

 ## Roadmap
 - 绑定服务器(已完成)
 - 绑定玩家(已完成)
 - 兑换喵币(已完成)
- 自助开通服务器(开发中)
- 自助兑换RMB(开发中)
- 自助提现(开发中)
+- [自助开通](https://reward.yumc.pw)服务器(已完成)
+- [自助兑换](https://reward.yumc.pw)RMB(已完成)
+- [自助提现](https://reward.yumc.pw)(已完成)