Railgun-Helper-UserDocument.md

Railgun 人工智障型辅助机器人系列通用用户文档

V0.9.1 rev.2017042301

简介：

Railgun 人工智障型辅助机器人系列由 TundraWork 实现的 Railgun-Bot-CLI Telegram 机器人框架加载各种功能模块后形成。

由于 Railgun-Bot-CLI 框架特性，本系列机器人调用 Telegram-CLI 通过 mtproto 协议与 Telegram 平台交互，功能模块均使用 PHP 语言编写。

本系列机器人支持加载符合框架标准的 PHP 类文件作为功能模块实现功能扩展，支持动态重载配置文件，关于 Railgun-Bot-CLI 框架的详细说明请参见 Railgun-Bot-CLI 框架文档 （尚未完成）。

关于本系列机器人的任何问题或建议请联系 @tundrawork 。

系统要求：

• 主流 Linux 发行版较新版本
• PHP >= 5.5.x 具有 memcached redis curl json 库支持
• telegram-cli 较新版本（推荐使用 https://github.com/and-rom/tg 分支源码编译）

文件说明：

• Init.php

  启动入口文件，通过 php Init.php 命令启动机器人进程。

• 其他文件

  详见 Railgun-Bot-CLI 框架文档。

支持命令：

• 系统命令

  • $shutdown

    Basic 退出进程。需要管理员权限

  • $reload

    Basic 重新加载配置文件。需要管理员权限

  • $suspend

    Basic 暂定消息处理，机器人将不再处理接收到的任何消息，除非消息内容为此命令本身。再次执行此命令将取消此状态。需要管理员权限

  • $mute

    Basic 静音，机器人将不再发送除系统消息外的任何内容。再次执行此命令将取消此状态。需要用户权限

  • $status

    Basic 返回当前实例状态信息。

  • $whoami

    UserInfo 返回消息发送用户的用户信息。

• 功能命令

  • ping

    Basic 测试消息发送延迟。暂时取消实际功能

  • pong

    Pong2Ping 返回"ping"。此模块未加载

  • translate

    SubWorkHelper 此命令含有多个子命令，详细用法请查询模块文档。此模块未加载

  • /tags

    SimpleNLP 返回当前群组聊天内容关键词标签。此模块未加载

  • $tags

    SimpleNLP /tags 命令的别名。此模块未加载

  • /tags@typcn_soliloquize_bot

    SimpleNLP /tags 命令的别名。此模块未加载

  • /nlpstatus

    SimpleNLP 返回当前群组的 NLP 数据状态信息。此模块未加载

  • $nlpstatus

    SimpleNLP /nlpstatus 命令的别名。此模块未加载

  • /nlpstatus@typcn_soliloquize_bot

    SimpleNLP /nlpstatus 命令的别名。此模块未加载

• 自动响应

  • AinouHelper

    此模块提供对 Ainou 机器人的跨平台转发消息进行简单处理的功能。此模块未加载

    此模块识别 Ainou 机器人的跨平台转发消息中的发送用户名部分，并将其从消息字符串中去除，以便其他模块进一步处理消息。

  • PixivHelper

    此模块提供对内容为 Pixiv 作品页面链接的消息进行处理的功能。

    若消息来源群组未设置相应广播频道，则以图片形式将作品页面中的作品原图发送至消息来源群组；若消息来源群组设置了相应广播频道，则将消息中的链接发送至该广播频道，并以图片形式将作品页面中的作品原图发送至该广播频道。

  • SimpleNLP

    此模块提供 LYP 模拟器，即自动选择“看起来”有趣的消息进行复读，以及参与复读队形的功能。此模块未加载

  • UserInfo

    此模块提供对机器人接触到的所有用户的信息进行管理的功能。

    此模块用于为其他模块编写提供方便，详细用法请查询模块文档。

技术支持

技术支持？不存在的。