nkreer/fish

此包已被废弃，不再维护。未建议替代包。

高级IRC机器人

维护者

详细信息

github.com/nkreer/Fish

主页

源代码

问题

安装: 21

依赖: 0

建议者: 0

安全: 0

星标: 1

关注者: 1

分支: 0

开放问题: 0

类型:框架

1.2 2017-02-26 16:20 UTC

Requires (Dev)

GPL d168a8d327f5b69413f60c96d80db411c2c5f840

apiplugininterfacebotirc

This package is not auto-updated.

Last update: 2020-01-24 16:45:36 UTC

README

TravisCI build License

Fish 是一个 libre 和开源的IRC机器人，拥有强大的插件API，使用PHP编写。它根据GPL版本3的条款和条件进行分发。

入门

要求

  • PHP 7 (已在7.0.x上测试，应也能在7.1上运行)
  • 类Unix操作系统（已在macOS Sierra和Debian Linux上测试）
  • Composer

Fish已在Unix系统上测试，与PHP 7兼容。目前不与PHP 5或Windows兼容。HHVM尚未测试。要安装和使用Fish，请确保已安装composer。

安装

为了与插件有最佳兼容性，您应始终使用 最新稳定版。不建议在生产环境中使用此存储库的源代码，因为它可能包含错误或是不稳定的。

正常安装

可以直接使用composer下载和安装最新版本

$ composer create-project nkreer/fish

或者下载最新代码库，并使用以下命令让composer安装软件

$ composer install

作为库使用时的安装

Fish可在Packagist上找到。您可以在自己的项目中要求使用它，如下所示。

$ composer require nkreer/fish

请注意，该软件并未设计为用作库。一些功能可能在您的环境中无法使用。

配置

配置在fish.json文件中完成。您可以在CONFIGURATION.md中找到设置Fish的帮助。

启动

打开终端，导航到机器人的源文件，并运行

$ php Start.php <地址> [参数]

可用的参数有

--port <port>           for using a port other than 6697

--no-ssl true           for connecting without TLS (Don't use this unless really needed)

--password <password>   for connecting to a passworded server

--config <path>         for using a different config file

功能

Fish提供了许多与IRC服务器交互的功能

  • 超级简单且功能强大的插件API（这是迄今为止PHP IRC机器人中最简单的API！）
  • 支持在一个进程中进行多个连接
  • 内置和适应的管理命令（加入、离开、帮助等）
  • 内置用户认证功能
  • 内置权限管理
  • 更多功能

扩展

Fish可以通过插件进行扩展。已经编写了几个插件

插件 描述
PluginTools 帮助您打包插件
权限 更改IRC上用户的权限
脚本 允许您向机器人添加简单的自定义命令

更多功能正在开发中。

API文档

您可以在本仓库的wiki中找到一个如何编写自己的插件的简单教程。如果您对API有任何疑问，请随时给我发电子邮件。