From 570d7e18a42cc727fdfe232fcb8f0225afce21aa Mon Sep 17 00:00:00 2001 From: Nanaloveyuki Date: Sun, 16 Jun 2024 23:33:58 +0800 Subject: [PATCH] =?UTF-8?q?Docs=20=E4=B8=BB=E8=A6=81=E6=9B=B4=E6=96=B0:=20?= =?UTF-8?q?=E4=BC=98=E5=8C=96=E8=A1=A8=E6=A0=BC?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 主要改动: - 表格 - 标点符号 - 愚人节主页 --- docs/README.md | 4 +- docs/foolsday.md | 33 +++--- docs/usage/agreement.md | 2 +- docs/usage/basic_command.md | 207 +++++++++++++++++++----------------- docs/usage/lyfunc.md | 5 +- docs/usage/resource_pack.md | 3 + 6 files changed, 138 insertions(+), 116 deletions(-) diff --git a/docs/README.md b/docs/README.md index f6e4082..d7cf646 100644 --- a/docs/README.md +++ b/docs/README.md @@ -58,7 +58,7 @@ highlights: details: 无需繁琐前期过程，开箱即用 link: https://bot.liteyuki.icu/deployment/config.html - - title: 高性能 + - title: 超高性能 icon: tachometer-alt details: 500个插件，3s内启动 @@ -66,7 +66,7 @@ highlights: icon: cloud-download details: 让你的机器人保持最新提交 - - title: 开源 + - title: 开源项目 icon: code details: 项目遵循MIT协议开源，欢迎各位的贡献 diff --git a/docs/foolsday.md b/docs/foolsday.md index ae092d4..71487bd 100644 --- a/docs/foolsday.md +++ b/docs/foolsday.md @@ -2,14 +2,15 @@ home: true icon: home title: 首页 -heroImage: https://cdn.liteyuki.icu/static/img/logo.png +heroImage: https://cdn.liteyuki.icu/static/img/lykwi.png bgImage: bgImageDark: bgImageStyle: background-attachment: fixed -heroText: HeavyyukiBot666 # LiteyukiBot 6 -tagline: 重雪机器人，一个以笨重和复杂为设计理念基于Koishi114514的OneBotv1919810标准聊天机器人，可用于雪地清扫，使用Typethon编写 +heroText: HeavylavaBot666 # LiteyukiBot 6 +tagline: 重浆机器人，一个以笨重和复杂为设计理念基于Koishi114514的TwoBotv1919810标准聊天机器人，可用于雪地清扫，使用Typethon编写 #tagline: 轻雪机器人，一个以轻量和简洁为设计理念基于Nonebot2的OneBot标准聊天机器人 +# 泰普森(X actions: - text: 快速结束 # 快速开始 @@ -39,22 +40,22 @@ highlights: features: - title: 基于Koishi.js233 icon: robot - details: 拥有良好的生态支持 + details: 拥有辣鸡的生态支持 link: https://nonebot.dev/ - title: 盲目插件管理 icon: plug - details: 基于nbshi使用npmx和pip，让你无法安装/卸载插件 + details: 基于nbshi使用xmpn和bib，让你无法安装/卸载插件 - - title: 点击无法交互 + - title: 纯命令行 icon: mouse-pointer - details: 老的的点击交互模式，必须手打指令 + details: 老的掉牙的交互模式，必须手打指令 - title: 猪蹄支持 icon: paint-brush - details: 支持多种主题，可自定义资源包，满足你的审美需求 + details: 支持多种烤猪蹄样式，丢弃烤箱，拥抱烧烤架，满足你的干饭需求 - - title: 非国际化 + - title: 去国际化 icon: globe details: 支持多种语言，包括i18n部分语言和自行扩展的语言代码 link: https://baike.baidu.com/item/i18n/6771940 @@ -80,27 +81,27 @@ highlights: - title: 不准更新 icon: cloud-download - details: 要更新自己下新版本去 + details: 要更新自己写新版本去 - title: 服务支持 icon: server - details: 内置轻雪API，但随时可能跑路 + details: 内置重浆API，但随时可能提桶跑路 - title: 闭源 icon: code details: 要源代码自己逆向去 - - header: 快速部署 + - header: 慢速部署 # 快速部署 image: /assets/image/box.svg bgImage: https://theme-hope-assets.vuejs.press/bg/3-light.svg bgImageDark: https://theme-hope-assets.vuejs.press/bg/3-dark.svg highlights: - - title: 安装 Git 和 node.js+ - - title: 使用 git clone https://github.com/snowykami/LiteyukiBot 以克隆项目至本地。 - details: 如果无法连接到GitHub，可以使用 git clone https://gitee.com/snowykami/LiteyukiBot。 + - title: 安装 winget 和 nothing.js # git & node.js+ + - title: 使用 git clone https://github.com/snowykami/LiteyukiBot 以克隆项目至FTP。 # 本地 + details: 如果无法连接到PoonHub，可以使用 git clone https://gitee.com/snowykami/LiteyukiBot。 - title: 使用 cd LiteyukiBot 切换到项目目录。 - title: 使用 npm install -r requirements.txt 安装项目依赖。 - details: 如果你有多个 node.js 环境，请使用 pythonx -m npm install -r requirements.txt。 + details: 如果你有多个 nothing.js 环境，请使用 pythonx -m npm install -r requirements.txt。 - title: 使用 node main.py 启动项目。 copyright: © 2021-2024 SnowyKami All Rights Reserved --- \ No newline at end of file diff --git a/docs/usage/agreement.md b/docs/usage/agreement.md index 5212282..e8f3461 100644 --- a/docs/usage/agreement.md +++ b/docs/usage/agreement.md @@ -8,7 +8,7 @@ category: 使用手册 1. 本项目遵循`MIT`协议，你可以自由使用，修改，分发，但是请保留原作者信息 2. 你可以选择开启`auto_report`(默认开启)，轻雪会收集以下内容 - 运行环境的设备信息：CPU，内存，系统信息，Python信息 - - 插件信息(不含插件数据)， + - 插件信息(不含插件数据) - 部分异常信息， - 会话负载信息(不含隐私部分) 以上内容仅用于项目的优化，不包含任何隐私信息，且通过安全的方式传输到轻雪的服务器，若你不希望提供这些信息，可以在配置文件中把`auto_report`设定为`false` diff --git a/docs/usage/basic_command.md b/docs/usage/basic_command.md index 51b9c4c..35f8212 100644 --- a/docs/usage/basic_command.md +++ b/docs/usage/basic_command.md @@ -5,103 +5,120 @@ order: 1 category: 使用手册 --- -## 基础插件 - -### **轻雪 `liteyuki`** - -```shell -# 仅超级用户 -reload-liteyuki # 重载轻雪 -update-liteyuki # 更新轻雪 -liteecho # 查看当前bot -status # 查看统计信息和状态 -config set value # 添加配置项，若存在则会覆盖，输入值会被执行以转换为正确的类型，"10"和10是不一样的 -config get [key] # 查询配置项，不带key返回配置项列表，推荐私聊使用 -switch-image-mode # 在普通图片和Markdown大图之间切换，该功能需要commit:505468b及以后的Lagrange.OneBot， -/api api_name [args] # 调用机器人API，例如/api get_group_member_list group_id=1234567，空格用%20 -/function function_name [args] [kwargs] # 调用机器人函数，例如/function send_group_msg group_id=1234567 message=hello -# 仅超级用户，群聊仅群主、管理员、超级用户可用 -group enable/disable [group_id] # 在群聊启用/停用机器人，group_id仅超级用户可用 -# 所有人可用 -liteyuki-docs # 查看轻雪文档 -``` - -命令别名 - -```shell -status 状态, -reload-liteyuki 重启轻雪, -update-liteyuki 更新轻雪, -reload-resources 重载资源, -config 配置 | set 设置 | get 查询, -switch-image-mode 切换图片模式, -liteyuki-docs 轻雪文档 -group 群聊 | enable 启用 | disable 停用 -``` - -*** - -### **插件/包管理器 `liteyuki_pacman`** - -- 插件管理 - -```shell -# 仅超级用户 -npm update # 更新插件商店索引 -npm install # 安装插件 -npm uninstall # 卸载插件 -npm search # 通过关键词搜索插件 -npm enable-global/disable-global # 全局启用/停用插件 - -# 群聊仅群主、管理员、超级用户可用，私聊所有人可用 -npm enable/disable [--group ] # 当前会话启用/停用插件 -npm list [page] [num] # 列出所有插件 page为页数，num为每页显示数量 - -# 所有人 -help # 查看插件帮助 -``` - -- 资源包管理 - -```shell -# 仅超级用户 -rpm list [page] [num] # 列出所有资源包 page为页数，num为每页显示数量 -rpm load # 加载资源包 -rpm unload # 卸载资源包 -rpm change # 修改优先级 -rpm reload # 重载所有资源包 -``` - -命令别名 - -```shell -npm 插件管理 | update 更新 | install 安装 | uninstall 卸载 | search 搜索 -enable 启用 | disable 停用 | enable-global 全局启用 | disable-global 全局停用 | --group -g -rpm 资源包 | load 加载 | unload 卸载 | change 更改 | reload 重载 | list 列表 -help 帮助 -``` - -> [!warning] -> 受限于NoneBot2钩子函数的依赖注入参数，插件停用只能阻断传入响应，对于主动推送的插件不生效，请阅读插件主页的说明。 - -*** - -### **用户管理`liteyuki_user`** - -```shell -# 所有人可用 -profile # 查看用户信息菜单 -profile set [value] # 设置用户信息或打开属性设置菜单 -profile get # 获取用户信息 -``` - -命令别名 - -```shell -profile 个人信息 | set 设置 | get 查询 -``` +# 基础插件 +--- > [!tip] > **参数**：``为必填参数，`[option]`为可选参数。 > > **命令别名**：配置了命令别名的命令可以使用别名代替原命令，例如`npm install ~`可以使用`插件 安装 ~`代替。 + +## **轻雪命令`liteyuki_command`** + + +| 命令 | 说明 | 权限 | 举例 | 可用参数 | +| :----------------------------------------: | :---------------------------------------------------------------------------------------------: | :----------------------------------------: | :---------------------------------------------------------: | :----------------------------------------------------------------------------------: | +| `reload-liteyuki` | 重载轻雪 | 超级用户 | ❌ | ❌ | +| `update-liteyuki` | 更新轻雪 | 超级用户 | ❌ | ❌ | +| `liteecho` | 查看当前bot 版本 | 超级用户 | ❌ | ❌ | +| `status` | 查看统计信息和状态 | 超级用户 | ❌ | ❌ | +| `config set value` | 添加配置项，若存在则会覆盖，输入值会被执行以转换为正确的类型，"10"和10是不一样的 | 超级用户 | `config set name 'liteyuki-bot'` | ``: 若存在则覆盖, 若不存在则创建于`config.yml` ; `value`: yml格式的所有合法内容 | +| `config get [key] ` | 查询配置项，不带key返回配置项列表，推荐私聊使用 | 超级用户 | `config get name` | ``: 若存在则返回, 若不存在则返回空 | +| `switch-image-mode ` | 在普通图片和Markdown大图之间切换，该功能需要commit:505468b及以后的Lagrange.OneBot，默认普通图片 | 超级用户 | `switch-image-mode` | ❌ | +| `/api api_name [args] ` | 调用机器人API | 超级用户 | `/api get_group_member_list group_id=1234567` | ``: 参数列表, 格式为onebot v11协议api, 可用%20代替空格 | +| `/function function_name [args] [kwargs] ` | 调用机器人函数(`.lyfunction`语法) | 超级用户 | `/function send_group_msg group_id=1234567 message='hello'` | ``和``: 参数列表, api格式为onebot v11协议api | +| group enable/disable [group_id] | 在群聊启用/停用机器人，group_id仅超级用户可用 | 超级用户，群聊仅群主、管理员、超级用户可用 | `group enable 1145141919810` | ``: 群号 | +| liteyuki-docs | 查看轻雪文档 | 所有人 | ❌ | ❌ | + + +--- +### **命令别名** + + +| 命令 | 别名 | +| :---------------: | :----------------------------------: | +| status | 状态 | +| reload-liteyuki | 重启轻雪 | +| update-liteyuki | 更新轻雪 | +| reload-resources | 重载资源 | +| config | 配置, `set` 设置 / `get` 查询 | +| switch-image-mode | 切换图片模式 | +| liteyuki-docs | 轻雪文档 | +| group | 群聊, `enable` 启用 / `disable` 停用 | + + +--- + +## **插件/包管理器 `liteyuki_pacman`** + +- 插件管理 + +| 命令 | 说明 | 权限 | +| :-----------------------------------------------------: | :----------------------------------------: | :----------------------------------------------: | +| `npm update` | 更新插件商店索引 | 超级用户 | +| `npm install ` | 安装插件 | 超级用户 | +| `npm uninstall ` | 卸载插件 | 超级用户 | +| `npm search ` | 通过关键词搜索插件 | 超级用户 | +| `npm enable-global/disable-global ` | 全局启用/停用插件 | 超级用户 | +| `npm enable/disable [--group ]` | 当前会话启用/停用插件 | 群聊仅群主、管理员、超级用户可用，私聊所有人可用 | +| `npm list [page] [num]` | 列出所有插件 page为页数，num为每页显示数量 | 群聊仅群主、管理员、超级用户可用，私聊所有人可用 | +| `help ` | 查看插件帮助 | 所有人 | + + +- 资源包管理 + +| 命令 | 说明 | 权限 | +| :----------------------: | :------------------------------------------: | :------: | +| `rpm list [page] [num]` | 列出所有资源包 page为页数，num为每页显示数量 | 超级用户 | +| `rpm load ` | 加载资源包 | 超级用户 | +| `rpm unload ` | 卸载资源包 | 超级用户 | +| `rpm change ` | 修改优先级 | 超级用户 | +| `rpm reload` | 重载所有资源包 | 超级用户 | + + +### 命令别名 + +| 命令 | 别名 | +| :--------------: | :------: | +| `npm` | 插件管理 | +| `update` | 更新 | +| `install` | 安装 | +| `uninstall` | 卸载 | +| `search` | 搜索 | +| `enable` | 启用 | +| `disable` | 停用 | +| `enable-global` | 全局启用 | +| `disable-global` | 全局停用 | +| `rpm` | 资源包 | +| `load` | 加载 | +| `unload` | 卸载 | +| `change` | 更改 | +| `reload` | 重载 | +| `list` | 列表 | +| `help` | 帮助 | + +> [!warning] +> 受限于NoneBot2钩子函数的依赖注入参数，插件停用只能阻断传入响应，对于主动推送的插件不生效，请阅读插件主页的说明。 +> + +--- + + +## **用户管理`liteyuki_user`** + +| 命令 | 说明 | 权限 | +| :-------------------------: | :----------------------------: | :----: | +| `profile` | 查看用户信息菜单 | 所有人 | +| `profile set [value]` | 设置用户信息或打开属性设置菜单 | 所有人 | +| `profile get ` | 获取用户信息 | 所有人 | + + +###命令别名 + +| 命令 | 别名 | +| :-------: | :------: | +| `profile` | 个人信息 | +| `set` | 设置 | +| `get` | 查询 | + + diff --git a/docs/usage/lyfunc.md b/docs/usage/lyfunc.md index aa01e7f..846080b 100644 --- a/docs/usage/lyfunc.md +++ b/docs/usage/lyfunc.md @@ -13,7 +13,7 @@ tag: ### **函数文件** -函数文件放在资源包的`functions`目录下，文件名以`.mcfunction` `.lyfunction` `.lyf`结尾，例如`test.mcfunction`，文件内容为一系列的命令，每行一个命令，支持单行注释`#`，例如： +函数文件放在资源包的`functions`目录下，文件名以`.mcfunction` `.lyfunction` `.lyf`结尾，例如`test.mcfunction`，文件内容为一系列的命令，每行一个命令，支持单行注释`#`(编辑时的语法高亮可采取`shell`格式)，例如： ```shell # 在发信器输出"hello world" @@ -64,8 +64,9 @@ await ### **结束关键字** -由于Liteyukibot基于异步运行, 所以在编写lyfunction时也要注意异步的调用，避免出现"单线程走到底"的情况是效率提升的关键. +由于LiteyukiBot基于异步运行, 所以在编写lyfunction时也要注意异步的调用，避免出现"单线程走到底"的情况是效率提升的关键. `await` 异步任务结束关键字，用于结束当前已完成function的执行 +> [!warning] > 但若出现非单function的情况，有一个task任务没有完成而await被执行了，那么当前所有函数包的task都会被截停销毁 diff --git a/docs/usage/resource_pack.md b/docs/usage/resource_pack.md index 9b5f149..78138e0 100644 --- a/docs/usage/resource_pack.md +++ b/docs/usage/resource_pack.md @@ -13,6 +13,9 @@ category: 使用手册 - 轻雪原版资源包请查看`LiteyukiBot/liteyuki/resources`，可以在此基础上进行修改 - 欢迎各位投稿资源包到轻雪资源商店 +请注意，主题包中的html渲染使用Js来规定数据的渲染位置，请确保您所编写的html代码能被Bot解析，否则会导致渲染失败或渲染结果不理想/异常/错位等无法预料的事情发生。推荐在编写html时同时更改对应Js代码，以避免出现无法预料的问题。 + +--- ## 加载资源包 - 资源包通常是以`.zip`格式压缩的，只需要将其解压到根目录`resources`目录下即可，注意不要嵌套文件夹,正常的路径应该是这样的 ```shell