forked from LiteyukiStudio/LiteyukiBot
2 lines
16 KiB
JavaScript
2 lines
16 KiB
JavaScript
import{_ as t,o as e,c as d,e as l}from"./app-Dylq0aUl.js";const n={},a=l('<h1 id="基础插件" tabindex="-1"><a class="header-anchor" href="#基础插件"><span>基础插件</span></a></h1><hr><div class="hint-container tip"><p class="hint-container-title">提示</p><p><strong>参数</strong>：<code><param></code>为必填参数，<code>[option]</code>为可选参数。</p><p><strong>命令别名</strong>：配置了命令别名的命令可以使用别名代替原命令，例如<code>npm install ~</code>可以使用<code>插件 安装 ~</code>代替。</p></div><h2 id="轻雪命令liteyuki-command" tabindex="-1"><a class="header-anchor" href="#轻雪命令liteyuki-command"><span><strong>轻雪命令<code>liteyuki_command</code></strong></span></a></h2><table><thead><tr><th style="text-align:center;">命令</th><th style="text-align:center;">说明</th><th style="text-align:center;">权限</th><th style="text-align:center;">举例</th><th style="text-align:center;">可用参数</th></tr></thead><tbody><tr><td style="text-align:center;"><code>reload-liteyuki</code></td><td style="text-align:center;">重载轻雪</td><td style="text-align:center;">超级用户</td><td style="text-align:center;">❌</td><td style="text-align:center;">❌</td></tr><tr><td style="text-align:center;"><code>update-liteyuki</code></td><td style="text-align:center;">更新轻雪</td><td style="text-align:center;">超级用户</td><td style="text-align:center;">❌</td><td style="text-align:center;">❌</td></tr><tr><td style="text-align:center;"><code>liteecho</code></td><td style="text-align:center;">查看当前bot 版本</td><td style="text-align:center;">超级用户</td><td style="text-align:center;">❌</td><td style="text-align:center;">❌</td></tr><tr><td style="text-align:center;"><code>status</code></td><td style="text-align:center;">查看统计信息和状态</td><td style="text-align:center;">超级用户</td><td style="text-align:center;">❌</td><td style="text-align:center;">❌</td></tr><tr><td style="text-align:center;"><code>config set <key> value</code></td><td style="text-align:center;">添加配置项，若存在则会覆盖，输入值会被执行以转换为正确的类型，"10"和10是不一样的</td><td style="text-align:center;">超级用户</td><td style="text-align:center;"><code>config set name 'liteyuki-bot'</code></td><td style="text-align:center;"><code><key></code>: 若存在则覆盖, 若不存在则创建于<code>config.yml</code> ; <code>value</code>: yml格式的所有合法内容</td></tr><tr><td style="text-align:center;"><code>config get [key] </code></td><td style="text-align:center;">查询配置项，不带key返回配置项列表，推荐私聊使用</td><td style="text-align:center;">超级用户</td><td style="text-align:center;"><code>config get name</code></td><td style="text-align:center;"><code><key></code>: 若存在则返回, 若不存在则返回空</td></tr><tr><td style="text-align:center;"><code>switch-image-mode </code></td><td style="text-align:center;">在普通图片和Markdown大图之间切换，该功能需要commit:505468b及以后的Lagrange.OneBot，默认普通图片</td><td style="text-align:center;">超级用户</td><td style="text-align:center;"><code>switch-image-mode</code></td><td style="text-align:center;">❌</td></tr><tr><td style="text-align:center;"><code>/api api_name [args] </code></td><td style="text-align:center;">调用机器人API</td><td style="text-align:center;">超级用户</td><td style="text-align:center;"><code>/api get_group_member_list group_id=1234567</code></td><td style="text-align:center;"><code><args></code>: 参数列表, 格式为onebot v11协议api, 可用%20代替空格</td></tr><tr><td style="text-align:center;"><code>/function function_name [args] [kwargs] </code></td><td style="text-align:center;">调用机器人函数(<code>.lyfunction</code>语法)</td><td style="text-align:center;">超级用户</td><td style="text-align:center;"><code>/function send_group_msg group_id=1234567 message='hello'</code></td><td style="text-align:center;"><code><args></code>和<code><kwargs></code>: 参数列表, api格式为onebot v11协议api</td></tr><tr><td style="text-align:center;">group enable/disable [group_id]</td><td style="text-align:center;">在群聊启用/停用机器人，group_id仅超级用户可用</td><td style="text-align:center;">超级用户，群聊仅群主、管理员、超级用户可用</td><td style="text-align:center;"><code>group enable 1145141919810</code></td><td style="text-align:center;"><code><group_id></code>: 群号</td></tr><tr><td style="text-align:center;">liteyuki-docs</td><td style="text-align:center;">查看轻雪文档</td><td style="text-align:center;">所有人</td><td style="text-align:center;">❌</td><td style="text-align:center;">❌</td></tr></tbody></table><hr><h3 id="命令别名" tabindex="-1"><a class="header-anchor" href="#命令别名"><span><strong>命令别名</strong></span></a></h3><table><thead><tr><th style="text-align:center;">命令</th><th style="text-align:center;">别名</th></tr></thead><tbody><tr><td style="text-align:center;">status</td><td style="text-align:center;">状态</td></tr><tr><td style="text-align:center;">reload-liteyuki</td><td style="text-align:center;">重启轻雪</td></tr><tr><td style="text-align:center;">update-liteyuki</td><td style="text-align:center;">更新轻雪</td></tr><tr><td style="text-align:center;">reload-resources</td><td style="text-align:center;">重载资源</td></tr><tr><td style="text-align:center;">config</td><td style="text-align:center;">配置, <code>set</code> 设置 / <code>get</code> 查询</td></tr><tr><td style="text-align:center;">switch-image-mode</td><td style="text-align:center;">切换图片模式</td></tr><tr><td style="text-align:center;">liteyuki-docs</td><td style="text-align:center;">轻雪文档</td></tr><tr><td style="text-align:center;">group</td><td style="text-align:center;">群聊, <code>enable</code> 启用 / <code>disable</code> 停用</td></tr></tbody></table><hr><h2 id="插件-包管理器-liteyuki-pacman" tabindex="-1"><a class="header-anchor" href="#插件-包管理器-liteyuki-pacman"><span><strong>插件/包管理器 <code>liteyuki_pacman</code></strong></span></a></h2><ul><li>插件管理</li></ul><table><thead><tr><th style="text-align:center;">命令</th><th style="text-align:center;">说明</th><th style="text-align:center;">权限</th></tr></thead><tbody><tr><td style="text-align:center;"><code>npm update</code></td><td style="text-align:center;">更新插件商店索引</td><td style="text-align:center;">超级用户</td></tr><tr><td style="text-align:center;"><code>npm install <plugin_name></code></td><td style="text-align:center;">安装插件</td><td style="text-align:center;">超级用户</td></tr><tr><td style="text-align:center;"><code>npm uninstall <plugin_name></code></td><td style="text-align:center;">卸载插件</td><td style="text-align:center;">超级用户</td></tr><tr><td style="text-align:center;"><code>npm search <keywords...></code></td><td style="text-align:center;">通过关键词搜索插件</td><td style="text-align:center;">超级用户</td></tr><tr><td style="text-align:center;"><code>npm enable-global/disable-global <plugin_name></code></td><td style="text-align:center;">全局启用/停用插件</td><td style="text-align:center;">超级用户</td></tr><tr><td style="text-align:center;"><code>npm enable/disable <plugin_name> [--group <group_id>]</code></td><td style="text-align:center;">当前会话启用/停用插件</td><td style="text-align:center;">群聊仅群主、管理员、超级用户可用，私聊所有人可用</td></tr><tr><td style="text-align:center;"><code>npm list [page] [num]</code></td><td style="text-align:center;">列出所有插件 page为页数，num为每页显示数量</td><td style="text-align:center;">群聊仅群主、管理员、超级用户可用，私聊所有人可用</td></tr><tr><td style="text-align:center;"><code>help <plugin_name></code></td><td style="text-align:center;">查看插件帮助</td><td style="text-align:center;">所有人</td></tr></tbody></table><ul><li>资源包管理</li></ul><table><thead><tr><th style="text-align:center;">命令</th><th style="text-align:center;">说明</th><th style="text-align:center;">权限</th></tr></thead><tbody><tr><td style="text-align:center;"><code>rpm list [page] [num]</code></td><td style="text-align:center;">列出所有资源包 page为页数，num为每页显示数量</td><td style="text-align:center;">超级用户</td></tr><tr><td style="text-align:center;"><code>rpm load <pack_name></code></td><td style="text-align:center;">加载资源包</td><td style="text-align:center;">超级用户</td></tr><tr><td style="text-align:center;"><code>rpm unload <pack_name></code></td><td style="text-align:center;">卸载资源包</td><td style="text-align:center;">超级用户</td></tr><tr><td style="text-align:center;"><code>rpm change <pack_name></code></td><td style="text-align:center;">修改优先级</td><td style="text-align:center;">超级用户</td></tr><tr><td style="text-align:center;"><code>rpm reload</code></td><td style="text-align:center;">重载所有资源包</td><td style="text-align:center;">超级用户</td></tr></tbody></table><h3 id="命令别名-1" tabindex="-1"><a class="header-anchor" href="#命令别名-1"><span>命令别名</span></a></h3><table><thead><tr><th style="text-align:center;">命令</th><th style="text-align:center;">别名</th></tr></thead><tbody><tr><td style="text-align:center;"><code>npm</code></td><td style="text-align:center;">插件管理</td></tr><tr><td style="text-align:center;"><code>update</code></td><td style="text-align:center;">更新</td></tr><tr><td style="text-align:center;"><code>install</code></td><td style="text-align:center;">安装</td></tr><tr><td style="text-align:center;"><code>uninstall</code></td><td style="text-align:center;">卸载</td></tr><tr><td style="text-align:center;"><code>search</code></td><td style="text-align:center;">搜索</td></tr><tr><td style="text-align:center;"><code>enable</code></td><td style="text-align:center;">启用</td></tr><tr><td style="text-align:center;"><code>disable</code></td><td style="text-align:center;">停用</td></tr><tr><td style="text-align:center;"><code>enable-global</code></td><td style="text-align:center;">全局启用</td></tr><tr><td style="text-align:center;"><code>disable-global</code></td><td style="text-align:center;">全局停用</td></tr><tr><td style="text-align:center;"><code>rpm</code></td><td style="text-align:center;">资源包</td></tr><tr><td style="text-align:center;"><code>load</code></td><td style="text-align:center;">加载</td></tr><tr><td style="text-align:center;"><code>unload</code></td><td style="text-align:center;">卸载</td></tr><tr><td style="text-align:center;"><code>change</code></td><td style="text-align:center;">更改</td></tr><tr><td style="text-align:center;"><code>reload</code></td><td style="text-align:center;">重载</td></tr><tr><td style="text-align:center;"><code>list</code></td><td style="text-align:center;">列表</td></tr><tr><td style="text-align:center;"><code>help</code></td><td style="text-align:center;">帮助</td></tr></tbody></table><div class="hint-container warning"><p class="hint-container-title">注意</p><p>受限于NoneBot2钩子函数的依赖注入参数，插件停用只能阻断传入响应，对于主动推送的插件不生效，请阅读插件主页的说明。</p></div><hr><h2 id="用户管理liteyuki-user" tabindex="-1"><a class="header-anchor" href="#用户管理liteyuki-user"><span><strong>用户管理<code>liteyuki_user</code></strong></span></a></h2><table><thead><tr><th style="text-align:center;">命令</th><th style="text-align:center;">说明</th><th style="text-align:center;">权限</th></tr></thead><tbody><tr><td style="text-align:center;"><code>profile</code></td><td style="text-align:center;">查看用户信息菜单</td><td style="text-align:center;">所有人</td></tr><tr><td style="text-align:center;"><code>profile set <key> [value]</code></td><td style="text-align:center;">设置用户信息或打开属性设置菜单</td><td style="text-align:center;">所有人</td></tr><tr><td style="text-align:center;"><code>profile get <key></code></td><td style="text-align:center;">获取用户信息</td><td style="text-align:center;">所有人</td></tr></tbody></table><p>###命令别名</p><table><thead><tr><th style="text-align:center;">命令</th><th style="text-align:center;">别名</th></tr></thead><tbody><tr><td style="text-align:center;"><code>profile</code></td><td style="text-align:center;">个人信息</td></tr><tr><td style="text-align:center;"><code>set</code></td><td style="text-align:center;">设置</td></tr><tr><td style="text-align:center;"><code>get</code></td><td style="text-align:center;">查询</td></tr></tbody></table>',22),r=[a];function c(i,o){return e(),d("div",null,r)}const g=t(n,[["render",c],["__file","basic_command.html.vue"]]),y=JSON.parse('{"path":"/usage/basic_command.html","title":"基础命令","lang":"zh-CN","frontmatter":{"title":"基础命令","icon":"comment","order":1,"category":"使用手册","description":"基础插件 提示 参数：<param>为必填参数，[option]为可选参数。 命令别名：配置了命令别名的命令可以使用别名代替原命令，例如npm install ~可以使用插件 安装 ~代替。 轻雪命令liteyuki_command 命令别名 插件/包管理器 liteyuki_pacman 插件管理 资源包管理 命令别名 注意 受限于NoneBot2钩...","head":[["meta",{"property":"og:url","content":"https://vuepress-theme-hope-docs-demo.netlify.app/usage/basic_command.html"}],["meta",{"property":"og:site_name","content":"LiteyukiBot 轻雪机器人"}],["meta",{"property":"og:title","content":"基础命令"}],["meta",{"property":"og:description","content":"基础插件 提示 参数：<param>为必填参数，[option]为可选参数。 命令别名：配置了命令别名的命令可以使用别名代替原命令，例如npm install ~可以使用插件 安装 ~代替。 轻雪命令liteyuki_command 命令别名 插件/包管理器 liteyuki_pacman 插件管理 资源包管理 命令别名 注意 受限于NoneBot2钩..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2024-06-16T15:33:58.000Z"}],["meta",{"property":"article:author","content":"远野千束"}],["meta",{"property":"article:modified_time","content":"2024-06-16T15:33:58.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"基础命令\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2024-06-16T15:33:58.000Z\\",\\"author\\":[{\\"@type\\":\\"Person\\",\\"name\\":\\"远野千束\\",\\"url\\":\\"https://sfkm.me\\"}]}"]]},"headers":[{"level":2,"title":"轻雪命令liteyuki_command","slug":"轻雪命令liteyuki-command","link":"#轻雪命令liteyuki-command","children":[{"level":3,"title":"命令别名","slug":"命令别名","link":"#命令别名","children":[]}]},{"level":2,"title":"插件/包管理器 liteyuki_pacman","slug":"插件-包管理器-liteyuki-pacman","link":"#插件-包管理器-liteyuki-pacman","children":[{"level":3,"title":"命令别名","slug":"命令别名-1","link":"#命令别名-1","children":[]}]},{"level":2,"title":"用户管理liteyuki_user","slug":"用户管理liteyuki-user","link":"#用户管理liteyuki-user","children":[]}],"git":{"createdTime":1711598703000,"updatedTime":1718552038000,"contributors":[{"name":"snowy","email":"snowykami@outlook.com","commits":20},{"name":"Snowykami","email":"79104275+snowykami@users.noreply.github.com","commits":4},{"name":"Nanaloveyuki","email":"miaomiao_159@outlook.com","commits":1}]},"readingTime":{"minutes":3.18,"words":953},"filePathRelative":"usage/basic_command.md","localizedDate":"2024年3月28日","autoDesc":true}');export{g as comp,y as data};
|