Docs 主要更新: 优化表格

主要改动:
- 表格
- 标点符号
- 愚人节主页
This commit is contained in:
Nanaloveyuki 2024-06-16 23:33:58 +08:00
parent 8ac53970a3
commit 570d7e18a4
6 changed files with 138 additions and 116 deletions

View File

@ -58,7 +58,7 @@ highlights:
details: 无需繁琐前期过程,开箱即用 details: 无需繁琐前期过程,开箱即用
link: https://bot.liteyuki.icu/deployment/config.html link: https://bot.liteyuki.icu/deployment/config.html
- title: 高性能 - title: 高性能
icon: tachometer-alt icon: tachometer-alt
details: 500个插件3s内启动 details: 500个插件3s内启动
@ -66,7 +66,7 @@ highlights:
icon: cloud-download icon: cloud-download
details: 让你的机器人保持最新提交 details: 让你的机器人保持最新提交
- title: 开源 - title: 开源项目
icon: code icon: code
details: 项目遵循MIT协议开源欢迎各位的贡献 details: 项目遵循MIT协议开源欢迎各位的贡献

View File

@ -2,14 +2,15 @@
home: true home: true
icon: home icon: home
title: 首页 title: 首页
heroImage: https://cdn.liteyuki.icu/static/img/logo.png heroImage: https://cdn.liteyuki.icu/static/img/lykwi.png
bgImage: bgImage:
bgImageDark: bgImageDark:
bgImageStyle: bgImageStyle:
background-attachment: fixed background-attachment: fixed
heroText: HeavyyukiBot666 # LiteyukiBot 6 heroText: HeavylavaBot666 # LiteyukiBot 6
tagline: 重雪机器人一个以笨重和复杂为设计理念基于Koishi114514的OneBotv1919810标准聊天机器人可用于雪地清扫使用Typethon编写 tagline: 重浆机器人一个以笨重和复杂为设计理念基于Koishi114514的TwoBotv1919810标准聊天机器人可用于雪地清扫使用Typethon编写
#tagline: 轻雪机器人一个以轻量和简洁为设计理念基于Nonebot2的OneBot标准聊天机器人 #tagline: 轻雪机器人一个以轻量和简洁为设计理念基于Nonebot2的OneBot标准聊天机器人
# 泰普森(X
actions: actions:
- text: 快速结束 # 快速开始 - text: 快速结束 # 快速开始
@ -39,22 +40,22 @@ highlights:
features: features:
- title: 基于Koishi.js233 - title: 基于Koishi.js233
icon: robot icon: robot
details: 拥有良好的生态支持 details: 拥有辣鸡的生态支持
link: https://nonebot.dev/ link: https://nonebot.dev/
- title: 盲目插件管理 - title: 盲目插件管理
icon: plug icon: plug
details: 基于nbshi使用<code>npmx和pip</code>,让你无法安装/卸载插件 details: 基于nbshi使用<code>xmpn和bib</code>,让你无法安装/卸载插件
- title: 点击无法交互 - title: 纯命令行
icon: mouse-pointer icon: mouse-pointer
details: 老的的点击交互模式,必须手打指令 details: 老的掉牙的交互模式,必须手打指令
- title: 猪蹄支持 - title: 猪蹄支持
icon: paint-brush icon: paint-brush
details: 支持多种主题,可自定义资源包,满足你的审美需求 details: 支持多种烤猪蹄样式,丢弃烤箱,拥抱烧烤架,满足你的干饭需求
- title: 国际化 - title: 国际化
icon: globe icon: globe
details: 支持多种语言包括i18n部分语言和自行扩展的语言代码 details: 支持多种语言包括i18n部分语言和自行扩展的语言代码
link: https://baike.baidu.com/item/i18n/6771940 link: https://baike.baidu.com/item/i18n/6771940
@ -80,27 +81,27 @@ highlights:
- title: 不准更新 - title: 不准更新
icon: cloud-download icon: cloud-download
details: 要更新自己新版本去 details: 要更新自己新版本去
- title: 服务支持 - title: 服务支持
icon: server icon: server
details: 内置轻雪API但随时可能跑路 details: 内置重浆API但随时可能提桶跑路
- title: 闭源 - title: 闭源
icon: code icon: code
details: 要源代码自己逆向去 details: 要源代码自己逆向去
- header: 快速部署 - header: 慢速部署 # 快速部署
image: /assets/image/box.svg image: /assets/image/box.svg
bgImage: https://theme-hope-assets.vuejs.press/bg/3-light.svg bgImage: https://theme-hope-assets.vuejs.press/bg/3-light.svg
bgImageDark: https://theme-hope-assets.vuejs.press/bg/3-dark.svg bgImageDark: https://theme-hope-assets.vuejs.press/bg/3-dark.svg
highlights: highlights:
- title: 安装 Git 和 node.js+ - title: 安装 winget 和 nothing.js # git & node.js+
- title: 使用 <code>git clone https://github.com/snowykami/LiteyukiBot</code> 以克隆项目至本地 - title: 使用 <code>git clone https://github.com/snowykami/LiteyukiBot</code> 以克隆项目至FTP。 # 本地
details: 如果无法连接到GitHub可以使用 <code>git clone https://gitee.com/snowykami/LiteyukiBot</code> details: 如果无法连接到PoonHub可以使用 <code>git clone https://gitee.com/snowykami/LiteyukiBot</code>
- title: 使用 <code>cd LiteyukiBot</code> 切换到项目目录。 - title: 使用 <code>cd LiteyukiBot</code> 切换到项目目录。
- title: 使用 <code>npm install -r requirements.txt</code> 安装项目依赖。 - title: 使用 <code>npm install -r requirements.txt</code> 安装项目依赖。
details: 如果你有多个 node.js 环境,请使用 <code>pythonx -m npm install -r requirements.txt</code> details: 如果你有多个 nothing.js 环境,请使用 <code>pythonx -m npm install -r requirements.txt</code>
- title: 使用 <code>node main.py</code> 启动项目。 - title: 使用 <code>node main.py</code> 启动项目。
copyright: © 2021-2024 SnowyKami All Rights Reserved copyright: © 2021-2024 SnowyKami All Rights Reserved
--- ---

