nonebot-plugin-maimaidx


Namenonebot-plugin-maimaidx JSON
Version 1.0.13 PyPI version JSON
download
home_pageNone
Summarymaimaidx plugin for nonebot2
upload_time2024-08-09 04:02:07
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <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>
</div>

<div align='center'>

# nonebot-plugin-maimaidx

<a href='./LICENSE'>
    <img src='https://img.shields.io/github/license/Yuri-YuzuChaN/nonebot-plugin-maimaidx' alt='license'>
</a>
<img src='https://img.shields.io/badge/python-3.8+-blue.svg' alt='python'>
</div>


## 重要更新

**2024-07-23**

1. 更新部分牌子完成表和 `SyncPlay` 图片,下载更新图片包 `Update.zip` 解压,将 `static` 复制并覆盖。**如果怕缺少图片请进行[使用方法第二步](#使用方法)**
   - [私人云盘](https://share.yuzuchan.moe/d/aria/Update.zip?sign=PFnIZpgyB_HptU-hHIQ-S_qhuuGTNDlmEEtmaEpmJlA=:0)
   - [onedrive](https://yuzuai-my.sharepoint.com/:u:/g/personal/yuzuchan_yuzuai_onmicrosoft_com/EcFTIQemNF9NlNQj8RZSdhABiV64tFi-X8-8a7JKxfEKJQ?e=P5nPnx)
2. 修复 `牌子进度` 指令 `sync` 未匹配的问题
3. 修复 `别名查歌` 指令查询到已删除的曲目时发生错误的问题

## 安装

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. 安装 `PhantomJS`,前往 https://phantomjs.org/download.html 下载对应平台支持

> [!WARNING]
> 未配置 `PhantomJS` 支持的Bot,在使用 `ginfo` 指令时会被强制关闭 Bot 进程

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

    - [私人云盘](https://share.yuzuchan.moe/d/aria/Resource.zip?sign=LOqwqDVm95dYnkEDYKX2E-VGj0xc_JxrsFnuR1BcvtI=:0)
    - [onedrive](https://yuzuai-my.sharepoint.com/:u:/g/personal/yuzuchan_yuzuai_onmicrosoft_com/EaS3jPYdMwxGiU3V_V64nRIBk6QA5Gdhs2TkJQ2bLssxbw?e=Mm6cWY)

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

    ``` dotenv
    MAIMAIDXPATH=path.to.static

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

3. 在 `.env` 文件夹中配置 `MAIMAIDXTOKEN`
   
    ``` dotenv
    # 如果没有 `diving-fish 查分器` 的开发者 `Token`,请直接留空
    MAIMAIDXTOKEN=
    # 如果有请填入 `Token`
    MAIMAIDXTOKEN=MAIMAITOKEN
    ```

> [!NOTE]
> 插件带有别名更新推送功能,如果不需要请私聊Bot使用 `全局关闭别名推送` 指令关闭所有群组推送

## 指令

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

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "nonebot-plugin-maimaidx",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Yuri-YuzuChaN <806235364@qq.com>",
    "download_url": "https://files.pythonhosted.org/packages/9d/3e/73195d0c95f953f65e5adb6828f53e85e5150c0dc2a090a073752e89cbe5/nonebot_plugin_maimaidx-1.0.13.tar.gz",
    "platform": null,
    "description": "<div align='center'>\r\n    <a><img src='https://raw.githubusercontent.com/Yuri-YuzuChaN/nonebot-plugin-maimaidx/master/favicon.png' width='200px' height='200px' akt='maimaidx'></a>\r\n</div>\r\n\r\n<div align='center'>\r\n\r\n# nonebot-plugin-maimaidx\r\n\r\n<a href='./LICENSE'>\r\n    <img src='https://img.shields.io/github/license/Yuri-YuzuChaN/nonebot-plugin-maimaidx' alt='license'>\r\n</a>\r\n<img src='https://img.shields.io/badge/python-3.8+-blue.svg' alt='python'>\r\n</div>\r\n\r\n\r\n## \u91cd\u8981\u66f4\u65b0\r\n\r\n**2024-07-23**\r\n\r\n1. \u66f4\u65b0\u90e8\u5206\u724c\u5b50\u5b8c\u6210\u8868\u548c `SyncPlay` \u56fe\u7247\uff0c\u4e0b\u8f7d\u66f4\u65b0\u56fe\u7247\u5305 `Update.zip` \u89e3\u538b\uff0c\u5c06 `static` \u590d\u5236\u5e76\u8986\u76d6\u3002**\u5982\u679c\u6015\u7f3a\u5c11\u56fe\u7247\u8bf7\u8fdb\u884c[\u4f7f\u7528\u65b9\u6cd5\u7b2c\u4e8c\u6b65](#\u4f7f\u7528\u65b9\u6cd5)**\r\n   - [\u79c1\u4eba\u4e91\u76d8](https://share.yuzuchan.moe/d/aria/Update.zip?sign=PFnIZpgyB_HptU-hHIQ-S_qhuuGTNDlmEEtmaEpmJlA=:0)\r\n   - [onedrive](https://yuzuai-my.sharepoint.com/:u:/g/personal/yuzuchan_yuzuai_onmicrosoft_com/EcFTIQemNF9NlNQj8RZSdhABiV64tFi-X8-8a7JKxfEKJQ?e=P5nPnx)\r\n2. \u4fee\u590d `\u724c\u5b50\u8fdb\u5ea6` \u6307\u4ee4 `sync` \u672a\u5339\u914d\u7684\u95ee\u9898\r\n3. \u4fee\u590d `\u522b\u540d\u67e5\u6b4c` \u6307\u4ee4\u67e5\u8be2\u5230\u5df2\u5220\u9664\u7684\u66f2\u76ee\u65f6\u53d1\u751f\u9519\u8bef\u7684\u95ee\u9898\r\n\r\n## \u5b89\u88c5\r\n\r\n1. \u5b89\u88c5 `nonebot-plugin-maimaidx`\r\n\r\n    - \u4f7f\u7528 `nb-cli` \u5b89\u88c5\r\n        ``` python\r\n        nb plugin install nonebot-plugin-maimaidx\r\n        ```\r\n    - \u4f7f\u7528 `pip` \u5b89\u88c5\r\n        ``` python\r\n        pip install nonebot-plugin-maimaidx\r\n        ```\r\n    - \u4f7f\u7528\u6e90\u4ee3\u7801\uff08\u4e0d\u63a8\u8350\uff09 **\u9700\u81ea\u884c\u5b89\u88c5\u989d\u5916\u4f9d\u8d56**\r\n        ``` git\r\n        git clone https://github.com/Yuri-YuzuChaN/nonebot-plugin-maimaidx\r\n        ```\r\n    \r\n2. \u5b89\u88c5 `PhantomJS`\uff0c\u524d\u5f80 https://phantomjs.org/download.html \u4e0b\u8f7d\u5bf9\u5e94\u5e73\u53f0\u652f\u6301\r\n\r\n> [!WARNING]\r\n> \u672a\u914d\u7f6e `PhantomJS` \u652f\u6301\u7684Bot\uff0c\u5728\u4f7f\u7528 `ginfo` \u6307\u4ee4\u65f6\u4f1a\u88ab\u5f3a\u5236\u5173\u95ed Bot \u8fdb\u7a0b\r\n\r\n## \u914d\u7f6e\r\n   \r\n1. \u4e0b\u8f7d\u9759\u6001\u8d44\u6e90\u6587\u4ef6\uff0c\u5c06\u8be5\u538b\u7f29\u6587\u4ef6\u89e3\u538b\uff0c\u4e14\u89e3\u538b\u5b8c\u4e3a\u6587\u4ef6\u5939 `static`\r\n\r\n    - [\u79c1\u4eba\u4e91\u76d8](https://share.yuzuchan.moe/d/aria/Resource.zip?sign=LOqwqDVm95dYnkEDYKX2E-VGj0xc_JxrsFnuR1BcvtI=:0)\r\n    - [onedrive](https://yuzuai-my.sharepoint.com/:u:/g/personal/yuzuchan_yuzuai_onmicrosoft_com/EaS3jPYdMwxGiU3V_V64nRIBk6QA5Gdhs2TkJQ2bLssxbw?e=Mm6cWY)\r\n\r\n2. \u5728 `.env` \u6587\u4ef6\u4e2d\u914d\u7f6e\u9759\u6001\u6587\u4ef6\u7edd\u5bf9\u8def\u5f84 `MAIMAIDXPATH`\r\n\r\n    ``` dotenv\r\n    MAIMAIDXPATH=path.to.static\r\n\r\n    # \u4f8b\u5982 windows \u5e73\u53f0\uff0c\u975e \"\u7ba1\u7406\u5458\u6a21\u5f0f\" \u8fd0\u884cBot\u5c3d\u91cf\u907f\u514d\u5b58\u653e\u5728C\u76d8\r\n    MAIMAIDXPATH=D:\\bot\\static\r\n    # \u4f8b\u5982 linux \u5e73\u53f0\r\n    MAIMAIDXPATH=/root/static\r\n    ```\r\n\r\n3. \u5728 `.env` \u6587\u4ef6\u5939\u4e2d\u914d\u7f6e `MAIMAIDXTOKEN`\r\n   \r\n    ``` dotenv\r\n    # \u5982\u679c\u6ca1\u6709 `diving-fish \u67e5\u5206\u5668` \u7684\u5f00\u53d1\u8005 `Token`\uff0c\u8bf7\u76f4\u63a5\u7559\u7a7a\r\n    MAIMAIDXTOKEN=\r\n    # \u5982\u679c\u6709\u8bf7\u586b\u5165 `Token`\r\n    MAIMAIDXTOKEN=MAIMAITOKEN\r\n    ```\r\n\r\n> [!NOTE]\r\n> \u63d2\u4ef6\u5e26\u6709\u522b\u540d\u66f4\u65b0\u63a8\u9001\u529f\u80fd\uff0c\u5982\u679c\u4e0d\u9700\u8981\u8bf7\u79c1\u804aBot\u4f7f\u7528 `\u5168\u5c40\u5173\u95ed\u522b\u540d\u63a8\u9001` \u6307\u4ee4\u5173\u95ed\u6240\u6709\u7fa4\u7ec4\u63a8\u9001\r\n\r\n## \u6307\u4ee4\r\n\r\n![img](https://raw.githubusercontent.com/Yuri-YuzuChaN/nonebot-plugin-maimaidx/master/nonebot_plugin_maimaidx/maimaidxhelp.png)\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "maimaidx plugin for nonebot2",
    "version": "1.0.13",
    "project_urls": {
        "Bug Tracker": "https://github.com/Yuri-YuzuChaN/nonebot-plugin-maimaidx/issues",
        "Homepage": "https://github.com/Yuri-YuzuChaN/nonebot-plugin-maimaidx"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e093e95fbbcd20185f7cddcb24aee12420bcbc34dcdca437e6584fdfc1ae739d",
                "md5": "284e1f833106e3639e8c9fc8d29be413",
                "sha256": "470a44e0fe1feebd51b8fb7805c04c21d538566e6e72375ec1468c390d54a2d6"
            },
            "downloads": -1,
            "filename": "nonebot_plugin_maimaidx-1.0.13-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "284e1f833106e3639e8c9fc8d29be413",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 1069855,
            "upload_time": "2024-08-09T04:02:04",
            "upload_time_iso_8601": "2024-08-09T04:02:04.333815Z",
            "url": "https://files.pythonhosted.org/packages/e0/93/e95fbbcd20185f7cddcb24aee12420bcbc34dcdca437e6584fdfc1ae739d/nonebot_plugin_maimaidx-1.0.13-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9d3e73195d0c95f953f65e5adb6828f53e85e5150c0dc2a090a073752e89cbe5",
                "md5": "76306b4cbbef80120f15b288b340042d",
                "sha256": "366db8da1e60d97adb27800371502244e124aac47de1e9591a3444739643496f"
            },
            "downloads": -1,
            "filename": "nonebot_plugin_maimaidx-1.0.13.tar.gz",
            "has_sig": false,
            "md5_digest": "76306b4cbbef80120f15b288b340042d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 1041469,
            "upload_time": "2024-08-09T04:02:07",
            "upload_time_iso_8601": "2024-08-09T04:02:07.330195Z",
            "url": "https://files.pythonhosted.org/packages/9d/3e/73195d0c95f953f65e5adb6828f53e85e5150c0dc2a090a073752e89cbe5/nonebot_plugin_maimaidx-1.0.13.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-09 04:02:07",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Yuri-YuzuChaN",
    "github_project": "nonebot-plugin-maimaidx",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "nonebot-plugin-maimaidx"
}
        
Elapsed time: 0.29795s