message-counter:用于统计群聊中用户的发言次数,并生成各种排行榜,包括日榜、周榜、月榜、年榜、总榜和圣龙王榜。🐉

koishi-plugin-message-counter

npm

:balloon: 介绍

koishi-plugin-message-counter 是一个基于 Koishi
的机器人插件,用于统计群聊中用户的发言次数,并生成各种排行榜,包括日榜、周榜、月榜、年榜、总榜和圣龙王榜。:dragon:

该插件可以自动推送排行榜,也可以手动查询。还可以选择是否统计机器人自己的发言,以及是否禁言每天发言最多的用户(即龙王)。:zipper_mouth_face:

该插件使用了 node-schedule
来实现定时任务,以及 koishi 的数据库接口来存储用户数据。:books:

:package: 安装

前往 Koishi 插件市场添加该插件即可

:video_game: 使用

  • 该插件仅记录群聊消息,私聊消息不会被统计。:see_no_evil:
  • 该插件建议为指令添加指令别名,以方便用户快速查询。:rocket:
  • 可以选择启用 isTextToImageConversionEnabled(文字转图片)功能,但更建议使用 imagify 插件(在插件市场搜索),视觉效果更佳,渲染速度更快(可能)。

:gear: 配置项

排行榜显示设置

  • defaultMaxDisplayCount:排行榜默认显示的人数,默认为 20:busts_in_silhouette:
  • isTimeInfoSupplementEnabled:是否在显示排行榜时补充时间信息,默认值为 true

消息追踪设置

  • isBotMessageTrackingEnabled:是否统计机器人自己发送的消息,默认为 false:robot:

图片转换功能设置

  • isTextToImageConversionEnabled:是否开启将文本转为图片的功能(可选),如需启用,需要启用 markdownToImage 服务。:robot:

自动推送设置

  • autoPush:是否自动推送排行榜,默认为 false:ok_hand:
    • leaderboardGenerationWaitTime:自动生成排行榜的等待时间,单位是秒,默认为 3:watch:
    • pushChannelIds:启用自动推送排行榜功能的频道列表。:watch:

用户禁言设置

  • enableMostActiveUserMuting:是否禁言每天发言最多的用户,即龙王,默认为 false:speak_no_evil:
    • dragonKingDetainmentTime:关押龙王的等待时间,单位是秒,默认为 5:speak_no_evil:
    • detentionDuration:关押时长,单位是天,默认为 1:speak_no_evil:
    • muteChannelIds:启用关押龙王功能的频道列表。:watch:

:memo: 命令

messageCounter

  • messageCounter:查看 messageCounter 帮助。:question:

  • messageCounter.初始化:初始化,清空数据表,将插件还原,需要权限等级 3 级及以上。:pray:

  • messageCounter.查询 [targetUser]:查询指定用户的发言次数信息(次数[排名])。:mag:

    • -d:今日发言次数[排名]。:sun_with_face:
    • -w:本周发言次数[排名]。:crescent_moon:
    • -m:本月发言次数[排名]。:date:
    • -y:今年发言次数[排名]。:confetti_ball:
    • -t:总发言次数[排名]。:crown:
    • --yesterday:昨日发言次数[排名]。:arrow_left:
    • --dag:跨群今日发言总次数[排名]。:crown:
    • -a:跨群发言总次数[排名]。:dragon_face:
  • messageCounter.排行榜 [number]:发言排行榜,可以指定显示的人数,也可以使用以下选项来指定排行榜的类型::trophy:

    • -d:今日发言榜。:sun_with_face:
    • -w:本周发言榜。:crescent_moon:
    • -m:本月发言榜。:date:
    • -y:今年发言榜。:confetti_ball:
    • -t:总发言榜。:crown:
    • --yesterday:昨日发言榜。:arrow_left:
    • --dag:跨群今日发言榜。:crown:
    • --dragon:圣龙王榜,显示每个用户在所有群中的总发言次数。:dragon_face:
    • 若未指定排行榜类型,则默认为今日发言榜。:speech_balloon:

:pray: 致谢

:page_facing_up: License

MIT License © 2023

5 个赞

:partying_face: :partying_face: :partying_face:

2 个赞

来人,请龙王吃口球

2 个赞