nonebot-plugin-argot 0.1.8

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

🎉 使用

本插件基于 plugin-alconna，为 NoneBot 提供了一个新的消息段 Argot

@dataclass
class Argot(Segment):
    name: str
    segment: str | Segment | list[Segment]
    command: str | Literal[False] | None = field(default=None, kw_only=True)
    expired_at: int | timedelta = field(default_factory=timedelta, kw_only=True)

• name: 暗语名称
• segment: 暗语包含的消息段
• command: 触发暗语的指令（跟随 COMMAND_START 配置）
  • None: 使用 name 作为指令名
  • False: 禁止通过指令获取暗语
• expired_at: 过期时间

示例

1. NoneBot Matcher + Matcher.send

   from nonebot_plugin_argot import add_argot, get_message_id
   
   @on_command("cmd").handle()
   async def _():
       await cmd.send(
           "This is a text message. Reply /background to get background image.",
           argot={
               "name": "background",
               "command": "background",
               "segment": Image(url="https://koishi.chat/logo.png"),
               "expired_at": 60
           }
       )
   

2. NoneBot Matcher + UniMessage.send

   from nonebot import on_command
   from nonebot_plugin_alconna.uniseg import Text, Image, UniMessage
   from nonebot_plugin_argot.extension import ArgotExtension, ArgotSendWrapper, current_send_wrapper
   
   cmd = on_command("cmd")
   
   @cmd.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()
   

3. Alconna Matcher + UniMessage.send

   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
   
   cmd = Command("cmd").build(use_cmd_start=True, extensions=[ArgotExtension()])
   
   @cmd.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()
   

4. 手动添加

   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),
       )
   

获取暗语有以下几种方式:

• 使用设置的 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.