Metadata-Version: 2.2
Name: nonebot-plugin-paminet-nodirtymsg
Version: 0.3.1
Summary: 基于Trie树的高效群聊违禁词过滤插件,自动撤回群成员的敏感发言.需要管理员权限.
Author-email: Mipa <shcdwrzh@outlook.com>
License: MIT
Project-URL: Homepage, https://github.com/PamiNET-Corp/nonebot-plugin-paminet-nodirtymsg
Project-URL: Repository, https://github.com/PamiNET-Corp/nonebot-plugin-paminet-nodirtymsg
Project-URL: Documentation, https://github.com/PamiNET-Corp/nonebot-plugin-paminet-nodirtymsg#readme
Project-URL: Issues, https://github.com/PamiNET-Corp/nonebot-plugin-paminet-nodirtymsg/issues
Keywords: nonebot,chat,moderation,filter
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Communications :: Chat
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: nonebot2>=2.3.0
Requires-Dist: nonebot-adapter-onebot>=2.0.0
Requires-Dist: nonebot-plugin-localstore>=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-paminet-nodirtymsg

_✨ NoneBot 群聊脏话管理插件 ✨_


<a href="./LICENSE">
    <img src="https://img.shields.io/github/license/PamiNET-Corp/nonebot-plugin-paminet-nodirtymsg.svg" alt="license">
</a>
<a href="https://pypi.python.org/pypi/nonebot-plugin-paminet-nodirtymsg">
    <img src="https://img.shields.io/pypi/v/nonebot-plugin-paminet-nodirtymsg.svg" alt="pypi">
</a>
<img src="https://img.shields.io/badge/python-3.9+-blue.svg" alt="python">

</div>

## 📖 介绍
#### 只是一个平平无奇的聊天过滤插件。  
#### 暂仅支持OnebotV11协议
> [!IMPORTANT]
> **该项目由DeepSeek-R1辅助开发！**

## 🛡️ 功能特性
- 多级违禁词匹配（支持 10 万级词库）
- 异步文件 IO 操作
- 智能撤回重试机制（可配置重试次数）
- 实时热更新词库（修改文件后自动重载）
- 环境变量覆盖配置

> [!IMPORTANT]
> **收藏项目**，让更多人知道这个没什么用的东西！⭐️

<img width="100%" src="https://starify.komoridevs.icu/api/starify?owner=PamiNET-Corp&repo=nonebot-plugin-paminet-nodirtymsg" alt="starify" />

## 💿 安装

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

    nb plugin install nonebot-plugin-paminet-nodirtymsg

</details>

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

<details>
<summary>pip</summary>

    pip install nonebot-plugin-paminet-nodirtymsg
</details>
<details>
<summary>pdm</summary>

    pdm add nonebot-plugin-paminet-nodirtymsg
</details>
<details>
<summary>poetry</summary>

    poetry add nonebot-plugin-paminet-nodirtymsg
</details>
<details>
<summary>conda</summary>

    conda install nonebot-plugin-paminet-nodirtymsg
</details>

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

    plugins = ["nonebot-plugin-paminet-nodirtymsg"]

</details>

## ⚙️ 配置

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

| 配置项 | 必填 | 默认值 | 说明 |
|:-----:|:----:|:----:|:----:|
| DIRTY_MSG_FILTER_ENABLE | 否 | True | 是否启用聊天过滤 |
| BADWORDS_DATA_PATH | 否 | "data/badwords.json" | 过滤词文件位置 |
| MAX_RETRIES | 否 | 5 | 消息撤回重试次数 |

## 🎉 使用
### 指令表
用去吧孩子，没指令
### 效果图
暂无

## 📄 许可证

本项目使用 [MIT](./LICENSE) 许可证开源

```txt
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
