📃 docs: 增加基本文档

XasYer · May 4, 2024 · 66e81ac · 66e81ac
1 parent b42ddcd
commit 66e81ac
Show file tree

Hide file tree

Showing 29 changed files with 1,478 additions and 65 deletions.
diff --git a/.vitepress/config.mts b/.vitepress/config.mts
@@ -11,18 +11,29 @@ export default defineConfig({
       text: '编辑此页面'
     },
     nav: [
-      { text: 'Home', link: '/' },
-      { text: 'Examples', link: '/markdown-examples' }
+      { text: '主页', link: '/' },
+      { text: '简介', link: '/intro/start/' },
+      { text: '功能', link: '/feature/linkGame/' }
     ],
     search: {
       provider: 'local'
     },
     sidebar: [
       {
-        text: 'Examples',
+        text: '简介',
         items: [
-          { text: '快速开始', link: '/start' },
-          { text: 'Runtime API Examples', link: '/api-examples' }
+          { text: '快速开始', link: '/intro/start/' },
+          { text: '关于插件', link: '/intro/about/' }
+        ]
+      },
+      {
+        text: '功能',
+        items: [
+          { text: '连连看', link: '/feature/linkGame/' },
+          { text: '扫雷', link: '/feature/minesweeper/' },
+          { text: '消灭星星', link: '/feature/popstar/' },
+          { text: '人生重开', link: '/feature/remake/' },
+          { text: '今日超能力', link: '/feature/todaySuperPower/' },
         ]
       }
     ],

diff --git a/api-examples.md b/api-examples.md
diff --git a/feature/linkGame/image/game.png b/feature/linkGame/image/game.png
diff --git a/feature/linkGame/image/start.png b/feature/linkGame/image/start.png
diff --git a/feature/linkGame/image/stop.png b/feature/linkGame/image/stop.png
diff --git a/feature/linkGame/index.md b/feature/linkGame/index.md
@@ -0,0 +1,40 @@
+# 连连看
+
+## 介绍
+
+使用按钮进行交互, 两个图像直接可以拐两次弯
+
+## 指令
+
+| 指令       | 用途     | 示例              | 备注         |
+| ---------- | -------- | ----------------- | ------------ |
+| 连连看     | 开始游戏 | #连连看           |              |
+| 连线       | 选择天赋 | 连线 1,1 连线 1,2 | 必须要两个值 |
+| 结束连连看 | 结束游戏 | #结束连连看       |              |
+
+## 注意事项
+
+- 连线必须要有两个值
+- 一条消息选择多个时会收不到这条消息
+
+## 配置文件
+
+如果有的话
+
+## 鸣谢
+
+- [zhanyuzhang/link-game](https://github.com/zhanyuzhang/link-game) H5 消消乐（连连看）小游戏
+
+## 效果图
+
+### 开始游戏
+
+![开始游戏](./image/start.png)
+
+### 进行游戏
+
+![进行游戏](./image/game.png)
+
+### 结束游戏
+
+![结束游戏](./image/stop.png)
diff --git a/feature/minesweeper/image/mark.png b/feature/minesweeper/image/mark.png
diff --git a/feature/minesweeper/image/open.png b/feature/minesweeper/image/open.png
diff --git a/feature/minesweeper/image/start.png b/feature/minesweeper/image/start.png
diff --git a/feature/minesweeper/index.md b/feature/minesweeper/index.md
@@ -0,0 +1,40 @@
+# 扫雷
+
+## 介绍
+
+通过按钮点击来进行扫雷游戏,最大支持 5\*10
+
+## 指令
+
+| 指令  | 用途     | 示例          | 备注               |
+| ----- | -------- | ------------- | ------------------ |
+| #扫雷 | 开始游戏 | #扫雷         |                    |
+| 挖开  | 进行游戏 | 挖开 1,1      |                    |
+| 标记  | 标记格子 | 挖开 1,1 标记 | 需要和挖开一起使用 |
+
+## 注意事项
+
+- 一般来说只能点击按钮进行操作,所以没有支持`标记 x,y`这样的指令
+- 在`PCQQNT`可能会显示不全
+
+## 配置文件
+
+如果有的话
+
+## 鸣谢
+
+- [noneplugin/nonebot-plugin-minesweeper](https://github.com/noneplugin/nonebot-plugin-minesweeper) Nonebot2 扫雷插件
+
+## 效果图
+
+### 开始游戏
+
+![开始游戏](./image/start.png)
+
+### 进行游戏
+
+![进行游戏](./image/open.png)
+
+### 标记
+
+![标记](./image/mark.png)
diff --git a/feature/popstar/image/game.png b/feature/popstar/image/game.png
diff --git a/feature/popstar/image/start.png b/feature/popstar/image/start.png
diff --git a/feature/popstar/image/stop.png b/feature/popstar/image/stop.png
diff --git a/feature/popstar/index.md b/feature/popstar/index.md
@@ -0,0 +1,40 @@
+# 消灭星星
+
+## 介绍
+
+通过按钮交互, 实现经典小游戏《消灭星星》
+
+## 指令
+
+| 指令         | 用途     | 示例          | 备注 |
+| ------------ | -------- | ------------- | ---- |
+| 消灭星星     | 开始游戏 | #消灭星星     |      |
+| 消灭         | 进行游戏 | 消灭 1        |      |
+| 结束消灭星星 | 结束游戏 | #结束消灭星星 |      |
+
+## 注意事项
+
+- 因为消灭星星为 10\*10,所以会发送两排按钮
+- 在`PCQQNT`可能会显示不全
+
+## 配置文件
+
+如果有的话
+
+## 鸣谢
+
+- [leeenx/popstar](https://github.com/leeenx/popstar) H5 小游戏 100 例：消灭星星
+
+## 效果图
+
+### 开始游戏
+
+![开始游戏](./image/start.png)
+
+### 进行游戏
+
+![进行游戏](./image/game.png)
+
+### 结束游戏
+
+![结束游戏](./image/stop.png)
diff --git a/feature/remake/image/start.png b/feature/remake/image/start.png
diff --git a/feature/remake/image/stats.png b/feature/remake/image/stats.png
diff --git a/feature/remake/image/tlt.png b/feature/remake/image/tlt.png
diff --git a/feature/remake/index.md b/feature/remake/index.md
@@ -0,0 +1,41 @@
+# 人生重开模拟器
+
+## 介绍
+
+人生重开模拟器
+
+## 指令
+
+| 指令    | 用途     | 示例      | 备注 |
+| ------- | -------- | --------- | ---- |
+| remake  | 开始游戏 | #人生重开 |      |
+| 0 1 2   | 选择天赋 | 0 1 2     |      |
+| 5 5 5 5 | 分配属性 | 5 5 5 5   |      |
+| 随机    | 随机分配 | 随机      |      |
+
+## 注意事项
+
+如果有的话
+
+## 配置文件
+
+如果有的话
+
+## 鸣谢
+
+- [VickScarlet/lifeRestart](https://github.com/VickScarlet/lifeRestart) 人生重开本体
+- [noneplugin/nonebot-plugin-remake](https://github.com/noneplugin/nonebot-plugin-remake) 人生重开结果图片
+
+## 效果图
+
+### 开始游戏
+
+![开始游戏](./image/start.png)
+
+### 选择天赋
+
+![选择天赋](./image/tlt.png)
+
+### 分配属性
+
+![分配属性](./image/stats.png)
diff --git a/feature/todaySuperPower/image/like.png b/feature/todaySuperPower/image/like.png
diff --git a/feature/todaySuperPower/image/lookReview.png b/feature/todaySuperPower/image/lookReview.png
diff --git a/feature/todaySuperPower/image/pass.png b/feature/todaySuperPower/image/pass.png
diff --git a/feature/todaySuperPower/image/review.png b/feature/todaySuperPower/image/review.png
diff --git a/feature/todaySuperPower/image/select.png b/feature/todaySuperPower/image/select.png
diff --git a/feature/todaySuperPower/image/start.png b/feature/todaySuperPower/image/start.png
diff --git a/feature/todaySuperPower/index.md b/feature/todaySuperPower/index.md
@@ -0,0 +1,92 @@
+# 今日超能力
+
+## 介绍
+
+每日刷新不同的超能力以及副作用并统计数据
+
+## 指令
+
+| 指令       | 用途             | 示例       | 备注             |
+| ---------- | ---------------- | ---------- | ---------------- |
+| 今日超能力 | 查看今日的超能力 | 今日超能力 | 可查看昨日和明日 |
+| 按下       | 选择按下         | 按下       |                  |
+| 不按       | 选择不按         | 不按       |                  |
+| 评论       | 进行评论         | 评论 123   |                  |
+| 查看评论   | 查看评论         | 查看评论   |                  |
+| 点赞评论   | 点赞评论         | 点赞评论 1 |                  |
+| 点踩评论   | 点踩评论         | 点踩评论 1 |                  |
+| 通过评论   | 对评论进行审核   | 通过评论 1 |                  |
+| 删除评论   | 对评论进行删除   | 删除评论 1 |                  |
+
+## 注意事项
+
+- 如果要审核评论需要有其他可以发主动消息的 Bot
+
+## 配置文件
+
+### config/todaySuperPower.yaml
+
+```yaml
+# 是否启用本功能
+enable: false
+
+# 可以发送主动消息的Bot信息,用于审核评论以及推送明日超能力
+otherBotInfo:
+  # 可以发送主动消息的Bot的QQ号,没有可以填false
+  QQ: false
+  # 可以发送主动消息的Bot和QQbot需要在一个群里
+  group: 1234556
+  # 建议将野生Bot设置为master,或者配置此项,可以发送主动消息的bot在QQBot的id
+  QQBotID: 38890001385C0739E3009010448273A26F09967EB5
+
+# 官方Bot信息,用于审核评论以及推送明日超能力
+QQBotInfo:
+  # 官方Bot的QQ号
+  QQ: 3889000138
+
+# 审核评论 需要可以发送主动消息的Bot
+examineReviewInfo:
+  # 是否启用审核评论功能
+  enable: false
+
+# 明日超能力 需要可以发送主动消息的Bot
+TomorrowSuperPowerInfo:
+  # 是否启用明日超能力推送功能
+  enable: true
+  # 什么时候进行推送
+  cron: "0 30 23 * * ?"
+
+# 启用此功能的适配器,达成条件才会开启
+adapter:
+  - key: "e.adapter_name"
+    value: "QQBot"
+  - key: "e.bot.config.markdown"
+    value: true
+
+```
+
+## 鸣谢
+
+- [https://willyoupressthebutton.com/](https://willyoupressthebutton.com/) 数据来源
+
+## 效果图
+
+### 今日超能力
+
+![今日超能力](./image/start.png)
+
+### 选择按下
+
+![选择按下](./image/select.png)
+
+### 评论
+
+![评论](./image/review.png)
+
+### 查看评论
+
+![查看评论](./image/lookReview.png)
+
+### 点赞
+
+![点赞评论](./image/like.png)
diff --git a/index.md b/index.md
@@ -5,21 +5,22 @@ layout: home
 hero:
   name: "Shiranai-Plugin"
   # text: "希腊奶文档"
-  tagline: 专注于QQBot的游戏插件
+  tagline: 专注于QQBot的插件
+  image:
+    src: https://count.getloli.com/get/@XasYer-Shiranai-Plugin?theme=rule34
   actions:
     - theme: brand
       text: 快速开始
-      link: /start
+      link: /intro/start/
     - theme: alt
-      text: 游戏文档
-      link: /api-examples
+      text: 详细功能
+      link: /feature/minesweeper/
 
 features:
-  - title: 游戏
-    details: 致力于大部分经典游戏
-  - title: 按钮
-    details: 使用按钮进行交互
-  - title: Feature C
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+  - title: 不如TRSS
+    details: 不如TRSS
+  - title: 不如TRSS
+    details: 不如TRSS
+  - title: 不如TRSS
+    details: 不如TRSS
 ---
-
diff --git a/intro/about/index.md b/intro/about/index.md
@@ -0,0 +1,3 @@
+# 关于插件
+
+适用于`TRSS-Yunzai`以及`QQbot-Plugin`的扩展插件, 提供部分娱乐功能
diff --git a/start.md → intro/start/index.md b/start.md → intro/start/index.md
@@ -11,3 +11,6 @@ git clone --depth=1 https://github.com/XasYer/Shiranai-Plugin.git ./plugins/Shir
 pnpm install --filter=Shiranai-Plugin
 ```
 
+## 注意事项
+
+1. 主要以`TRSS-Yunzai`以及`QQBot-Plugin`为主,若不是这两个插件,请自行查看是否可用