update: 更新默认插件 helloworld

2024-07-07 21:00:18 +08:00
parent ddad30c22e
commit 4b6dae71fc
6 changed files with 81 additions and 169 deletions
@@ -7,7 +7,6 @@ configs/config.yaml
 **/.DS_Store
 temp
 cmd_config.json
-addons/plugins/
 data/*
 cookies.json
 logs/
@@ -0,0 +1,10 @@
+# helloworld
+
+AstrBot 插件模板
+
+A template plugin for AstrBot plugin feature
+
+# 支持
+
+[帮助文档](https://astrbot.soulter.top/center/docs/%E5%BC%80%E5%8F%91/%E6%8F%92%E4%BB%B6%E5%BC%80%E5%8F%91/
+)
@@ -0,0 +1 @@
+https://github.com/Soulter/helloworld
@@ -1,168 +0,0 @@
-import os
-import shutil
-from nakuru.entities.components import *
-flag_not_support = False
-try:
-    from util.plugin_dev.api.v1.config import *
-    from util.plugin_dev.api.v1.bot import (
-        AstrMessageEvent,
-        CommandResult,
-    )
-except ImportError:
-    flag_not_support = True
-    print("导入接口失败。请升级到 AstrBot 最新版本。")
-
-
-'''
-注意改插件名噢！格式：XXXPlugin 或 Main
-小提示：把此模板仓库 fork 之后 clone 到机器人文件夹下的 addons/plugins/ 目录下，然后用 Pycharm/VSC 等工具打开可获更棒的编程体验（自动补全等）
-'''
-
-
-class HelloWorldPlugin:
-    """
-    初始化函数, 可以选择直接pass
-    """
-
-    def __init__(self) -> None:
-        # 复制旧配置文件到 data 目录下。
-        if os.path.exists("keyword.json"):
-            shutil.move("keyword.json", "data/keyword.json")
-        self.keywords = {}
-        if os.path.exists("data/keyword.json"):
-            self.keywords = json.load(open("data/keyword.json", "r"))
-        else:
-            self.save_keyword()
-
-    """
-    机器人程序会调用此函数。
-    返回规范: bool: 插件是否响应该消息 (所有的消息均会调用每一个载入的插件, 如果不响应, 则应返回 False)
-             Tuple: Non e或者长度为 3 的元组。如果不响应, 返回 None； 如果响应, 第 1 个参数为指令是否调用成功, 第 2 个参数为返回的消息链列表, 第 3 个参数为指令名称
-    例子：一个名为"yuanshen"的插件；当接收到消息为“原神 可莉”, 如果不想要处理此消息，则返回False, None；如果想要处理，但是执行失败了，返回True, tuple([False, "请求失败。", "yuanshen"]) ；执行成功了，返回True, tuple([True, "结果文本", "yuanshen"])
-    """
-
-    def run(self, ame: AstrMessageEvent):
-        if ame.message_str == "helloworld":
-            return CommandResult(
-                hit=True,
-                success=True,
-                message_chain=[Plain("Hello World!!")],
-                command_name="helloworld"
-            )
-        if ame.message_str.startswith("/keyword") or ame.message_str.startswith("keyword"):
-            return self.handle_keyword_command(ame)
-
-        ret = self.check_keyword(ame.message_str)
-        if ret:
-            return ret
-
-        return CommandResult(
-            hit=False,
-            success=False,
-            message_chain=None,
-            command_name=None
-        )
-
-    def handle_keyword_command(self, ame: AstrMessageEvent):
-        l = ame.message_str.split(" ")
-
-        # 获取图片
-        image_url = ""
-        for comp in ame.message_obj.message:
-            if isinstance(comp, Image) and image_url == "":
-                if comp.url is None:
-                    image_url = comp.file
-                else:
-                    image_url = comp.url
-
-        command_result = CommandResult(
-            hit=True,
-            success=False,
-            message_chain=None,
-            command_name="keyword"
-        )
-        if len(l) == 1 or (len(l) == 2 and image_url == ""):
-            ret = """【设置关键词回复】
-示例：
-1. keyword <触发词> <回复词>
-keyword hi 你好
-发送 hi 回复你好
-* 回复词支持图片
-
-2. keyword d <触发词>
-keyword d hi
-删除 hi 触发词产生的回复"""
-            command_result.success = True
-            command_result.message_chain = [Plain(ret)]
-            return command_result
-        elif len(l) == 3 and l[1] == "d":
-            if l[2] not in self.keywords:
-                command_result.message_chain = [Plain(f"关键词 {l[2]} 不存在")]
-                return command_result
-            self.keywords.pop(l[2])
-            self.save_keyword()
-            command_result.success = True
-            command_result.message_chain = [Plain("删除成功")]
-            return command_result
-        else:
-            self.keywords[l[1]] = {
-                "plain_text": " ".join(l[2:]),
-                "image_url": image_url
-            }
-            self.save_keyword()
-            command_result.success = True
-            command_result.message_chain = [Plain("设置成功")]
-            return command_result
-
-    def save_keyword(self):
-        json.dump(self.keywords, open(
-            "data/keyword.json", "w"), ensure_ascii=False)
-
-    def check_keyword(self, message_str: str):
-        for k in self.keywords:
-            if message_str == k:
-                plain_text = ""
-                if 'plain_text' in self.keywords[k]:
-                    plain_text = self.keywords[k]['plain_text']
-                else:
-                    plain_text = self.keywords[k]
-                image_url = ""
-                if 'image_url' in self.keywords[k]:
-                    image_url = self.keywords[k]['image_url']
-                if image_url != "":
-                    res = [Plain(plain_text), Image.fromURL(image_url)]
-                    return CommandResult(
-                        hit=True,
-                        success=True,
-                        message_chain=res,
-                        command_name="keyword"
-                    )
-                return CommandResult(
-                    hit=True,
-                    success=True,
-                    message_chain=[Plain(plain_text)],
-                    command_name="keyword"
-                )
-
-    """
-    插件元信息。
-    当用户输入 plugin v 插件名称 时，会调用此函数，返回帮助信息。
-    返回参数要求(必填)：dict{
-        "name": str, # 插件名称
-        "desc": str, # 插件简短描述
-        "help": str, # 插件帮助信息
-        "version": str, # 插件版本
-        "author": str, # 插件作者
-        "repo": str, # 插件仓库地址 [ 可选 ]
-        "homepage": str, # 插件主页  [ 可选 ]
-    }
-    """
-
-    def info(self):
-        return {
-            "name": "helloworld",
-            "desc": "这是 AstrBot 的默认插件，支持关键词回复。",
-            "help": "输入 /keyword 查看关键词回复帮助。",
-            "version": "v1.3",
-            "author": "Soulter"
-        }
@@ -0,0 +1,64 @@
+import os
+import shutil
+from nakuru.entities.components import *
+flag_not_support = False
+try:
+    from util.plugin_dev.api.v1.config import *
+    from util.plugin_dev.api.v1.bot import (
+        AstrMessageEvent,
+        CommandResult,
+    )
+except ImportError:
+    flag_not_support = True
+    print("导入接口失败。请升级到 AstrBot 最新版本。")
+
+
+'''
+注意改插件名噢！格式：XXXPlugin 或 Main
+小提示：把此模板仓库 fork 之后 clone 到机器人文件夹下的 addons/plugins/ 目录下，然后用 Pycharm/VSC 等工具打开可获更棒的编程体验（自动补全等）
+'''
+class HelloWorldPlugin:
+    """
+    初始化函数, 可以选择直接pass
+    """
+    def __init__(self) -> None:
+        pass
+
+    """
+    机器人程序会调用此函数。
+    """
+    def run(self, ame: AstrMessageEvent):
+        if ame.message_str.startswith("helloworld"): # 如果消息文本以"helloworld"开头
+            return CommandResult(
+                hit=True, # 代表插件会响应此消息
+                success=True, # 插件响应类型为成功响应
+                message_chain=[Plain("Hello World!!")], # 消息链
+                command_name="helloworld" # 指令名
+            )
+        return CommandResult(
+            hit=False, # 插件不会响应此消息
+            success=False,
+            message_chain=None
+        )
+    """
+    插件元信息。
+    当用户输入 plugin v 插件名称 时，会调用此函数，返回帮助信息。
+    返回参数要求(必填)：dict{
+        "name": str, # 插件名称
+        "desc": str, # 插件简短描述
+        "help": str, # 插件帮助信息
+        "version": str, # 插件版本
+        "author": str, # 插件作者
+        "repo": str, # 插件仓库地址 [ 可选 ]
+        "homepage": str, # 插件主页  [ 可选 ]
+    }
+    """
+    def info(self):
+        return {
+            "name": "helloworld",
+            "desc": "这是 AstrBot 的默认插件，支持关键词回复。",
+            "help": "输入 /keyword 查看关键词回复帮助。",
+            "version": "v1.3",
+            "author": "Soulter",
+            "repo": "https://github.com/Soulter/helloworld"
+        }
@@ -0,0 +1,6 @@
+name: helloworld # 这是你的插件的唯一识别名。
+desc: 这是 AstrBot 的默认插件，支持关键词回复。 # 插件简短描述
+help: 输入 /keyword 查看关键词回复帮助。 # 插件的帮助信息
+version: v1.3 # 插件版本号。格式：v1.1.1 或者 v1.1
+author: Soulter # 作者
+repo: https://github.com/Soulter/helloworld # 插件的仓库地址