红星-一个通用的不和机器人与奖金喊叫。
red-star的Python项目详细描述
红星机器人
一个可配置的,可扩展的不和谐机器人,包括管理和娱乐插件。再加上喊叫。
功能
- 强大的自定义命令基于我们自己的lisp方言,RSLisp,
- 事件日志记录,包括消息编辑、删除和pin、用户连接/离开等,
- 按内容(支持regex)、作者等强大的消息清除功能,
- 每日消息插件,具有可配置的假日和基于日期、工作日或月份的消息,
- 投票插件,用于制作、响应和计算投票结果。
- 带有时间、延迟和重复提醒的提醒插件,
- 新会员播音员,可轻松配置信息,
- 通过命令轻松管理移动用户的角色,
- 还有更多,有额外的插件可用here。
安装
具有pip
只要运行pip install red-star
,就会自动安装red star及其所有依赖项。
然后,只需运行python -m red_star
或red_star
(如果脚本在您的路径中),就可以运行red star。
来源
安装
在red star文件夹中运行pip install -e .
将自动安装red star及其所有依赖项。
这将允许你运行红星与上述相同的方式。
便携式运行
或者,只需导航到源目录并运行python red_star.py -p
,就可以轻松地运行红星。
这将告诉红星将其松散的文件保存在源目录中,而不是放在用户文件夹中。
用法
上面已经介绍了启动bot;只需调用red_star
、python -m red_star
或python red_star.py
即可运行bot。
第一次运行时,默认配置文件将被复制到~/.red_star
(C:\Users\username\.red_star
在windows上)中,使用前必须对其进行编辑。
命令行参数
-[-p]ortable
:告诉bot以可移植模式运行,将其所有松散文件保存在其源目录中。 如果您不想混乱您的用户文件夹,或使用pip
安装bot,则会很有用。-[-d]irectory
:允许用户指定一个自定义目录来放置松散的文件。不能与-p
一起使用。-[-l]ogfile
:允许用户为日志文件指定与默认名称不同的名称。-[-v]erbose
:告诉bot在运行时输出调试信息。最多可以调用三次,每次都会增加详细程度。
文档
有关其他文档,请参见our wiki,包括 Command Reference,Configuring Red Star, 以及Adding A Bot to a Server。