# 常用功能 (common)

提示

本章介绍的功能都由 koishi-plugin-common 插件提供。

注意

这里是正在施工的 koishi v3 的文档。

koishi-plugin-common 包含了一些基本插件,它们在你使用 koishi 库时是默认安装的。

# 指令列表

以下是这个插件包含的指令列表。注明“需要数据库”的指令在没有配置数据库时默认不注册。

指令默认权限需要数据库
admin4
broadcast3
contextify (ctxf)3
echo3
exec4
exit4
help0

你也可以在安装插件时显式地声明某些指令不注册:

koishi.config.js
module.exports = {
  plugins: [['common', {
    exit: false,        // 不注册 exit 指令
  }]],
}

# 配置列表

除了上述指令都可以声明不注册外,koishi-plugin-common 还提供了其他的一些配置项如下:

配置项对应章节
broadcastInterval向所有群广播消息
respondent配置内置问答
repeater配置复读机
handleFriend处理好友申请
handleGroupAdd处理加群申请
handleGroupInvite处理加群邀请
welcomeMessage欢迎新成员
getUserName查看用户信息

# 导出的方法

此外,koishi-plugin-common 还导出了一些方法如下:

导出方法对应章节
registerUserInfo扩展要显示的信息
registerUserAction添加可用操作
registerGroupAction添加可用操作