nonebot-plugin-fishing2 0.0.1__tar.gz

nonebot_plugin_fishing2-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Polaris_Light
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.

nonebot_plugin_fishing2-0.0.1/PKG-INFO

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: nonebot-plugin-fishing2
+Version: 0.0.1
+Summary: 更好的电子钓鱼
+Author-email: ALittleBot <160833462+C14H22O@users.noreply.github.com>, Polaris_Light <995905922@qq.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/FDCraft/nonebot-plugin-fishing2
+Keywords: fishing
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: nonebot2>=2.2.1
+Requires-Dist: nonebot-adapter-onebot>=2.0.0-beta.1
+Requires-Dist: pydantic>=1.10
+Requires-Dist: nonebot-plugin-localstore>=0.6.0
+Requires-Dist: sqlalchemy>=2.0.27
+Requires-Dist: aiosqlite>=0.20.0
+Requires-Dist: nonebot-plugin-orm>=0.7.1
+Dynamic: license-file
+
+<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-fishing2
+
+_✨ 更好的电子钓鱼 ✨_
+
+<a href="./LICENSE">
+    <img src="https://img.shields.io/github/license/FDCraft/nonebot-plugin-fishing2.svg" alt="license">
+</a>
+<a href="https://pypi.python.org/pypi/nonebot-plugin-fishing2">
+    <img src="https://img.shields.io/pypi/v/nonebot-plugin-fishing2.svg" alt="pypi">
+</a>
+<img src="https://img.shields.io/badge/python-3.8+-blue.svg" alt="python">
+
+</div>
+
+## 💿 安装
+
+<details open>
+<summary>使用 nb-cli 安装</summary>
+在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装
+
+    nb plugin install nonebot-plugin-fishing2
+
+</details>
+
+<details>
+<summary>使用包管理器安装</summary>
+在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令
+
+<details>
+<summary>pip</summary>
+
+    pip install nonebot-plugin-fishing2
+</details>
+<details>
+<summary>pdm</summary>
+
+    pdm add nonebot-plugin-fishing2
+</details>
+<details>
+<summary>poetry</summary>
+
+    poetry add nonebot-plugin-fishing2
+</details>
+<details>
+<summary>conda</summary>
+
+    conda install nonebot-plugin-fishing2
+</details>
+
+打开 nonebot2 项目根目录下的 `pyproject.toml` 文件, 在 `[tool.nonebot]` 部分追加写入
+
+    plugins = ["nonebot_plugin_fishing2"]
+
+</details>
+
+注意：安装过后，需在控制台输入 `nb orm upgrade` 指令以初始化数据库。
+
+## ⚙️ 配置
+
+在 nonebot2 项目的`.env`文件中添加下表中的必填配置
+
+| 配置项 | 必填 | 说明 |
+|:-----:|:----:|:----:|
+| fishes | 否 | 配置鱼塘内鱼们的名称、权重、等待时间和价格 |
+| fishing_limit | 否 | 填入每次钓鱼后，限制钓鱼的秒数 |
+| fishing_coin_name | 否 | 填入卖鱼获取的货币名称 |
+| special_fish_enabled | 否 | 是否启用赛博放生功能（默认为否） |
+| special_fish_price | 否 | 每放生一次所需的货币数量 |
+| special_fish_probability | 否 | 钓鱼时钓到用户放生的鱼的概率 |
+
+其中 `fishes` 配置项说明如下：
+
+```dotenv
+FISHES='
+[
+  {
+    "name": "小鱼", # 鱼的名称
+    "frequency": 2, # 鱼上钩的时间
+    "weight": 100, # 权重
+    "price": 2 # 价格
+  }
+]
+'
+```
+
+## 🔨 更新
+
+每一次更新后，需执行 `nb orm upgrade`。
+
+## 🎉 使用
+
+### 指令表
+| 指令 | 范围 | 说明 |
+|:-----:|:----:|:----:|
+| 钓鱼 | 所有 | 放下鱼竿 |
+| 卖鱼 | 所有 | 获取货币 |
+| 放生 | 所有 | 赛博放生 |
+| 祈愿 | 所有 | 向神祈愿 |
+| 背包 | 所有 | 查看背包 |
+| 成就 | 所有 | 查看成就 |
+| 排行榜 | 所有 | 富翁排行 |
+
+### 赛博放生
+
+当用户使用货币放生由自己取名的一条鱼后，每个用户在钓鱼时都有机会钓到那一条鱼。但此功能开关 `special_fish_enabled` 默认关闭，原因是用户生成内容如果不符合规范，可能导致出现不可预料的情况，请谨慎开启。
+
+
+## 📝 Todo
+
+- [x] 重写数据库逻辑（改为使用 [nonebot/plugin-orm](https://github.com/nonebot/plugin-orm)）
+- [x] 增加系统商店，卖出钓到的鱼们
+- [x] 赛博放生 [#4](https://github.com/C14H22O/nonebot-plugin-fishing/issues/4) （已基本完成）
+- [ ] 使用 [nonebot_plugin_chikari_economy](https://github.com/mrqx0195/nonebot_plugin_chikari_economy) 经济系统
+- [ ] 为鱼竿增加耐久度，耐久度为0时需重新购买鱼竿
+- [ ] 为钓鱼背包添加排序
+- [x] 添加成就系统

nonebot_plugin_fishing2-0.0.1/README.md

@@ -0,0 +1,124 @@
+<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-fishing2
+
+_✨ 更好的电子钓鱼 ✨_
+
+<a href="./LICENSE">
+    <img src="https://img.shields.io/github/license/FDCraft/nonebot-plugin-fishing2.svg" alt="license">
+</a>
+<a href="https://pypi.python.org/pypi/nonebot-plugin-fishing2">
+    <img src="https://img.shields.io/pypi/v/nonebot-plugin-fishing2.svg" alt="pypi">
+</a>
+<img src="https://img.shields.io/badge/python-3.8+-blue.svg" alt="python">
+
+</div>
+
+## 💿 安装
+
+<details open>
+<summary>使用 nb-cli 安装</summary>
+在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装
+
+    nb plugin install nonebot-plugin-fishing2
+
+</details>
+
+<details>
+<summary>使用包管理器安装</summary>
+在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令
+
+<details>
+<summary>pip</summary>
+
+    pip install nonebot-plugin-fishing2
+</details>
+<details>
+<summary>pdm</summary>
+
+    pdm add nonebot-plugin-fishing2
+</details>
+<details>
+<summary>poetry</summary>
+
+    poetry add nonebot-plugin-fishing2
+</details>
+<details>
+<summary>conda</summary>
+
+    conda install nonebot-plugin-fishing2
+</details>
+
+打开 nonebot2 项目根目录下的 `pyproject.toml` 文件, 在 `[tool.nonebot]` 部分追加写入
+
+    plugins = ["nonebot_plugin_fishing2"]
+
+</details>
+
+注意：安装过后，需在控制台输入 `nb orm upgrade` 指令以初始化数据库。
+
+## ⚙️ 配置
+
+在 nonebot2 项目的`.env`文件中添加下表中的必填配置
+
+| 配置项 | 必填 | 说明 |
+|:-----:|:----:|:----:|
+| fishes | 否 | 配置鱼塘内鱼们的名称、权重、等待时间和价格 |
+| fishing_limit | 否 | 填入每次钓鱼后，限制钓鱼的秒数 |
+| fishing_coin_name | 否 | 填入卖鱼获取的货币名称 |
+| special_fish_enabled | 否 | 是否启用赛博放生功能（默认为否） |
+| special_fish_price | 否 | 每放生一次所需的货币数量 |
+| special_fish_probability | 否 | 钓鱼时钓到用户放生的鱼的概率 |
+
+其中 `fishes` 配置项说明如下：
+
+```dotenv
+FISHES='
+[
+  {
+    "name": "小鱼", # 鱼的名称
+    "frequency": 2, # 鱼上钩的时间
+    "weight": 100, # 权重
+    "price": 2 # 价格
+  }
+]
+'
+```
+
+## 🔨 更新
+
+每一次更新后，需执行 `nb orm upgrade`。
+
+## 🎉 使用
+
+### 指令表
+| 指令 | 范围 | 说明 |
+|:-----:|:----:|:----:|
+| 钓鱼 | 所有 | 放下鱼竿 |
+| 卖鱼 | 所有 | 获取货币 |
+| 放生 | 所有 | 赛博放生 |
+| 祈愿 | 所有 | 向神祈愿 |
+| 背包 | 所有 | 查看背包 |
+| 成就 | 所有 | 查看成就 |
+| 排行榜 | 所有 | 富翁排行 |
+
+### 赛博放生
+
+当用户使用货币放生由自己取名的一条鱼后，每个用户在钓鱼时都有机会钓到那一条鱼。但此功能开关 `special_fish_enabled` 默认关闭，原因是用户生成内容如果不符合规范，可能导致出现不可预料的情况，请谨慎开启。
+
+
+## 📝 Todo
+
+- [x] 重写数据库逻辑（改为使用 [nonebot/plugin-orm](https://github.com/nonebot/plugin-orm)）
+- [x] 增加系统商店，卖出钓到的鱼们
+- [x] 赛博放生 [#4](https://github.com/C14H22O/nonebot-plugin-fishing/issues/4) （已基本完成）
+- [ ] 使用 [nonebot_plugin_chikari_economy](https://github.com/mrqx0195/nonebot_plugin_chikari_economy) 经济系统
+- [ ] 为鱼竿增加耐久度，耐久度为0时需重新购买鱼竿
+- [ ] 为钓鱼背包添加排序
+- [x] 添加成就系统

nonebot_plugin_fishing2-0.0.1/nonebot_plugin_fishing/__init__.py

@@ -0,0 +1,165 @@
+from nonebot import on_command, require
+
+require("nonebot_plugin_orm")  # noqa
+
+from nonebot.plugin import PluginMetadata
+from nonebot.adapters import Event, Message
+from nonebot.params import CommandArg
+from nonebot.permission import SUPERUSER
+
+from nonebot.adapters.onebot.v11 import Bot, GroupMessageEvent, PrivateMessageEvent, Message, MessageSegment, ActionFailed
+
+import asyncio
+
+from typing import Union
+
+from .config import Config, config
+from .data_source import (
+    choice,
+    can_fishing,
+    can_catch_special_fish,
+    can_free_fish,
+    get_stats,
+    save_fish,
+    save_special_fish,
+    get_backpack,
+    sell_fish,
+    get_balance,
+    free_fish,
+    random_get_a_special_fish,
+    lottery,
+    give,
+    check_achievement,
+    get_achievements,
+    get_board
+)
+
+fishing_coin_name = config.fishing_coin_name
+
+__plugin_meta__ = PluginMetadata(
+    name="赛博钓鱼",
+    description="你甚至可以电子钓鱼",
+    usage=f'''钓鱼帮助
+▶ 钓鱼：有 {config.fishing_limit}s 的冷却，时间随上一条鱼稀有度变化
+▶ 卖鱼 [鱼名] [数量]：卖鱼获得{fishing_coin_name}
+▶ 放生 [鱼名]：给一条鱼取名并放生
+▶ 祈愿：向神祈愿，随机获取/损失{fishing_coin_name}
+▶ 背包：查看背包中的{fishing_coin_name}与物品
+▶ 成就：查看拥有的成就
+▶ 钓鱼排行榜：查看{fishing_coin_name}排行榜
+''',
+    type="application",
+    homepage="https://github.com/ALittleBot/nonebot-plugin-fishing",
+    config=Config,
+    supported_adapters=None,
+)
+
+fishing_help = on_command("fishing_help", aliases={"钓鱼帮助"}, priority=3,block=True)
+fishing = on_command("fishing", aliases={"钓鱼"}, priority=5)
+backpack = on_command("backpack", aliases={"背包", "钓鱼背包"}, priority=5)
+sell = on_command("sell", aliases={"卖鱼", "出售"}, priority=5)
+free_fish_cmd = on_command("free_fish", aliases={"放生", "钓鱼放生"}, priority=5)
+lottery_cmd = on_command("lottery", aliases={"祈愿"}, priority=5)
+achievement_cmd = on_command("achievement", aliases={"成就", "钓鱼成就"}, priority=5)
+give_cmd = on_command("give", aliases={"赐予"}, permission=SUPERUSER, priority=5)
+board_cmd = on_command("board", aliases={"排行榜", "钓鱼排行榜"}, priority=5)
+
+
+@fishing_help.handle()
+async def _():
+    await fishing_help.finish(__plugin_meta__.usage)
+
+@fishing.handle()
+async def _(event: Event):
+    user_id = event.get_user_id()
+    if not await can_fishing(user_id):
+        await fishing.finish("河累了, 休息一下吧")
+    await fishing.send("正在钓鱼…")
+    if await can_catch_special_fish():
+        special_fish_name = await random_get_a_special_fish()
+        result = f"你钓到了别人放生的 {special_fish_name}"
+        await save_special_fish(user_id, special_fish_name)
+        await fishing.finish(result)
+    choice_result = choice()
+    fish = choice_result[0]
+    sleep_time = choice_result[1]
+    result = f"钓到了一条{fish}, 你把它收进了背包里"
+    await save_fish(user_id, fish)
+    await asyncio.sleep(sleep_time)
+    achievements = await check_achievement(user_id)
+    if achievements is not None:
+        for achievement in achievements:
+            await fishing.send(achievement)
+    await fishing.finish(MessageSegment.at(user_id) + " " + result)
+
+
+@backpack.handle()
+async def _(event: Event):
+    user_id = event.get_user_id()
+    await backpack.finish(MessageSegment.at(user_id) + " \n" + await get_stats(user_id) + "\n" + await get_balance(user_id) + "\n" + await get_backpack(user_id))
+
+
+@sell.handle()
+async def _(event: Event, arg: Message = CommandArg()):
+    fish_info = arg.extract_plain_text()
+    user_id = event.get_user_id()
+    if fish_info == "":
+        await sell.finish(MessageSegment.at(user_id) + " " + "请输入要卖出的鱼的名字和数量 (数量为1时可省略), 如 /卖鱼 小鱼 1")
+    if len(fish_info.split()) == 1:
+        await sell.finish(MessageSegment.at(user_id) + " " + await sell_fish(user_id, fish_info))
+    else:
+        fish_name, fish_quantity = fish_info.split()
+        await sell.finish(MessageSegment.at(user_id) + " " + await sell_fish(user_id, fish_name, int(fish_quantity)))
+
+
+@free_fish_cmd.handle()
+async def _(event: Event, arg: Message = CommandArg()):
+    if not can_free_fish():
+        await free_fish_cmd.finish("未开启此功能, 请联系机器人管理员")
+    fish_name = arg.extract_plain_text()
+    user_id = event.get_user_id()
+    if fish_name == "":
+        await free_fish_cmd.finish(MessageSegment.at(user_id) + " " + "请输入要放生的鱼的名字, 如 /放生 测试鱼")
+    await free_fish_cmd.finish(MessageSegment.at(user_id) + " " + await free_fish(user_id, fish_name))
+
+
+@lottery_cmd.handle()
+async def _(event: Event):
+    user_id = event.get_user_id()
+    await lottery_cmd.finish(MessageSegment.at(user_id) + " " + await lottery(user_id))
+
+
+@achievement_cmd.handle()
+async def _(event: Event):
+    user_id = event.get_user_id()
+    await achievement_cmd.finish(MessageSegment.at(user_id) + " " + await get_achievements(user_id))
+
+
+@give_cmd.handle()
+async def _(arg: Message = CommandArg()):
+    info = arg.extract_plain_text().split()
+    if len(info) < 2 or len(info) > 3:
+        await give_cmd.finish("请输入用户的 id 和鱼的名字和数量 (数量为1时可省略), 如 /give 114514 开发鱼 1")
+    else:
+        quantity = int(info[2]) if len(info) == 3 else 1
+        await give_cmd.finish(await give(info[0], info[1], quantity))
+
+
+@board_cmd.handle()
+async def _(bot: Bot, event: GroupMessageEvent):
+    group_id = event.group_id
+    top_users_list = await get_board()
+    msg = '钓鱼富豪排行榜：'
+    for index, user in enumerate(top_users_list):
+        try:
+            user_info = await bot.get_group_member_info(group_id=group_id, user_id=user[0])
+            username = user_info['card'] if user_info['card'] is not None and user_info['card'] != '' else user_info['nickname']
+        except ActionFailed:
+            username = "[神秘富豪]"
+
+        msg += f'\n{index + 1}. {username}: {user[1]} {fishing_coin_name}'
+    
+    await board_cmd.finish(msg)
+            
+            
+    

nonebot_plugin_fishing2-0.0.1/nonebot_plugin_fishing/config.py

@@ -0,0 +1,95 @@
+from pydantic import BaseModel
+from typing import List, Dict
+
+try:
+    # pydantic v2
+    from nonebot import get_plugin_config
+except ImportError:
+    # pydantic v1
+    from nonebot import get_driver
+
+
+class Config(BaseModel):
+    fishes: List[Dict] = [
+        {
+            "name": "小鱼",
+            "frequency": 2,
+            "weight": 100,
+            "price": 10
+        },
+        {
+            "name": "尚方宝剑",
+            "frequency": 2,
+            "weight": 50,
+            "price": 20
+        },
+        {
+            "name": "小杂鱼~♡",
+            "frequency": 10,
+            "weight": 10,
+            "price": 100
+        },
+        {
+            "name": "烤激光鱼",
+            "frequency": 20,
+            "weight": 1,
+            "price": 1000
+        },
+        {
+            "name": "大傻",
+            "frequency": 30,
+            "weight": 1,
+            "price": 2000
+        }
+    ]
+
+    fishing_limit: int = 30
+
+    fishing_coin_name: str = "绿宝石"  # It means Fishing Coin.
+
+    special_fish_enabled: bool = True
+
+    special_fish_price: int = 200
+
+    special_fish_probability: float = 0.01
+
+    fishing_achievement: List[Dict] = [
+        {
+            "type": "fishing_frequency",
+            "name": "腥味十足的生意",
+            "data": 1,
+            "description": "钓到一条鱼。"
+        },
+        {
+            "type": "fishing_frequency",
+            "name": "还是钓鱼大佬",
+            "data": 100,
+            "description": "累计钓鱼一百次。"
+        },
+        {
+            "type": "fish_type",
+            "name": "那是鱼吗？",
+            "data": "小杂鱼~♡",
+            "description": "获得#####。[原文如此]"
+        },
+        {
+            "type": "fish_type",
+            "name": "那一晚, 激光鱼和便携式烤炉都喝醉了",
+            "data": "烤激光鱼",
+            "description": "获得烤激光鱼。"
+        },
+        {
+            "type": "fish_type",
+            "name": "你怎么把 Fufu 钓上来了",
+            "data": "大傻",
+            "description": "获得大傻"
+        }
+    ]
+
+
+try:
+    # pydantic v2
+    config = get_plugin_config(Config)
+except:
+    # pydantic v1
+    config = Config.parse_obj(get_driver().config)