修改了hello_world_plugin
This commit is contained in:
53
plugins/hello_world_plugin/_manifest.json
Normal file
53
plugins/hello_world_plugin/_manifest.json
Normal file
@@ -0,0 +1,53 @@
|
|||||||
|
{
|
||||||
|
"manifest_version": 1,
|
||||||
|
"name": "Hello World 示例插件 (Hello World Plugin)",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"description": "我的第一个MaiCore插件,包含问候功能和时间查询等基础示例",
|
||||||
|
"author": {
|
||||||
|
"name": "MaiBot开发团队",
|
||||||
|
"url": "https://github.com/MaiM-with-u"
|
||||||
|
},
|
||||||
|
"license": "GPL-v3.0-or-later",
|
||||||
|
|
||||||
|
"host_application": {
|
||||||
|
"min_version": "0.8.0"
|
||||||
|
},
|
||||||
|
"homepage_url": "https://github.com/MaiM-with-u/maibot",
|
||||||
|
"repository_url": "https://github.com/MaiM-with-u/maibot",
|
||||||
|
"keywords": ["demo", "example", "hello", "greeting", "tutorial"],
|
||||||
|
"categories": ["Examples", "Tutorial"],
|
||||||
|
|
||||||
|
"default_locale": "zh-CN",
|
||||||
|
"locales_path": "_locales",
|
||||||
|
|
||||||
|
"plugin_info": {
|
||||||
|
"is_built_in": false,
|
||||||
|
"plugin_type": "example",
|
||||||
|
"components": [
|
||||||
|
{
|
||||||
|
"type": "action",
|
||||||
|
"name": "hello_greeting",
|
||||||
|
"description": "向用户发送问候消息"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "action",
|
||||||
|
"name": "bye_greeting",
|
||||||
|
"description": "向用户发送告别消息",
|
||||||
|
"activation_modes": ["keyword"],
|
||||||
|
"keywords": ["再见", "bye", "88", "拜拜"]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "command",
|
||||||
|
"name": "time",
|
||||||
|
"description": "查询当前时间",
|
||||||
|
"pattern": "/time"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"features": [
|
||||||
|
"问候和告别功能",
|
||||||
|
"时间查询命令",
|
||||||
|
"配置文件示例",
|
||||||
|
"新手教程代码"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
202
plugins/hello_world_plugin/plugin.py
Normal file
202
plugins/hello_world_plugin/plugin.py
Normal file
@@ -0,0 +1,202 @@
|
|||||||
|
from typing import List, Tuple, Type
|
||||||
|
from src.plugin_system.apis import tool_api
|
||||||
|
from src.plugin_system import (
|
||||||
|
BasePlugin,
|
||||||
|
register_plugin,
|
||||||
|
BaseAction,
|
||||||
|
BaseCommand,
|
||||||
|
BaseTool,
|
||||||
|
ComponentInfo,
|
||||||
|
ActionActivationType,
|
||||||
|
ConfigField,
|
||||||
|
BaseEventHandler,
|
||||||
|
EventType,
|
||||||
|
MaiMessages,
|
||||||
|
)
|
||||||
|
|
||||||
|
class HelloTool(BaseTool):
|
||||||
|
"""问候工具 - 用于发送问候消息"""
|
||||||
|
|
||||||
|
name = "hello_tool"
|
||||||
|
description = "发送问候消息"
|
||||||
|
parameters = {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"greeting_message": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "要发送的问候消息"
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"required": ["greeting_message"]
|
||||||
|
}
|
||||||
|
available_for_llm = True
|
||||||
|
|
||||||
|
|
||||||
|
async def execute(self, function_args):
|
||||||
|
"""执行问候工具"""
|
||||||
|
import random
|
||||||
|
greeting_message = random.choice(function_args.get("greeting_message", ["嗨!很高兴见到你!😊"]))
|
||||||
|
return {
|
||||||
|
"name": self.name,
|
||||||
|
"content": greeting_message
|
||||||
|
}
|
||||||
|
|
||||||
|
# ===== Action组件 =====
|
||||||
|
class HelloAction(BaseAction):
|
||||||
|
"""问候Action - 简单的问候动作"""
|
||||||
|
|
||||||
|
# === 基本信息(必须填写)===
|
||||||
|
action_name = "hello_greeting"
|
||||||
|
action_description = "向用户发送问候消息"
|
||||||
|
activation_type = ActionActivationType.ALWAYS # 始终激活
|
||||||
|
|
||||||
|
# === 功能描述(必须填写)===
|
||||||
|
action_parameters = {"greeting_message": "要发送的问候消息"}
|
||||||
|
action_require = ["需要发送友好问候时使用", "当有人向你问好时使用", "当你遇见没有见过的人时使用"]
|
||||||
|
associated_types = ["text"]
|
||||||
|
|
||||||
|
async def execute(self) -> Tuple[bool, str]:
|
||||||
|
"""执行问候动作 - 这是核心功能"""
|
||||||
|
# 发送问候消息
|
||||||
|
hello_tool = tool_api.get_tool_instance("hello_tool")
|
||||||
|
greeting_message = await hello_tool.execute({
|
||||||
|
"greeting_message": self.action_data.get("greeting_message", "")
|
||||||
|
})
|
||||||
|
base_message = self.get_config("greeting.message", "嗨!很开心见到你!😊")
|
||||||
|
message = base_message + greeting_message
|
||||||
|
await self.send_text(message)
|
||||||
|
|
||||||
|
return True, "发送了问候消息"
|
||||||
|
|
||||||
|
|
||||||
|
class ByeAction(BaseAction):
|
||||||
|
"""告别Action - 只在用户说再见时激活"""
|
||||||
|
|
||||||
|
action_name = "bye_greeting"
|
||||||
|
action_description = "向用户发送告别消息"
|
||||||
|
|
||||||
|
# 使用关键词激活
|
||||||
|
activation_type = ActionActivationType.KEYWORD
|
||||||
|
|
||||||
|
# 关键词设置
|
||||||
|
activation_keywords = ["再见", "bye", "88", "拜拜"]
|
||||||
|
keyword_case_sensitive = False
|
||||||
|
|
||||||
|
action_parameters = {"bye_message": "要发送的告别消息"}
|
||||||
|
action_require = [
|
||||||
|
"用户要告别时使用",
|
||||||
|
"当有人要离开时使用",
|
||||||
|
"当有人和你说再见时使用",
|
||||||
|
]
|
||||||
|
associated_types = ["text"]
|
||||||
|
|
||||||
|
async def execute(self) -> Tuple[bool, str]:
|
||||||
|
bye_message = self.action_data.get("bye_message", "")
|
||||||
|
|
||||||
|
message = f"再见!期待下次聊天!👋{bye_message}"
|
||||||
|
await self.send_text(message)
|
||||||
|
return True, "发送了告别消息"
|
||||||
|
|
||||||
|
|
||||||
|
class TimeCommand(BaseCommand):
|
||||||
|
"""时间查询Command - 响应/time命令"""
|
||||||
|
|
||||||
|
command_name = "time"
|
||||||
|
command_description = "查询当前时间"
|
||||||
|
|
||||||
|
# === 命令设置(必须填写)===
|
||||||
|
command_pattern = r"^/time$" # 精确匹配 "/time" 命令
|
||||||
|
|
||||||
|
async def execute(self) -> Tuple[bool, str, bool]:
|
||||||
|
"""执行时间查询"""
|
||||||
|
import datetime
|
||||||
|
|
||||||
|
# 获取当前时间
|
||||||
|
time_format: str = self.get_config("time.format", "%Y-%m-%d %H:%M:%S") # type: ignore
|
||||||
|
now = datetime.datetime.now()
|
||||||
|
time_str = now.strftime(time_format)
|
||||||
|
|
||||||
|
# 发送时间信息
|
||||||
|
message = f"⏰ 当前时间:{time_str}"
|
||||||
|
await self.send_text(message)
|
||||||
|
|
||||||
|
return True, f"显示了当前时间: {time_str}", True
|
||||||
|
|
||||||
|
|
||||||
|
class PrintMessage(BaseEventHandler):
|
||||||
|
"""打印消息事件处理器 - 处理打印消息事件"""
|
||||||
|
|
||||||
|
event_type = EventType.ON_MESSAGE
|
||||||
|
handler_name = "print_message_handler"
|
||||||
|
handler_description = "打印接收到的消息"
|
||||||
|
|
||||||
|
async def execute(self, message: MaiMessages) -> Tuple[bool, bool, str | None]:
|
||||||
|
"""执行打印消息事件处理"""
|
||||||
|
# 打印接收到的消息
|
||||||
|
if self.get_config("print_message.enabled", False):
|
||||||
|
print(f"接收到消息: {message.raw_message}")
|
||||||
|
return True, True, "消息已打印"
|
||||||
|
|
||||||
|
|
||||||
|
# ===== 插件注册 =====
|
||||||
|
|
||||||
|
|
||||||
|
@register_plugin
|
||||||
|
class HelloWorldPlugin(BasePlugin):
|
||||||
|
"""Hello World插件 - 你的第一个MaiCore插件"""
|
||||||
|
|
||||||
|
# 插件基本信息
|
||||||
|
plugin_name: str = "hello_world_plugin" # 内部标识符
|
||||||
|
enable_plugin: bool = True
|
||||||
|
dependencies: List[str] = [] # 插件依赖列表
|
||||||
|
python_dependencies: List[str] = [] # Python包依赖列表
|
||||||
|
config_file_name: str = "config.toml" # 配置文件名
|
||||||
|
|
||||||
|
# 配置节描述
|
||||||
|
config_section_descriptions = {"plugin": "插件基本信息", "greeting": "问候功能配置", "time": "时间查询配置"}
|
||||||
|
|
||||||
|
# 配置Schema定义
|
||||||
|
config_schema: dict = {
|
||||||
|
"plugin": {
|
||||||
|
"name": ConfigField(type=str, default="hello_world_plugin", description="插件名称"),
|
||||||
|
"version": ConfigField(type=str, default="1.0.0", description="插件版本"),
|
||||||
|
"enabled": ConfigField(type=bool, default=False, description="是否启用插件"),
|
||||||
|
},
|
||||||
|
"greeting": {
|
||||||
|
"message": ConfigField(type=list, default=["嗨!很开心见到你!😊","Ciallo~(∠・ω< )⌒★"], description="默认问候消息"),
|
||||||
|
"enable_emoji": ConfigField(type=bool, default=True, description="是否启用表情符号"),
|
||||||
|
},
|
||||||
|
"time": {"format": ConfigField(type=str, default="%Y-%m-%d %H:%M:%S", description="时间显示格式")},
|
||||||
|
"print_message": {"enabled": ConfigField(type=bool, default=True, description="是否启用打印")},
|
||||||
|
}
|
||||||
|
|
||||||
|
def get_plugin_components(self) -> List[Tuple[ComponentInfo, Type]]:
|
||||||
|
return [
|
||||||
|
(HelloAction.get_action_info(), HelloAction),
|
||||||
|
(HelloTool.get_tool_info(), HelloTool), # 添加问候工具
|
||||||
|
(ByeAction.get_action_info(), ByeAction), # 添加告别Action
|
||||||
|
(TimeCommand.get_command_info(), TimeCommand),
|
||||||
|
(PrintMessage.get_handler_info(), PrintMessage),
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
# @register_plugin
|
||||||
|
# class HelloWorldEventPlugin(BaseEPlugin):
|
||||||
|
# """Hello World事件插件 - 处理问候和告别事件"""
|
||||||
|
|
||||||
|
# plugin_name = "hello_world_event_plugin"
|
||||||
|
# enable_plugin = False
|
||||||
|
# dependencies = []
|
||||||
|
# python_dependencies = []
|
||||||
|
# config_file_name = "event_config.toml"
|
||||||
|
|
||||||
|
# config_schema = {
|
||||||
|
# "plugin": {
|
||||||
|
# "name": ConfigField(type=str, default="hello_world_event_plugin", description="插件名称"),
|
||||||
|
# "version": ConfigField(type=str, default="1.0.0", description="插件版本"),
|
||||||
|
# "enabled": ConfigField(type=bool, default=True, description="是否启用插件"),
|
||||||
|
# },
|
||||||
|
# }
|
||||||
|
|
||||||
|
# def get_plugin_components(self) -> List[Tuple[ComponentInfo, Type]]:
|
||||||
|
# return [(PrintMessage.get_handler_info(), PrintMessage)]
|
||||||
@@ -6,8 +6,6 @@ install(extra_lines=3)
|
|||||||
|
|
||||||
logger = get_logger("base_tool")
|
logger = get_logger("base_tool")
|
||||||
|
|
||||||
# 工具注册表
|
|
||||||
TOOL_REGISTRY = {}
|
|
||||||
|
|
||||||
|
|
||||||
class BaseTool:
|
class BaseTool:
|
||||||
|
|||||||
@@ -151,7 +151,7 @@ class ToolInfo(ComponentInfo):
|
|||||||
"""工具组件信息"""
|
"""工具组件信息"""
|
||||||
|
|
||||||
tool_parameters: Dict[str, Any] = field(default_factory=dict) # 工具参数定义
|
tool_parameters: Dict[str, Any] = field(default_factory=dict) # 工具参数定义
|
||||||
available_for_llm: bool = True # 是否可供LLM使用
|
available_for_llm: bool = False # 是否可供LLM使用
|
||||||
tool_description: str = "" # 工具描述
|
tool_description: str = "" # 工具描述
|
||||||
|
|
||||||
def __post_init__(self):
|
def __post_init__(self):
|
||||||
|
|||||||
Reference in New Issue
Block a user