Metadata-Version: 2.4
Name: nonebot-plugin-maimaidx
Version: 2.1.4
Summary: maimaidx plugin for nonebot2
Author-email: Yuri-YuzuChaN <806235364@qq.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/Yuri-YuzuChaN/nonebot-plugin-maimaidx
Project-URL: Bug Tracker, https://github.com/Yuri-YuzuChaN/nonebot-plugin-maimaidx/issues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: nonebot2<3.0.0,>=2.0.0
Requires-Dist: nonebot-adapter-onebot<3.0.0,>=2.2.2
Requires-Dist: nonebot-plugin-apscheduler<1.0.0,>=0.3.0
Requires-Dist: aiofiles<24.0.0,>=23.2.1
Requires-Dist: httpx<1.0.0,>=0.23.1
Requires-Dist: pydantic<3.0.0,>=2.0.0
Requires-Dist: pyecharts<3.0.0,>=2.0.0
Requires-Dist: playwright>=1.52.0
Requires-Dist: httpx-ws<1.0.0,>=0.7.2
Requires-Dist: pillow<11.0.0,>=10.0.0; python_version < "3.13"
Requires-Dist: pillow<12.0.0,>=11.0.0; python_version >= "3.13"
Requires-Dist: numpy==1.26.0; python_version < "3.10"
Requires-Dist: numpy<3.0.0,>=2.0.0; python_version >= "3.10"
Dynamic: license-file

<div align='center'>

<a><img src='https://raw.githubusercontent.com/Yuri-YuzuChaN/nonebot-plugin-maimaidx/master/favicon.png' width='200px' height='200px' akt='maimaidx'></a>

[![python3](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/)
[![QQGroup](https://img.shields.io/badge/QQGroup-Join-blue)](https://qm.qq.com/q/gDIf3fGSPe)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)

</div>


## 重要更新

**2025-08-16**

1. 修改别名推送机制，请各开发者进行取舍
   
   - 更新别名推送设置与指令，新增了 `MAIMAIDXALIASPUSH` 配置项，该设置将替代原先 `group_alias_switch.json` 文件的 `global_switch` 配置项
   - 当设置为`false` 时，不再连接别名推送服务器，如果群组的推送为开启状态，也不再进行推送，**与原先一致**。**申请的别名通过审核了也不再推送**

    ``` ujson
    {
        "enable": [],
        "disable": [88888888],
        "global_switch": false      // 该配置项将被代替并删除
    }
    ```

   - 不会接收到别名申请以及别名通过的消息，**如果服务器新增新的别名时无法实时获取最新的别名，仅能手动更新别名库**。

2. 指令 `全局开启/关闭别名推送` 的功能将修改为开关全部群组的推送开关。
3. 新增别名推送服务器代理地址，修改 `.env` 的 `MAIMAIDXALIASPROXY` 配置项即可，~~其实是忘记添加代理地址~~

## 温馨提示

**首次使用请务必看完 `README.MD` 所有内容**

- 不要再问为什么 `资源文件` 的 `plate` 和 `rating` 文件夹是空的或缺少文件
- 不要再问为什么 `资源文件` 的 `plate` 和 `rating` 文件夹是空的或缺少文件
- 不要再问为什么 `资源文件` 的 `plate` 和 `rating` 文件夹是空的或缺少文件

## 安装


1. 安装 `nonebot-plugin-maimaidx`

    - 使用 `nb-cli` 安装
        ``` python
        nb plugin install nonebot-plugin-maimaidx
        ```
    - 使用 `pip` 安装
        ``` python
        pip install nonebot-plugin-maimaidx
        ```
    - 使用源代码（不推荐） **需自行安装额外依赖**
        ``` git
        git clone https://github.com/Yuri-YuzuChaN/nonebot-plugin-maimaidx
        ```
    
2. 安装 `chromium`，**相关依赖已安装，请直接使用该指令执行**

    ``` shell
    playwright install --with-deps chromium
    ```

3. 安装 `微软雅黑` 字体，解决使用 `ginfo` 指令字体不渲染的问题，例如 `ubuntu`：`apt install fonts-wqy-microhei`


## 配置
   
1. 下载静态资源文件，将该压缩文件解压，且解压完为文件夹 `static`

   - [Cloudreve私人云盘](https://cloud.yuzuchan.moe/f/1bUn/Resource.7z)
   - [onedrive](https://yuzuai-my.sharepoint.com/:u:/g/personal/yuzu_yuzuchan_moe/EdGUKRSo-VpHjT2noa_9EroBdFZci-tqWjVZzKZRTEeZkw?e=a1TM40)

2. 在 `.env` 文件中配置静态文件绝对路径 `MAIMAIDXPATH`

    ``` dotenv
    MAIMAIDXPATH=path.to.static

    # 例如 windows 平台，非 "管理员模式" 运行Bot尽量避免存放在C盘
    MAIMAIDXPATH=D:\bot\static
    # 例如 linux 平台
    MAIMAIDXPATH=/root/static
    ```

3. 可选，如果拥有 `diving-fish 查分器` 的开发者 `Token`，请在 `.env` 文件中配置 `MAIMAIDXTOKEN`
   
    ``` dotenv
    MAIMAIDXTOKEN=MAIMAITOKEN
    ```

4. 可选，如果你的服务器或主机不能顺利流畅的访问查分器和别名库的API，请在 `.env` 文件中配置代理。均为香港服务器代理中转，例如你的服务器访问查分器很困难，请设置 `MAIMAIDXPROBERPROXY` 为 `true`，别名库同理

    ``` dotenv
    # 查分器代理，推荐境外服务器使用
    MAIMAIDXPROBERPROXY=false
    # 别名代理，推荐国内服务器使用
    MAIMAIDXALIASPROXY=false
    ```

5. 可选，是否开启别名推送，不需要请在 `.env` 文件中配置 `MAIMAIDXALIASPUSH` 为 `false`，**注意，该配置为 `false` 时，将不会实时更新别名库，仅会在别名查歌或者跨日更新数据的时候才会更新别名库。如果群组的推送为开启状态，也不再进行推送，推送指令也一并失效**
   
    ``` dotenv
    MAIMAIDXALIASPUSH=false
    ```

6. 可选，是否将部分图片在保存在内存中，不需要请在 `.env` 文件中配置 `SAVEINMEM` 为 `false`

    ``` dotenv
    SAVEINMEM=false
    ```

> [!NOTE]
> 安装完插件需要使用定数表或完成表指令时，需私聊Bot使用 `更新定数表` 和 `更新完成表` 进行生成

> [!NOTE]
> 插件带有别名更新推送功能，默认开启全部群组推送，不需要请私聊Bot使用 `全局关闭别名推送` 指令关闭所有群组推送。群组需要单独使用请使用指令 `开启别名推送`。

## 指令

![img](https://raw.githubusercontent.com/Yuri-YuzuChaN/nonebot-plugin-maimaidx/master/nonebot_plugin_maimaidx/maimaidxhelp.png)
