Habitica的Sopel模块
sopel_modules.habitica的Python项目详细描述
#Sopel Habitica模块 [sopel][1]irc bot模块,用于[habitica][2]
选定的Unicode图标在[Good Emoji支持][3]中看起来最为出色。
##功能
目前为止的工作:
- 将Habitica Party Chat呼应到IRC中
- 通过IRC聊天
- .hero命令显示字符状态
- 显示划痕颜色
- 禁用颜色(不推荐)
- 以颜色呈现标记代码块(如果启用)
计划的功能:
- 从irc施法
- 使用IRC的保健药水
- AutoHeal
可能的功能:
- 添加习惯/日报/待办事项
- 向上/向下/完成习惯/日报/待办事项/清单
##安装
克隆此存储库,在克隆到的目录中打开一个终端,然后运行pip install。。 很快也会在皮皮被发现!
##配置
编辑sopel配置文件(通常.sopel/default.cfg)。
在[core]下,添加habitica到enable=以启用模块。
然后放入此部分
` [habitica] api_user = <a Habitica User ID> api_key = <the corresponding API Token> channels = <comma separated list of IRC channels you want a Habitica chat in> chats = <comma separated list of Habitca chat IDs (see below)> `
这些是mandatory配置行。 chat s=可以包含聊天的uuid,也可以包含当前聊天方的聚会,或者包含酒馆的habitrpg 聊天。
###可选配置
在[habitica]部分中可以选择下列行,它们后面的值是默认值:
` max_lines = 5 colors = True api_url = https://habitica.com/api/v2/ `
max_lines是每个IRC消息可以很长的行数(每个行限制为400个字符)。 颜色可以设置为假以停用此模块的颜色。不过,这让阅读变得更加困难! api_url是habitica api的url。如果你有自己版本的habitica运行,你可能想改变它。
##待办事项
- 测试
- 文档
[1]:https://github.com/sopel-irc/sopel [2]:https://habitica.com [3]:https://github.com/eosrei/emojione-color-font