<div align="center">
<a href="https://v2.nonebot.dev/store"><img src="https://raw.githubusercontent.com/tkgs0/nbpt/resources/nbp_logo.png" width="180" height="180" alt="NoneBotPluginLogo"></a>
<br>
<p><img src="https://raw.githubusercontent.com/tkgs0/nbpt/resources/NoneBotPlugin.svg" width="240" alt="NoneBotPluginText"></p>
</div>
<div align="center">
# nonebot-plugin-dicky-pk
_✨ NoneBot Dicky-PK ✨_
<a href="./LICENSE">
<img src="https://img.shields.io/github/license/tkgs0/nonebot-plugin-dicky-pk.svg" alt="license">
</a>
<a href="https://pypi.python.org/pypi/nonebot-plugin-dicky-pk">
<img src="https://img.shields.io/pypi/v/nonebot-plugin-dicky-pk.svg" alt="pypi">
</a>
<a href="https://www.python.org">
<img src="https://img.shields.io/badge/python-3.8+-blue.svg" alt="python">
</a>
</div>
## 📖 介绍
移植自 OPQBot 的群聊小游戏 [CHINCHIN-PK](https://github.com/opq-osc/chinchin-pk)
<p>
<img src="https://raw.githubusercontent.com/tkgs0/nonebot-plugin-dicky-pk/resources/dicky_pk.gif" width="150" alt="你不许参加牛子PK">
</p>
## 💿 安装
**nb-cli安装, 包管理器安装 二选一**
<details>
<summary>使用 nb-cli 安装</summary>
在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装
nb plugin install nonebot-plugin-dicky-pk
</details>
<details>
<summary>使用包管理器安装</summary>
在 nonebot2 项目的插件目录下, 打开命令行,
**根据你使用的包管理器, 输入相应的安装命令**
<details>
<summary>pip</summary>
pip install nonebot-plugin-dicky-pk
</details>
<details>
<summary>pdm</summary>
pdm add nonebot-plugin-dicky-pk
</details>
<details>
<summary>poetry</summary>
poetry add nonebot-plugin-dicky-pk
</details>
<details>
<summary>conda</summary>
conda install nonebot-plugin-dicky-pk
</details>
打开 bot项目下的 `pyproject.toml` 文件,
在其 `plugins` 里加入 `nonebot_plugin_dicky_pk`
plugins = ["nonebot_plugin_dicky_pk"]
</details>
</details>
## ⚙️ 配置
首次运行该插件会生成 `Dicky_PK.json` 到Bot项目的 `configs` 文件夹里,
可根据 `Dicky_PK.json` 内的注释进行配置.
## 🎉 使用
### 指令表
**注意:**
以下命令不可省略前缀 `/`
如果bot项目的 `.env` 里只设置了前缀 `/`, 那么你发送以下命令时前缀应该是 `//`
```
/开启(关闭)牛子秘境 # 插件总开关
/牛子帮助 # 查看帮助
/启用(禁用)牛子pk # 插件在群聊的开关
/牛子 # 查看自己的牛子信息
/pk @用户 # 对at的用户进行牛子PK, 一次只能PK一个用户
/🔒(/suo/嗦/锁)我 # 嗦自己的牛子
/🔒(/suo/嗦/锁) @用户 # 嗦at用户的牛子
/打胶 # 安抚自己的牛子
/看他牛子(/看看牛子) @用户 # 查看at用户的牛子
/注册牛子 # 注册属于你的牛子
/牛子排名(/牛子排行) # 查看牛子排行榜
/牛友(/牛子好友/牛子朋友)
/关注牛子(/添加牛友)
/取关牛子(/删除牛友)
/牛子转生
/牛子成就
/牛子仙境
/牛子修炼(/牛子练功/牛子修仙)
```
**注:**
**插件服务默认关闭, 首次运行时需向Bot发送 `/开启牛子秘境`**
群聊发送 `/开启牛子秘境` 同时会在当前群聊启用 `牛子PK`,
`/关闭牛子秘境` 同时会清除所有群聊的开关状态, 但不会删除用户的牛子信息.
Raw data
{
"_id": null,
"home_page": "https://github.com/tkgs0/nonebot-plugin-dicky-pk",
"name": "nonebot-plugin-dicky-pk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "NoneBot,Dicky-PK",
"author": "\u6708\u30f6\u702c",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/31/9f/6bf4fffbd597527da6413f28e489c5e74eef0ad4b8731b29da11b805edb5/nonebot_plugin_dicky_pk-0.5.0.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <a href=\"https://v2.nonebot.dev/store\"><img src=\"https://raw.githubusercontent.com/tkgs0/nbpt/resources/nbp_logo.png\" width=\"180\" height=\"180\" alt=\"NoneBotPluginLogo\"></a>\n <br>\n <p><img src=\"https://raw.githubusercontent.com/tkgs0/nbpt/resources/NoneBotPlugin.svg\" width=\"240\" alt=\"NoneBotPluginText\"></p>\n</div>\n\n<div align=\"center\">\n\n# nonebot-plugin-dicky-pk\n\n_\u2728 NoneBot Dicky-PK \u2728_\n\n\n<a href=\"./LICENSE\">\n <img src=\"https://img.shields.io/github/license/tkgs0/nonebot-plugin-dicky-pk.svg\" alt=\"license\">\n</a>\n<a href=\"https://pypi.python.org/pypi/nonebot-plugin-dicky-pk\">\n <img src=\"https://img.shields.io/pypi/v/nonebot-plugin-dicky-pk.svg\" alt=\"pypi\">\n</a>\n<a href=\"https://www.python.org\">\n <img src=\"https://img.shields.io/badge/python-3.8+-blue.svg\" alt=\"python\">\n</a>\n\n</div>\n\n## \ud83d\udcd6 \u4ecb\u7ecd\n\n\u79fb\u690d\u81ea OPQBot \u7684\u7fa4\u804a\u5c0f\u6e38\u620f [CHINCHIN-PK](https://github.com/opq-osc/chinchin-pk)\n\n<p>\n<img src=\"https://raw.githubusercontent.com/tkgs0/nonebot-plugin-dicky-pk/resources/dicky_pk.gif\" width=\"150\" alt=\"\u4f60\u4e0d\u8bb8\u53c2\u52a0\u725b\u5b50PK\">\n</p>\n\n## \ud83d\udcbf \u5b89\u88c5\n\n**nb-cli\u5b89\u88c5, \u5305\u7ba1\u7406\u5668\u5b89\u88c5 \u4e8c\u9009\u4e00**\n\n<details>\n<summary>\u4f7f\u7528 nb-cli \u5b89\u88c5</summary>\n\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-dicky-pk\n\n</details>\n\n<details>\n<summary>\u4f7f\u7528\u5305\u7ba1\u7406\u5668\u5b89\u88c5</summary>\n\n\u5728 nonebot2 \u9879\u76ee\u7684\u63d2\u4ef6\u76ee\u5f55\u4e0b, \u6253\u5f00\u547d\u4ee4\u884c,\n\n**\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-dicky-pk\n\n</details>\n<details>\n<summary>pdm</summary>\n\n pdm add nonebot-plugin-dicky-pk\n\n</details>\n<details>\n<summary>poetry</summary>\n\n poetry add nonebot-plugin-dicky-pk\n\n</details>\n<details>\n<summary>conda</summary>\n\n conda install nonebot-plugin-dicky-pk\n\n</details>\n\n\u6253\u5f00 bot\u9879\u76ee\u4e0b\u7684 `pyproject.toml` \u6587\u4ef6,\n\n\u5728\u5176 `plugins` \u91cc\u52a0\u5165 `nonebot_plugin_dicky_pk`\n\n plugins = [\"nonebot_plugin_dicky_pk\"]\n\n</details>\n</details>\n\n## \u2699\ufe0f \u914d\u7f6e\n\n\u9996\u6b21\u8fd0\u884c\u8be5\u63d2\u4ef6\u4f1a\u751f\u6210 `Dicky_PK.json` \u5230Bot\u9879\u76ee\u7684 `configs` \u6587\u4ef6\u5939\u91cc,\n\n\u53ef\u6839\u636e `Dicky_PK.json` \u5185\u7684\u6ce8\u91ca\u8fdb\u884c\u914d\u7f6e.\n\n## \ud83c\udf89 \u4f7f\u7528\n\n### \u6307\u4ee4\u8868\n\n**\u6ce8\u610f:**\n\n\u4ee5\u4e0b\u547d\u4ee4\u4e0d\u53ef\u7701\u7565\u524d\u7f00 `/`\n\n\u5982\u679cbot\u9879\u76ee\u7684 `.env` \u91cc\u53ea\u8bbe\u7f6e\u4e86\u524d\u7f00 `/`, \u90a3\u4e48\u4f60\u53d1\u9001\u4ee5\u4e0b\u547d\u4ee4\u65f6\u524d\u7f00\u5e94\u8be5\u662f `//`\n\n```\n/\u5f00\u542f(\u5173\u95ed)\u725b\u5b50\u79d8\u5883 # \u63d2\u4ef6\u603b\u5f00\u5173\n/\u725b\u5b50\u5e2e\u52a9 # \u67e5\u770b\u5e2e\u52a9\n/\u542f\u7528(\u7981\u7528)\u725b\u5b50pk # \u63d2\u4ef6\u5728\u7fa4\u804a\u7684\u5f00\u5173\n/\u725b\u5b50 # \u67e5\u770b\u81ea\u5df1\u7684\u725b\u5b50\u4fe1\u606f\n/pk @\u7528\u6237 # \u5bf9at\u7684\u7528\u6237\u8fdb\u884c\u725b\u5b50PK, \u4e00\u6b21\u53ea\u80fdPK\u4e00\u4e2a\u7528\u6237\n/\ud83d\udd12(/suo/\u55e6/\u9501)\u6211 # \u55e6\u81ea\u5df1\u7684\u725b\u5b50\n/\ud83d\udd12(/suo/\u55e6/\u9501) @\u7528\u6237 # \u55e6at\u7528\u6237\u7684\u725b\u5b50\n/\u6253\u80f6 # \u5b89\u629a\u81ea\u5df1\u7684\u725b\u5b50\n/\u770b\u4ed6\u725b\u5b50(/\u770b\u770b\u725b\u5b50) @\u7528\u6237 # \u67e5\u770bat\u7528\u6237\u7684\u725b\u5b50\n/\u6ce8\u518c\u725b\u5b50 # \u6ce8\u518c\u5c5e\u4e8e\u4f60\u7684\u725b\u5b50\n/\u725b\u5b50\u6392\u540d(/\u725b\u5b50\u6392\u884c) # \u67e5\u770b\u725b\u5b50\u6392\u884c\u699c\n/\u725b\u53cb(/\u725b\u5b50\u597d\u53cb/\u725b\u5b50\u670b\u53cb)\n/\u5173\u6ce8\u725b\u5b50(/\u6dfb\u52a0\u725b\u53cb)\n/\u53d6\u5173\u725b\u5b50(/\u5220\u9664\u725b\u53cb)\n/\u725b\u5b50\u8f6c\u751f\n/\u725b\u5b50\u6210\u5c31\n/\u725b\u5b50\u4ed9\u5883\n/\u725b\u5b50\u4fee\u70bc(/\u725b\u5b50\u7ec3\u529f/\u725b\u5b50\u4fee\u4ed9)\n```\n\n**\u6ce8:**\n\n**\u63d2\u4ef6\u670d\u52a1\u9ed8\u8ba4\u5173\u95ed, \u9996\u6b21\u8fd0\u884c\u65f6\u9700\u5411Bot\u53d1\u9001 `/\u5f00\u542f\u725b\u5b50\u79d8\u5883`**\n\n\u7fa4\u804a\u53d1\u9001 `/\u5f00\u542f\u725b\u5b50\u79d8\u5883` \u540c\u65f6\u4f1a\u5728\u5f53\u524d\u7fa4\u804a\u542f\u7528 `\u725b\u5b50PK`,\n\n`/\u5173\u95ed\u725b\u5b50\u79d8\u5883` \u540c\u65f6\u4f1a\u6e05\u9664\u6240\u6709\u7fa4\u804a\u7684\u5f00\u5173\u72b6\u6001, \u4f46\u4e0d\u4f1a\u5220\u9664\u7528\u6237\u7684\u725b\u5b50\u4fe1\u606f.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Dicky-PK in NoneBot2",
"version": "0.5.0",
"project_urls": {
"Homepage": "https://github.com/tkgs0/nonebot-plugin-dicky-pk",
"Repository": "https://github.com/tkgs0/nonebot-plugin-dicky-pk"
},
"split_keywords": [
"nonebot",
"dicky-pk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "adc47fa1f9ef0ac751ac4e51278a7c1fd5b4dd7e68c8d6cfaf284ca02e1a0ddc",
"md5": "58add32ff613b8366dfabe9ab9be1653",
"sha256": "3b3ed21377725c707f58e00f852bb77740783cc77d0d0e3beb657aaae276777c"
},
"downloads": -1,
"filename": "nonebot_plugin_dicky_pk-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "58add32ff613b8366dfabe9ab9be1653",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 39093,
"upload_time": "2024-02-22T03:54:09",
"upload_time_iso_8601": "2024-02-22T03:54:09.830355Z",
"url": "https://files.pythonhosted.org/packages/ad/c4/7fa1f9ef0ac751ac4e51278a7c1fd5b4dd7e68c8d6cfaf284ca02e1a0ddc/nonebot_plugin_dicky_pk-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "319f6bf4fffbd597527da6413f28e489c5e74eef0ad4b8731b29da11b805edb5",
"md5": "2769cfecdaa7c951d4df6d4ce45ade64",
"sha256": "2256b0ffabe920a470313aaa57eff5a67a54a1fffcf3384ac2f46451d785dae8"
},
"downloads": -1,
"filename": "nonebot_plugin_dicky_pk-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "2769cfecdaa7c951d4df6d4ce45ade64",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 34543,
"upload_time": "2024-02-22T03:54:11",
"upload_time_iso_8601": "2024-02-22T03:54:11.550829Z",
"url": "https://files.pythonhosted.org/packages/31/9f/6bf4fffbd597527da6413f28e489c5e74eef0ad4b8731b29da11b805edb5/nonebot_plugin_dicky_pk-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-22 03:54:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tkgs0",
"github_project": "nonebot-plugin-dicky-pk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nonebot-plugin-dicky-pk"
}
JSON
