<div align="center">
<a href="https://v2.nonebot.dev/store"><img src="https://github.com/fllesser/nonebot-plugin-template/blob/master/.docs/NoneBotPlugin.svg" width="380" height="177" alt="NoneBotPluginLogo"></a>
</div>
<div align="center">
# nonebot-plugin-PPPPP
_✨ NoneBot 插件简单描述 ✨_
<a href="./LICENSE">
<img src="https://img.shields.io/github/license/owner/nonebot-plugin-PPPPP.svg" alt="license">
</a>
<a href="https://pypi.python.org/pypi/nonebot-plugin-PPPPP">
<img src="https://img.shields.io/pypi/v/nonebot-plugin-PPPPP.svg" alt="pypi">
</a>
<img src="https://img.shields.io/badge/python-3.10+-blue.svg" alt="python">
</div>
这是一个 nonebot2 插件项目的模板库, 你可以直接使用本模板创建你的 nonebot2 插件项目的仓库
<details open>
<summary>模板库使用方法</summary>
1. 点击 [](https://github.com/new?template_owner=fllesser&template_name=nonebot-plugin-template&owner=%40me&name=nonebot-plugin-&visibility=public) 创建仓库
2. 在创建好的新仓库中, 在 "Add file" 菜单中选择 "Create new file", 在新文件名处输入`LICENSE`, 此时在右侧会出现一个 "Choose a license template" 按钮, 点击此按钮选择开源协议模板, 然后在最下方提交新文件到主分支
3. 全局替换`owner`为仓库所有者ID; 全局替换`PPPPP`为插件名; 全局替换`ppppp`为包名; 修改 python 徽标中的版本为你插件的运行所需版本
4. 修改 README 中的插件名和插件描述, 并在下方填充相应的内容
</details>
> [!NOTE]
> 模板库中自带了一个发布工作流, 你可以使用此工作流自动发布你的插件到 pypi
<details>
<summary>配置发布工作流</summary>
1. 前往 https://pypi.org/manage/account/#api-tokens 并创建一个新的 API 令牌。创建成功后不要关闭页面，不然你将无法再次查看此令牌。
2. 在单独的浏览器选项卡或窗口中，打开 [Actions secrets and variables](./settings/secrets/actions) 页面。你也可以在 Settings - Secrets and variables - Actions 中找到此页面。
3. 点击 New repository secret 按钮，创建一个名为 `PYPI_API_TOKEN` 的新令牌，并从第一步复制粘贴令牌。
</details>
> [!IMPORTANT]
> 这个发布工作流需要 pyproject.toml 文件, 并且只支持 [PEP 621](https://peps.python.org/pep-0621/) 标准的 pyproject.toml 文件
<details>
<summary>触发发布工作流</summary>
从本地推送任意 tag 即可触发。
创建 tag:
git tag <tag_name>
推送本地所有 tag:
git push origin --tags
</details>
## 📖 介绍
这里是插件的详细介绍部分
## 💿 安装
<details open>
<summary>使用 nb-cli 安装</summary>
在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装
nb plugin install nonebot-plugin-PPPPP
</details>
<details>
<summary>使用包管理器安装</summary>
在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令
<details>
<summary>pip</summary>
pip install nonebot-plugin-PPPPP
</details>
<details>
<summary>pdm</summary>
pdm add nonebot-plugin-PPPPP
</details>
<details>
<summary>poetry</summary>
poetry add nonebot-plugin-PPPPP
</details>
<details>
<summary>conda</summary>
conda install nonebot-plugin-PPPPP
</details>
打开 nonebot2 项目根目录下的 `pyproject.toml` 文件, 在 `[tool.nonebot]` 部分追加写入
plugins = ["nonebot_plugin_ppppp"]
</details>
## ⚙️ 配置
在 nonebot2 项目的`.env`文件中添加下表中的必填配置
| 配置项 | 必填 | 默认值 | 说明 |
|:-----:|:----:|:----:|:----:|
| 配置项1 | 是 | 无 | 配置说明 |
| 配置项2 | 否 | 无 | 配置说明 |
## 🎉 使用
### 指令表
| 指令 | 权限 | 需要@ | 范围 | 说明 |
|:-----:|:----:|:----:|:----:|:----:|
| 指令1 | 主人 | 否 | 私聊 | 指令说明 |
| 指令2 | 群员 | 是 | 群聊 | 指令说明 |
### 效果图
如果有效果图的话
Raw data
{
"_id": null,
"home_page": "https://github.com/fllesser/nonebot-plugin-fornite",
"name": "nonebot-plugin-fornite",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "nonebot, nonebot2",
"author": "fllesser",
"author_email": "fllessive@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a7/ae/6fac1fe9967a7d913a734dffcd4b9bf4f90d5b637b266b856f723526a371/nonebot_plugin_fornite-0.0.1.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <a href=\"https://v2.nonebot.dev/store\"><img src=\"https://github.com/fllesser/nonebot-plugin-template/blob/master/.docs/NoneBotPlugin.svg\" width=\"380\" height=\"177\" alt=\"NoneBotPluginLogo\"></a>\n</div>\n\n<div align=\"center\">\n\n# nonebot-plugin-PPPPP\n\n_\u2728 NoneBot \u63d2\u4ef6\u7b80\u5355\u63cf\u8ff0 \u2728_\n\n\n<a href=\"./LICENSE\">\n <img src=\"https://img.shields.io/github/license/owner/nonebot-plugin-PPPPP.svg\" alt=\"license\">\n</a>\n<a href=\"https://pypi.python.org/pypi/nonebot-plugin-PPPPP\">\n <img src=\"https://img.shields.io/pypi/v/nonebot-plugin-PPPPP.svg\" alt=\"pypi\">\n</a>\n<img src=\"https://img.shields.io/badge/python-3.10+-blue.svg\" alt=\"python\">\n\n</div>\n\n\u8fd9\u662f\u4e00\u4e2a nonebot2 \u63d2\u4ef6\u9879\u76ee\u7684\u6a21\u677f\u5e93, \u4f60\u53ef\u4ee5\u76f4\u63a5\u4f7f\u7528\u672c\u6a21\u677f\u521b\u5efa\u4f60\u7684 nonebot2 \u63d2\u4ef6\u9879\u76ee\u7684\u4ed3\u5e93\n\n<details open>\n<summary>\u6a21\u677f\u5e93\u4f7f\u7528\u65b9\u6cd5</summary>\n\n1. \u70b9\u51fb [](https://github.com/new?template_owner=fllesser&template_name=nonebot-plugin-template&owner=%40me&name=nonebot-plugin-&visibility=public) \u521b\u5efa\u4ed3\u5e93\n2. \u5728\u521b\u5efa\u597d\u7684\u65b0\u4ed3\u5e93\u4e2d, \u5728 \"Add file\" \u83dc\u5355\u4e2d\u9009\u62e9 \"Create new file\", \u5728\u65b0\u6587\u4ef6\u540d\u5904\u8f93\u5165`LICENSE`, \u6b64\u65f6\u5728\u53f3\u4fa7\u4f1a\u51fa\u73b0\u4e00\u4e2a \"Choose a license template\" \u6309\u94ae, \u70b9\u51fb\u6b64\u6309\u94ae\u9009\u62e9\u5f00\u6e90\u534f\u8bae\u6a21\u677f, \u7136\u540e\u5728\u6700\u4e0b\u65b9\u63d0\u4ea4\u65b0\u6587\u4ef6\u5230\u4e3b\u5206\u652f\n3. \u5168\u5c40\u66ff\u6362`owner`\u4e3a\u4ed3\u5e93\u6240\u6709\u8005ID; \u5168\u5c40\u66ff\u6362`PPPPP`\u4e3a\u63d2\u4ef6\u540d; \u5168\u5c40\u66ff\u6362`ppppp`\u4e3a\u5305\u540d; \u4fee\u6539 python \u5fbd\u6807\u4e2d\u7684\u7248\u672c\u4e3a\u4f60\u63d2\u4ef6\u7684\u8fd0\u884c\u6240\u9700\u7248\u672c\n4. \u4fee\u6539 README \u4e2d\u7684\u63d2\u4ef6\u540d\u548c\u63d2\u4ef6\u63cf\u8ff0, \u5e76\u5728\u4e0b\u65b9\u586b\u5145\u76f8\u5e94\u7684\u5185\u5bb9\n\n</details>\n\n> [!NOTE]\n> \u6a21\u677f\u5e93\u4e2d\u81ea\u5e26\u4e86\u4e00\u4e2a\u53d1\u5e03\u5de5\u4f5c\u6d41, \u4f60\u53ef\u4ee5\u4f7f\u7528\u6b64\u5de5\u4f5c\u6d41\u81ea\u52a8\u53d1\u5e03\u4f60\u7684\u63d2\u4ef6\u5230 pypi\n\n<details>\n<summary>\u914d\u7f6e\u53d1\u5e03\u5de5\u4f5c\u6d41</summary>\n\n1. \u524d\u5f80 https://pypi.org/manage/account/#api-tokens \u5e76\u521b\u5efa\u4e00\u4e2a\u65b0\u7684 API \u4ee4\u724c\u3002\u521b\u5efa\u6210\u529f\u540e\u4e0d\u8981\u5173\u95ed\u9875\u9762\uff0c\u4e0d\u7136\u4f60\u5c06\u65e0\u6cd5\u518d\u6b21\u67e5\u770b\u6b64\u4ee4\u724c\u3002\n2. \u5728\u5355\u72ec\u7684\u6d4f\u89c8\u5668\u9009\u9879\u5361\u6216\u7a97\u53e3\u4e2d\uff0c\u6253\u5f00 [Actions secrets and variables](./settings/secrets/actions) \u9875\u9762\u3002\u4f60\u4e5f\u53ef\u4ee5\u5728 Settings - Secrets and variables - Actions \u4e2d\u627e\u5230\u6b64\u9875\u9762\u3002\n3. \u70b9\u51fb New repository secret \u6309\u94ae\uff0c\u521b\u5efa\u4e00\u4e2a\u540d\u4e3a `PYPI_API_TOKEN` \u7684\u65b0\u4ee4\u724c\uff0c\u5e76\u4ece\u7b2c\u4e00\u6b65\u590d\u5236\u7c98\u8d34\u4ee4\u724c\u3002\n\n</details>\n\n> [!IMPORTANT]\n> \u8fd9\u4e2a\u53d1\u5e03\u5de5\u4f5c\u6d41\u9700\u8981 pyproject.toml \u6587\u4ef6, \u5e76\u4e14\u53ea\u652f\u6301 [PEP 621](https://peps.python.org/pep-0621/) \u6807\u51c6\u7684 pyproject.toml \u6587\u4ef6\n\n<details>\n<summary>\u89e6\u53d1\u53d1\u5e03\u5de5\u4f5c\u6d41</summary>\n\u4ece\u672c\u5730\u63a8\u9001\u4efb\u610f tag \u5373\u53ef\u89e6\u53d1\u3002\n\n\u521b\u5efa tag:\n\n git tag <tag_name>\n\n\u63a8\u9001\u672c\u5730\u6240\u6709 tag:\n\n git push origin --tags\n\n</details>\n\n## \ud83d\udcd6 \u4ecb\u7ecd\n\n\u8fd9\u91cc\u662f\u63d2\u4ef6\u7684\u8be6\u7ec6\u4ecb\u7ecd\u90e8\u5206\n\n## \ud83d\udcbf \u5b89\u88c5\n\n<details open>\n<summary>\u4f7f\u7528 nb-cli \u5b89\u88c5</summary>\n\u5728 nonebot2 \u9879\u76ee\u7684\u6839\u76ee\u5f55\u4e0b\u6253\u5f00\u547d\u4ee4\u884c, \u8f93\u5165\u4ee5\u4e0b\u6307\u4ee4\u5373\u53ef\u5b89\u88c5\n\n nb plugin install nonebot-plugin-PPPPP\n\n</details>\n\n<details>\n<summary>\u4f7f\u7528\u5305\u7ba1\u7406\u5668\u5b89\u88c5</summary>\n\u5728 nonebot2 \u9879\u76ee\u7684\u63d2\u4ef6\u76ee\u5f55\u4e0b, \u6253\u5f00\u547d\u4ee4\u884c, \u6839\u636e\u4f60\u4f7f\u7528\u7684\u5305\u7ba1\u7406\u5668, \u8f93\u5165\u76f8\u5e94\u7684\u5b89\u88c5\u547d\u4ee4\n\n<details>\n<summary>pip</summary>\n\n pip install nonebot-plugin-PPPPP\n</details>\n<details>\n<summary>pdm</summary>\n\n pdm add nonebot-plugin-PPPPP\n</details>\n<details>\n<summary>poetry</summary>\n\n poetry add nonebot-plugin-PPPPP\n</details>\n<details>\n<summary>conda</summary>\n\n conda install nonebot-plugin-PPPPP\n</details>\n\n\u6253\u5f00 nonebot2 \u9879\u76ee\u6839\u76ee\u5f55\u4e0b\u7684 `pyproject.toml` \u6587\u4ef6, \u5728 `[tool.nonebot]` \u90e8\u5206\u8ffd\u52a0\u5199\u5165\n\n plugins = [\"nonebot_plugin_ppppp\"]\n\n</details>\n\n## \u2699\ufe0f \u914d\u7f6e\n\n\u5728 nonebot2 \u9879\u76ee\u7684`.env`\u6587\u4ef6\u4e2d\u6dfb\u52a0\u4e0b\u8868\u4e2d\u7684\u5fc5\u586b\u914d\u7f6e\n\n| \u914d\u7f6e\u9879 | \u5fc5\u586b | \u9ed8\u8ba4\u503c | \u8bf4\u660e |\n|:-----:|:----:|:----:|:----:|\n| \u914d\u7f6e\u98791 | \u662f | \u65e0 | \u914d\u7f6e\u8bf4\u660e |\n| \u914d\u7f6e\u98792 | \u5426 | \u65e0 | \u914d\u7f6e\u8bf4\u660e |\n\n## \ud83c\udf89 \u4f7f\u7528\n### \u6307\u4ee4\u8868\n| \u6307\u4ee4 | \u6743\u9650 | \u9700\u8981@ | \u8303\u56f4 | \u8bf4\u660e |\n|:-----:|:----:|:----:|:----:|:----:|\n| \u6307\u4ee41 | \u4e3b\u4eba | \u5426 | \u79c1\u804a | \u6307\u4ee4\u8bf4\u660e |\n| \u6307\u4ee42 | \u7fa4\u5458 | \u662f | \u7fa4\u804a | \u6307\u4ee4\u8bf4\u660e |\n### \u6548\u679c\u56fe\n\u5982\u679c\u6709\u6548\u679c\u56fe\u7684\u8bdd\n\n",
"bugtrack_url": null,
"license": null,
"summary": "\u5821\u5792\u4e4b\u591c\u63d2\u4ef6",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/fllesser/nonebot-plugin-fornite",
"Repository": "https://github.com/fllesser/nonebot-plugin-fornite"
},
"split_keywords": [
"nonebot",
" nonebot2"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b5e7e3c7728f65a4698fa32a58bd0886bc411a012fe50c60eed5316d6d3cdc37",
"md5": "8875c6cb45462b62735bc8666e0d3b7d",
"sha256": "e61788b1022beb74ace21b6552da6044021f093059497871fac0a141457fbb2e"
},
"downloads": -1,
"filename": "nonebot_plugin_fornite-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8875c6cb45462b62735bc8666e0d3b7d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 9630,
"upload_time": "2025-01-08T08:08:36",
"upload_time_iso_8601": "2025-01-08T08:08:36.723629Z",
"url": "https://files.pythonhosted.org/packages/b5/e7/e3c7728f65a4698fa32a58bd0886bc411a012fe50c60eed5316d6d3cdc37/nonebot_plugin_fornite-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a7ae6fac1fe9967a7d913a734dffcd4b9bf4f90d5b637b266b856f723526a371",
"md5": "dfc75254d88ec1ee5f1d171af5a91302",
"sha256": "7d10d671cfd0da06fd366747cb70e0c8f860e3094f437ca08200da87286c6ab2"
},
"downloads": -1,
"filename": "nonebot_plugin_fornite-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "dfc75254d88ec1ee5f1d171af5a91302",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 8318,
"upload_time": "2025-01-08T08:08:37",
"upload_time_iso_8601": "2025-01-08T08:08:37.996314Z",
"url": "https://files.pythonhosted.org/packages/a7/ae/6fac1fe9967a7d913a734dffcd4b9bf4f90d5b637b266b856f723526a371/nonebot_plugin_fornite-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-08 08:08:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fllesser",
"github_project": "nonebot-plugin-fornite",
"github_not_found": true,
"lcname": "nonebot-plugin-fornite"
}
JSON
