nonebot-plugin-argot 0.1.6

NoneBot 暗语

NoneBot-Plugin-Argot

✨ NoneBot2 暗语消息 ✨

📸 演示与预览   |   📦️ 下载插件   |   💬 加入交流群

📖 介绍

NoneBot2 暗语消息支持

[!IMPORTANT] 收藏项目，你将从 GitHub 上无延迟地接收所有发布通知～⭐️

Star History

💿 安装

以下提到的方法任选 其一 即可

[推荐] 使用 nb-cli 安装

在 Bot 的根目录下打开命令行, 输入以下指令即可安装

nb plugin install nonebot-plugin-argot

使用包管理器安装

pip install nonebot-plugin-argot
# or, use poetry
poetry add nonebot-plugin-argot
# or, use pdm
pdm add nonebot-plugin-argot
# or, use uv
uv add nonebot-plugin-argot

🎉 使用

添加暗语

# 无过期时间
await cmd.send(
    "This is a text message. Reply /background to get background image.",
    argot={
        "name": "background",
        "command": "background",
        "content": "https://nonebot.dev/logo.png",
    }
)

# 60s 后过期
await cmd.send(
    "This is a text message. Reply /background to get background image.",
    argot={
        "name": "background",
        "command": "background",
        "content": "https://nonebot.dev/logo.png",
        "expire": 60
    }
)

# 手动调用 `add_argot` 方法
from nonebot_plugin_argot import add_argot, get_message_id

@on_command("cmd").handle()
async def _():
    message = await cmd2.send("This is a text message. Reply /background to get background image.")
    await add_argot(
        message_id=get_message_id(message) or "",
        name="background",
        segment=Image(url="https://koishi.chat/logo.png"),
        expired_at=timedelta(minutes=2),
    )


# 使用 Alconna UniMessage 
from nonebot_plugin_alconna import Command
from nonebot_plugin_alconna.uniseg import Text, Image, UniMessage
from nonebot_plugin_argot.extension import ArgotExtension, ArgotSendWrapper, current_send_wrapper

cmd1 = Command("cmd1").build(use_cmd_start=True)
cmd2 = Command("cmd2").build(use_cmd_start=True, extensions=[ArgotExtension()])

@cmd1.handle()
async def _():
    path: Path = Path(__file__).parent / "image.png"
    
    with current_send_wrapper.use(ArgotSendWrapper()):
        await UniMessage(
            [
                Text("This is a text message. Reply /image to get image."),
                Argot("image", [Text("image"), Image(path=path)]),
            ]
        ).send()

@cmd2.handle()
async def _():
    path: Path = Path(__file__).parent / "image.png"
    await UniMessage(
        [
            Text("This is a text message. Reply /image to get image."),
            Argot("image", [Text("image"), Image(path=path)]),
        ]
    ).send()

获取暗语信息

• 使用设置的 command
• 通过 get_argot 函数
• 超管回复暗语消息 /argot [name]

📸 效果图

💖 鸣谢

• KiramiBot：灵感来源
• KomoriDev/Starify：提供了引人注目的徽章

贡献者们

感谢这些大佬对本项目作出的贡献:

📄 许可证

本项目使用 MIT 许可证开源

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.