# README

东方Project沙包聚集地机器人

本项目已迁移至 https://github.com/CuteReimu/YinYangJade

这是东方Project沙包聚集地（以下简称“红群”）的机器人，基于MiraiGo编写。

声明

本项目采用AGPLv3协议开源。同时强烈建议各位开发者遵循以下原则：
- 任何间接接触本项目的软件也要求使用AGPLv3协议开源
- 不鼓励，不支持一切商业用途
由于使用本项目提供的接口、文档等造成的不良影响和后果与本人和红群无关
由于本项目的特殊性，可能随时停止开发或删档
本项目为开源项目，不接受任何的催单和索取行为

使用方法

建议在编译前更新一下依赖：

go get -u

编译：

go build -o tfcc-bot.exe

然后双击运行生成出来的tfcc-bot.exe即可。比较建议在cmd窗口中输入tfcc-bot.exe运行，以防panic后报错信息无法看到。

在功能完善后，会将编译好的包放在Release中供大家下载。

关闭程序时，请使用ctrl+C关闭，以确保db、log、bot等模块正常关闭。如果强制退出，可能会导致部分数据未写入硬盘，下次启动时丢失数据。

配置文件

第一次运行会自动生成配置文件application.yaml，如下：

bilibili:
  area_v2: "236"           # 直播分区，236-主机游戏
  mid: "12345678"          # B站ID
  password: "12345678"     # 密码
  room_id: "12345678"      # B站直播间房间号
  username: "13888888888"  # B站用户名
bot:
  login-method: qrcode  # 登录方式
  account: 0           # 机器人QQ号
  password: ""         # 机器人密码
qq:
  rand_count: 10            # 每天随符卡限制次数
  rand_one_time_limit: 20   # 单次随符卡的数量限制
  related_url: ""           # 关联的网站网址
  super_admin_qq: 12345678  # 主管理员QQ号
  qq_group: # 主要功能的QQ群
    - 12345678
repeater_interruption:
  allowance: 5  # 打断复读功能限制的复读次数
  cool_down: 3  # 打断复读冷却时间（秒）
  qq_group: # 打断复读的Q群
    - 12345678
schedule:
  before: # 预约功能提前提醒时间（秒）
    - 10800
    - 21600
  qq_group: # 预约功能提醒QQ群
  - 12345678
  video_push_delay: 600  # 视频推送间隔
thwiki:
  enable: false  # 是否开启查新闻功能

修改配置文件后重新启动即可。

模块

chatPipeline 非命令式的QQ聊天消息处理。想要新增，实现pipelineHandler接口并在init()中调用register()即可
commandHandler QQ聊天中输入的命令。想要新增命令，实现cmdHandler接口并在init()中调用register()即可
db 一个嵌入式Key-Value型数据库，使用这个模块存储的数据会被存在硬盘里，下次重启后仍然保留
perm 权限管理，管理员和白名单
main.go 程序入口