Metadata-Version: 2.1
Name: nonebot_plugin_ntqq_restart
Version: 0.1.3
Summary: A plugin for restarting NTQQ when bot disconnection
Author-email: KanbeReina <kano.2525@qq.com>
License: MIT
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyautoit >=0.6.5
Requires-Dist: nonebot2 >=2.3.1
Requires-Dist: nonebot-plugin-apscheduler >=0.4.0

<div align="center">
  <a href="https://v2.nonebot.dev/store"><img src="https://github.com/A-kirami/nonebot-plugin-template/blob/resources/nbp_logo.png" width="180" height="180" alt="NoneBotPluginLogo"></a>
  <br>
  <p><img src="https://github.com/A-kirami/nonebot-plugin-template/blob/resources/NoneBotPlugin.svg" width="240" alt="NoneBotPluginText"></p>
</div>

<div align="center">

# nonebot-plugin-ntqq-restart

_✨ 一个简易的Bot断连重启NTQQ的插件 ✨_


<a href="./LICENSE">
    <img src="https://img.shields.io/github/license/kanbereina/nonebot-plugin-ntqq-restart.svg" alt="license">
</a>
<a href="https://pypi.python.org/pypi/nonebot-plugin-ntqq-restart">
    <img src="https://img.shields.io/pypi/v/nonebot-plugin-ntqq-restart.svg" alt="pypi">
</a>
<img src="https://img.shields.io/badge/python-3.8+-blue.svg" alt="python">

</div>


## ⚠警告

> ①本插件**仅适用于Windows用户**！（原理上使用了**WinAPI**和**Win命令行**）
> 
> ②本插件由于**Windows的窗口句柄**的原因，在**插件开启/关闭**时会**杀死存在的所有QQ进程**！
> 
> ③本插件只适用于**NTQQ登录过期**的情况（此情况仍旧可以重启后正常登录），<br>
> 对于其他情况（包括但不限于**账号冻结**、**版本过低**），**无法提供**有效的解决方案 **!**

## 📖 介绍

此插件主要用于帮助**llonebot用户**在**长时间运行机器人**的情况下，
遇到的**NTQQ登录过期导致Bot下线**的情况。


当**Bot断连时**，本插件会**自动重启NTQQ并窗口最小化**。（账号登录靠**NTQQ自带的自动登录**）

## 💿 安装

<details open>
<summary>使用 nb-cli 安装</summary>
在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装

    nb plugin install nonebot-plugin-ntqq-restart

</details>

<details>
<summary>使用包管理器安装</summary>
在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令

<details>
<summary>pip</summary>

    pip install nonebot-plugin-ntqq-restart
</details>
<details>
<summary>pdm</summary>

    pdm add nonebot-plugin-ntqq-restart
</details>
<details>
<summary>poetry</summary>

    poetry add nonebot-plugin-ntqq-restart
</details>
<details>
<summary>conda</summary>

    conda install nonebot-plugin-ntqq-restart
</details>

打开 nonebot2 项目根目录下的 `pyproject.toml` 文件, 在 `[tool.nonebot]` 部分追加写入

    plugins = ["nonebot-plugin-ntqq-restart"]

</details>

## ⚙️ 配置

在 nonebot2 项目的`.env`文件中添加下表中的必填配置

| 配置项 | 必填 | 默认值 | 说明 |
|:-----:|:----:|:----:|:----:|
| NTQQ_Path | 是 | 无 | NTQQ的.exe文件的完整路径 |
| enable_restart_when_disc | 否 | True | 允许Bot断连后重启NTQQ |
| enable_login_when_nbrun | 否 | False | 允许nb加载时运行NTQQ |
| enable_close_qq_when_shutdown | 否 | False | 允许nb关闭时关闭NTQQ |
| restart_after_disc_time | 否 | 10 | 在Bot断连的{int}秒后重启NTQQ |
| retry_max_time | 否 | 5 | 重试NTQQ窗口最小化的最大时间(秒) |

## 🎉 使用
### ①插件配置
你可以参照[**配置文件示例**](https://github.com/kanbereina/nonebot-plugin-ntqq-restart/blob/master/.env.prod.example)或**文档-配置**以配置插件参数
### ②NTQQ端设置（此两个选项保持打开状态）
![NTQQ端设置](https://github.com/kanbereina/nonebot-plugin-ntqq-restart/blob/master/doc/ntqq_config_example.PNG)
### ③配置后直接运行nonebot即可
> **nb run**
### 效果图
![插件运行效果](https://github.com/kanbereina/nonebot-plugin-ntqq-restart/blob/master/doc/run_example.PNG)