View File

@ -8,7 +8,7 @@ category: 使用手册
1. 本项目遵循`MIT`协议,你可以自由使用,修改,分发,但是请保留原作者信息 1. 本项目遵循`MIT`协议,你可以自由使用,修改,分发,但是请保留原作者信息
2. 你可以选择开启`auto_report`(默认开启),轻雪会收集以下内容 2. 你可以选择开启`auto_report`(默认开启),轻雪会收集以下内容
- 运行环境的设备信息CPU内存系统信息Python信息 - 运行环境的设备信息CPU内存系统信息Python信息
- 插件信息(不含插件数据) - 插件信息(不含插件数据)
- 部分异常信息, - 部分异常信息,
- 会话负载信息(不含隐私部分) - 会话负载信息(不含隐私部分)
以上内容仅用于项目的优化,不包含任何隐私信息,且通过安全的方式传输到轻雪的服务器,若你不希望提供这些信息,可以在配置文件中把`auto_report`设定为`false` 以上内容仅用于项目的优化,不包含任何隐私信息,且通过安全的方式传输到轻雪的服务器,若你不希望提供这些信息,可以在配置文件中把`auto_report`设定为`false`

View File

@ -5,103 +5,120 @@ order: 1
category: 使用手册 category: 使用手册
--- ---
## 基础插件 # 基础插件
---
### **轻雪 `liteyuki`**
```shell
# 仅超级用户
reload-liteyuki # 重载轻雪
update-liteyuki # 更新轻雪
liteecho # 查看当前bot
status # 查看统计信息和状态
config set <key> 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 <plugin_name> # 安装插件
npm uninstall <plugin_name> # 卸载插件
npm search <keywords...> # 通过关键词搜索插件
npm enable-global/disable-global <plugin_name> # 全局启用/停用插件
# 群聊仅群主、管理员、超级用户可用,私聊所有人可用
npm enable/disable <plugin_name> [--group <group_id>] # 当前会话启用/停用插件
npm list [page] [num] # 列出所有插件 page为页数num为每页显示数量
# 所有人
help <plugin_name> # 查看插件帮助
```
- 资源包管理
```shell
# 仅超级用户
rpm list [page] [num] # 列出所有资源包 page为页数num为每页显示数量
rpm load <pack_name> # 加载资源包
rpm unload <pack_name> # 卸载资源包
rpm change <pack_name> # 修改优先级
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 <key> [value] # 设置用户信息或打开属性设置菜单
profile get <key> # 获取用户信息
```
命令别名
```shell
profile 个人信息 | set 设置 | get 查询
```
> [!tip] > [!tip]
> **参数**`<param>`为必填参数,`[option]`为可选参数。 > **参数**`<param>`为必填参数,`[option]`为可选参数。
> >
> **命令别名**:配置了命令别名的命令可以使用别名代替原命令,例如`npm install ~`可以使用`插件 安装 ~`代替。 > **命令别名**:配置了命令别名的命令可以使用别名代替原命令,例如`npm install ~`可以使用`插件 安装 ~`代替。
## **轻雪命令`liteyuki_command`**
| 命令 | 说明 | 权限 | 举例 | 可用参数 |
| :----------------------------------------: | :---------------------------------------------------------------------------------------------: | :----------------------------------------: | :---------------------------------------------------------: | :----------------------------------------------------------------------------------: |
| `reload-liteyuki` | 重载轻雪 | 超级用户 | ❌ | ❌ |
| `update-liteyuki` | 更新轻雪 | 超级用户 | ❌ | ❌ |
| `liteecho` | 查看当前bot 版本 | 超级用户 | ❌ | ❌ |
| `status` | 查看统计信息和状态 | 超级用户 | ❌ | ❌ |
| `config set <key> value` | 添加配置项,若存在则会覆盖,输入值会被执行以转换为正确的类型,"10"和10是不一样的 | 超级用户 | `config set name 'liteyuki-bot'` | `<key>`: 若存在则覆盖, 若不存在则创建于`config.yml` ; `value`: yml格式的所有合法内容 |
| `config get [key] ` | 查询配置项不带key返回配置项列表推荐私聊使用 | 超级用户 | `config get name` | `<key>`: 若存在则返回, 若不存在则返回空 |
| `switch-image-mode ` | 在普通图片和Markdown大图之间切换该功能需要commit:505468b及以后的Lagrange.OneBot默认普通图片 | 超级用户 | `switch-image-mode` | ❌ |
| `/api api_name [args] ` | 调用机器人API | 超级用户 | `/api get_group_member_list group_id=1234567` | `<args>`: 参数列表, 格式为onebot v11协议api, 可用%20代替空格 |
| `/function function_name [args] [kwargs] ` | 调用机器人函数(`.lyfunction`语法) | 超级用户 | `/function send_group_msg group_id=1234567 message='hello'` | `<args>`和`<kwargs>`: 参数列表, api格式为onebot v11协议api |
| group enable/disable [group_id] | 在群聊启用/停用机器人group_id仅超级用户可用 | 超级用户,群聊仅群主、管理员、超级用户可用 | `group enable 1145141919810` | `<group_id>`: 群号 |
| 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 <plugin_name>` | 安装插件 | 超级用户 |
| `npm uninstall <plugin_name>` | 卸载插件 | 超级用户 |
| `npm search <keywords...>` | 通过关键词搜索插件 | 超级用户 |
| `npm enable-global/disable-global <plugin_name>` | 全局启用/停用插件 | 超级用户 |
| `npm enable/disable <plugin_name> [--group <group_id>]` | 当前会话启用/停用插件 | 群聊仅群主、管理员、超级用户可用,私聊所有人可用 |
| `npm list [page] [num]` | 列出所有插件 page为页数num为每页显示数量 | 群聊仅群主、管理员、超级用户可用,私聊所有人可用 |
| `help <plugin_name>` | 查看插件帮助 | 所有人 |
- 资源包管理
| 命令 | 说明 | 权限 |
| :----------------------: | :------------------------------------------: | :------: |
| `rpm list [page] [num]` | 列出所有资源包 page为页数num为每页显示数量 | 超级用户 |
| `rpm load <pack_name>` | 加载资源包 | 超级用户 |
| `rpm unload <pack_name>` | 卸载资源包 | 超级用户 |
| `rpm change <pack_name>` | 修改优先级 | 超级用户 |
| `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 <key> [value]` | 设置用户信息或打开属性设置菜单 | 所有人 |
| `profile get <key>` | 获取用户信息 | 所有人 |
###命令别名
| 命令 | 别名 |
| :-------: | :------: |
| `profile` | 个人信息 |
| `set` | 设置 |
| `get` | 查询 |

View File

@ -13,7 +13,7 @@ tag:
### **函数文件** ### **函数文件**
函数文件放在资源包的`functions`目录下,文件名以`.mcfunction` `.lyfunction` `.lyf`结尾,例如`test.mcfunction`,文件内容为一系列的命令,每行一个命令,支持单行注释`#`,例如: 函数文件放在资源包的`functions`目录下,文件名以`.mcfunction` `.lyfunction` `.lyf`结尾,例如`test.mcfunction`,文件内容为一系列的命令,每行一个命令,支持单行注释`#`(编辑时的语法高亮可采取`shell`格式),例如:
```shell ```shell
# 在发信器输出"hello world" # 在发信器输出"hello world"
@ -64,8 +64,9 @@ await
### **结束关键字** ### **结束关键字**
由于Liteyukibot基于异步运行, 所以在编写lyfunction时也要注意异步的调用避免出现"单线程走到底"的情况是效率提升的关键. 由于LiteyukiBot基于异步运行, 所以在编写lyfunction时也要注意异步的调用避免出现"单线程走到底"的情况是效率提升的关键.
`await` 异步任务结束关键字用于结束当前已完成function的执行 `await` 异步任务结束关键字用于结束当前已完成function的执行
> [!warning]
> 但若出现非单function的情况有一个task任务没有完成而await被执行了那么当前所有函数包的task都会被截停销毁 > 但若出现非单function的情况有一个task任务没有完成而await被执行了那么当前所有函数包的task都会被截停销毁

View File

@ -13,6 +13,9 @@ category: 使用手册
- 轻雪原版资源包请查看`LiteyukiBot/liteyuki/resources`,可以在此基础上进行修改 - 轻雪原版资源包请查看`LiteyukiBot/liteyuki/resources`,可以在此基础上进行修改
- 欢迎各位投稿资源包到轻雪资源商店 - 欢迎各位投稿资源包到轻雪资源商店
请注意主题包中的html渲染使用Js来规定数据的渲染位置请确保您所编写的html代码能被Bot解析否则会导致渲染失败或渲染结果不理想/异常/错位等无法预料的事情发生。推荐在编写html时同时更改对应Js代码以避免出现无法预料的问题。
---
## 加载资源包 ## 加载资源包
- 资源包通常是以`.zip`格式压缩的,只需要将其解压到根目录`resources`目录下即可,注意不要嵌套文件夹,正常的路径应该是这样的 - 资源包通常是以`.zip`格式压缩的,只需要将其解压到根目录`resources`目录下即可,注意不要嵌套文件夹,正常的路径应该是这样的
```shell ```shell