Metadata-Version: 2.1
Name: efb-qq-slave
Version: 2.0.2.dev0
Summary: QQ Slave Channel for EH Forwarder Bot, integrated with various QQ Clients.
Home-page: https://github.com/milkice233/efb-qq-slave
Author: Milkice
Author-email: milkice@milkice.me
License: GPLv3
Keywords: ehforwarderbot,EH Forwarder Bot,EH Forwarder Bot Slave Channel,qq,chatbot
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Communications :: Chat
Classifier: Topic :: Utilities
Requires-Python: >=3.6
License-File: LICENSE

########################################################################
EFB QQ Slave Channel：EFB QQ 从端 (EQS)
########################################################################

.. figure:: https://i.imgur.com/KHhlL6c.png
   :alt: This project proudly supports #SayNoToQQ campaign.

**Channel ID**: ``milkice.qq``

***********************
软件依赖
***********************

-  Python >= 3.6
-  EH Forwarder Bot >= 2.0.0
-  ffmpeg
-  libmagic
-  pillow


******************
安装与启用
******************

本项目目前仍是 Alpha 版本，仍不稳定，且功能可能随时变更。

现阶段，请按照以下步骤安装此软件包并开始测试。

1. 安装依赖及 EH forwarder bot

   ``pip3 install ehforwarderbot``

2. pip 安装 efb-qq-slave 及 efb-telegram-master

   ``pip3 install -U git+https://github.com/milkice233/efb-qq-slave``
   
   ``pip3 install efb-telegram-master``

3. 配置EFB在当前配置文件夹 (Profile) ``<profile directory>/config.yaml`` 的 ``config.yaml`` 中启用主端 ``blueset.telegram`` 与附端 ``milkice.qq``  

   当前配置文件夹的位置会根据用户的设定而改变。

   **(EFB 2.0.0a1 中，默认的配置文件夹位于**
   ``~/.ehforwarderbot/profiles/default`` **)**

4. 配置 efb-telegram-master ，详情请见 `这里 <https://github.com/blueset/efb-telegram-master>`_

5. 为 ``milkice.qq`` EQS从端 创建配置文件 ``config.yaml`` 来指定 QQ 客户端

   各种QQ客户端的详细配置步骤如下，用户可选择一个客户端进行配置，无需全部配置。


客户端们:
------------------------------

go-cqhttp: `go-cqhttp 配置教程 <https://github.com/XYenon/efb-qq-plugin-go-cqhttp>`_ (由XYenon贡献)

Mirai: `Mirai 客户端配置教程 <doc/Mirai_zh-CN.rst>`_

IOTBot: `IOTBot 客户端配置教程 <doc/IOT_zh-CN.rst>`_

酷Q: `酷Q API通用配置教程 <doc/CoolQ_zh-CN.rst>`_ (请注意酷Q已无法使用，该文档仅供支持CQHTTP协议的QQ客户端使用，普通用户应该查阅上面的文档)

FAQs
------------------------------

**以下内容通用 针对所有客户端有效**

* Q - 如何在 主端(Telegram) 撤回消息？

  A - 如果 QQ 客户端支持该操作，请回复该消息 ``/rm`` 即可在QQ端撤回该消息 同时请注意发出的消息仅能在发出后2分钟内撤回
  
* Q - 如何在 主端(Telegram) 编辑消息？
  
  A - 直接使用 Telegram 的编辑消息功能即可 (目前Mirai客户端的兼容模式暂不支持)

注意事项
------------------------------

* 目前项目并不稳定，欢迎提交Issue
