keli-sign/README.md

keli 的积分签到插件，提供积分签到功能，支持分群、自定义积分名等

# 积分签到 for keli

[![npm-version](https://img.shields.io/npm/v/keli-sign?color=527dec&label=keli-sign&style=flat-square)](https://npm.im/keli-sign)
[![dm](https://shields.io/npm/dm/keli-sign?style=flat-square)](https://npm.im/keli-sign)

[`keli`](https://npm.im/keli) 的积分签到插件，提供积分签到功能，支持分群、自定义积分名等。

**安装**

```shell
/plugin add sign
```

**启用**

```shell
/plugin on sign
```

**使用**

```shell
签到
积分排行
我的积分
```

**管理员指令**

```shell
# 启用/禁用当前群，默认禁用
/sign on/off
# 设置数据备份群号
/sign group <备份群号>
# 给当前群对应用户（支持艾特）增加/扣除对应数的积分
/sign inc/dec <qq> <count>
# 查看今日所有群的签到统计信息
/sign stat
# 查看备份数据到群文件（需要机器人是备份群的群管理）
/sign backup
```

**可选配置**

编辑 `data/plugins/keli-sign/config.json` 文件，重载插件生效。

```jsonc
{
  // 备份群号，可以使用命令 `/sign group <群号>`
  "group": 0,
  // 积分名称
  "unit": "积分",
  // 每日随机获取的积分范围
  "range": [3, 10],
  // 启用群列表，可以使用命令 `/sign on/off`
  "enableGroups": [],
  // 排行榜显示最大人数
  "max": 6,
  // 成员相关命令
  "cmds": {
    // 签到命令
    "sign": "签到",
    // 排行榜命令
    "rank": "积分排行",
    // 积分查询命令
    "mine": "我的积分"
  }
}
```