kohme

README

须知

运行前，需要在项目根目录下创建conf文件夹，并新建config.json和plugins.yaml两个配置文件 已有可以忽略

config.json

复制后请删掉注释，json不支持注释

{
  // 这部分配置可参考zeroBot的配置
  "zero": {
    // bot昵称
    "nick_name": ["kohme"],
    // 指令前缀
    "command_prefix": "/",
    // 超级用户
    "super_users": []
  },
  // 正向ws配置
  "ws": {
    "url": "ws://127.0.0.1:3001",
    "token": ""
  },
  // 反向ws配置，不需要启用时留空就好了
  "rws": {
    "url": "ws://127.0.0.1:3002",
    "token": ""
  }

}

plugins.yaml

插件的总配置

# 插件目录
path: ./conf 
# 启用的群列表，所有插件的全局配置
groups: [] 
# 各插件配置(下面以core插件和livebili插件示范)
plugins:
  # core插件的配置
  core:
    # 下面说的所有"加载"指的是插件的初始化
    # 插件加载顺序,通过seq的值从小到大依次加载
    # seq相同时，加载顺序不能保证
    seq: 0
    # 是否排除插件(不会加载)
    exclude: false
    # 是否禁用插件(只是禁用功能，但还是会加载)
    disable: false
    # 启用的群列表(为这个插件单独指定启用的群，会屏蔽群设置)
    groups: []
    # conf是对应插件的配置字段，取决于各插件的实现
    conf:
      help_top: 下面是我的所有本领！
      help_tail: 更多本领绝赞学习中,加入github.com/KohmeBot来教会我吧！
    # ... 若有其他键值对，将会作为插件的环境变量传入

  livebili:
    # 插件仓库地址 
    repo: github.com/kohmebot/livebili
    # 指定插件版本,不填,默认latest(最新版本)  version: v0.0.15 则下载对应插件的v0.0.15版本
    version: latest
    seq: 1
    conf:
      # ...

多文件插件配置

Kohme支持通过多个文件配置插件，放在plugins.yaml中指定的path目录，配置文件写法如下

my_plugin_groups.yaml

livebili:
    # 插件仓库地址 
    repo: github.com/kohmebot/livebili
    # 指定插件版本,不填,默认latest(最新版本)  version: v0.0.15 则下载对应插件的v0.0.15版本
    version: latest
    seq: 1
    conf:
      # ...

chatai:
    repo: github.com/kohmebot/chatai
    conf:
      # ...

编译与启动

• windows执行build.bat
• linux执行build.sh

构建脚本会自动获取插件并编译二进制文件于本目录,运行即可

Documentation

Index

• func GetPlugins() []plugin.Plugin
• func Register(p plugin.Plugin)
• func RunKohme(zConf conf.ZeroConf, pConf conf.PluginConf) error

Functions

func GetPlugins

func GetPlugins() []plugin.Plugin

func Register

func Register(p plugin.Plugin)

func RunKohme

func RunKohme(zConf conf.ZeroConf, pConf conf.PluginConf) error