HoshinoBot (customized)

HoshinoBot的个人修改版。安装和部署指南请看部署。

本项目不提供原项目的资源文件，请前往HoshinoBot原项目地址下载资源文件。额外的资源文件在res文件夹中，可能不完整，您可以提出issue索取未上传的资源；

**2021年1月5日的更新修改了机器人配置文件结构，并上传了相应的示例配置文件。如您此前使用过本项目的代码，请参见下文20210105更新对您的机器人配置文件进行相应修改，以避免不必要的错误。如您在这之后才开始部署，则只需要下载项目中的示例配置文件即可，不需要修改。

简介

本项目对原版机器人进行了少许修改，这些修改可能导致与原版机器人部分功能不兼容。修改包括：

• 在语料库中加入更多应答；
• 在资源库接口中添加ResRec类以处理语音；
• 在广播中添加“单个群发消息”功能；用法：私发机器人gbc [群号] [内容]；
• 不兼容：修改每日签到访问印章图片的位置，支持印章图片集的热更新；加入重置签到情况的功能。不兼容的原因是修改了印章路径；
• 在反滥用中加入主动拉黑某个人或某个群（及解除拉黑）的功能；
• 增加角色数据库中内容；
• 不兼容：公会战期间hourcall将使用一套专门针对公会战的文案。同时，添加了手动触发报时功能，方便调试。不兼容的原因是在文案文件中加入当期公会战的日期，在读入原版文案时会因为不存在这个信息而报错；
• 修改公会战管理系统，增加下树功能，取消锁定功能，支持预约狂暴五王，并使出刀、查刀、改刀功能更加精细易用；

同时，编写或安装了若干插件，包括：

• 查询公会战排名：项目地址
• 查询简介、技能、专武信息：项目地址
• 查看日程表：项目地址
• 网页管理服务；这个插件的view.py由于含有密码而没有上传，请参考/hoshino/modules/botmanage/web_service_manager的README进行配置；
• 群空调；
• 表情生成器；
• 公会战离职报告；

这些插件的著作权属于原作者，均按GPL-v3协议开源。

除此之外，本项目增加了部分参数的修改接口，实现参数热更新，包括：

• 重置每日签到情况
• 更新印章库里的印章列表
• 设置查询拆法时显示的最大作业数

具体的更新内容可查阅commit。

开源

本项目按GPL-v3协议开源。您可以任意复制、使用、修改、署名该作品及衍生作品，但若要向非开发者分发这些作品，则需要以GPL-v3协议开源。详情请阅读开源协议。

部署

我们提供了一份示例配置文件，位于hoshino/config_example文件夹中。请下载本项目代码，将这个文件夹名字改为config，填写__bot__.py的这些字段：

PORT = 8080   # hoshino监听的端口与ip
#HOST = '127.0.0.1'      # Windows部署使用此条配置
HOST = '0.0.0.0'   # linux + docker使用此条配置

SUPERUSERS = []    # 填写超级用户（机器人管理员）的QQ号，可填多个用半角逗号","隔开
NICKNAME = ()           # 机器人的昵称。呼叫昵称等同于@bot，可用元组配置多个昵称
BOTNAME = ''  # 机器人的名字

RES_PROTOCOL = 'file'
RES_DIR = r'/res'  # 资源库文件夹，需可读可写，windows下注意反斜杠转义
RES_URL = 'http://172.17.0.1:8080/res/'   # 使用http协议时需填写，原则上该url应指向RES_DIR目录

请按您的服务器和机器人实际情况进行修改，具体可见文件内代码注释。

可选：在hoshino/config/priconne.py里填入竞技场查询key。竞技场查询功能的数据来自 公主连结Re: Dive Fan Club - 硬核的竞技场数据分析站 ，查询需要授权key。您可以向pcrdfans的作者索要。（注：由于最近机器人搭建者较多，作者常被打扰，我们不建议您联系他，推荐您前往网站进行查询）

随后，在go-cqhttp的项目地址下载符合您系统的程序，并参考配置教程配置config.ini。在配置中，请关闭http_config与ws_config，启用ws_reverse_servers，其中reverse_url的格式为ws://[您的IP]:[您的监听端口]/ws/，监听端口与HoshinoBot的监听端口保持一致。

配置完后，依次启动HoshinoBot与go-cqhttp，向机器人发送“bot管理”，若有回复则部署成功。

20210105更新

我们在/hoshino/config/__bot__.py中加入了表示机器人名字的变量：

BOTNAME = '优妮'

请在您的机器人的__bot__.py内任意位置加入这一行代码，并将名字改为您机器人的名字。

这一改动旨在方便在迁移和大规模部署机器人时快速更改内部文案。例如，名为“优妮”的机器人可能有多句形如“优妮提醒您”或“使用方法：优妮来发十连”的应答。在新建一个名为“镜华”的机器人时，只需要修改配置文件中这一行即可完成所有文案修改。

在您编写自己的插件时，请在头部加入这一行代码：

from hoshino.config import BOTNAME as botname  # 或将botname换成您喜欢的变量名

并在随后需要提及机器人名字的地方都用该变量表示。例如：

return f'{botname}检测到海豹行为！'