Skip to content

Latest commit

 

History

History
137 lines (102 loc) · 5.35 KB

README.md

File metadata and controls

137 lines (102 loc) · 5.35 KB

logo

StarBot 示例插件

目录

快速开始

  1. 克隆本示例项目作为模板创建新项目
  2. 修改 pom.xml 中的项目信息, 该部分信息会作为插件元数据, 在被 StarBot 加载时输出到控制台和日志中 (groupId, artifactId, version, name, description, url, developers 等)
  3. 开发你的插件功能, 开发时可正常使用绝大多数 Spring 注解 (可参考 StarBotExampleStartEventListener.java、StarBotExampleDanmuEventListener.java 和 StarBotExampleMeowAdder.java 示例)
  4. 使用 Maven 构建项目: mvn clean package
  5. 将 target 中生成的 JAR 文件放入 StarBot 的 plugins 目录

项目结构

StarBot 插件使用标准的 Maven 项目结构：

starbot-example-plugin/
├── pom.xml                                                # Maven 项目配置文件
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/example/                               # 插件代码包
│   │   │       ├── StarBotExampleStartEventListener.java  # 示例功能: 启动事件监听器
│   │   │       ├── StarBotExampleDanmuEventListener.java  # 示例功能: 弹幕监听器
│   │   │       └── StarBotExampleMeowAdder.java           # 示例功能: 推送消息修改器
│   │   └── resources/
│   └── test/                                              # 测试代码目录
└── target/                                                # 构建输出目录
    └── starbot-example-plugin-1.0.0.jar                   # 构建后的插件 JAR 文件

开发说明

插件信息

每个 StarBot 插件都需要在 pom.xml 文件中定义其元数据, 其内容将在被 StarBot 加载时输出到控制台和日志中：

2025-11-22 01:58:39.062 INFO 64528 --- [ main] c.s.bot.core.plugin.StarBotPluginLoader : 已注册插件 StarBotExamplePlugin v1.0.0 --Author: Example Plugin For StarBot

<!-- 组名，通常使用反向域名，必填，与 artifactId 共同构成插件唯一标识 -->
<groupId>com.example</groupId>
<!-- 插件 ID，必填，与 groupId 共同构成插件唯一标识 -->
<artifactId>starbot-example-plugin</artifactId>
<!-- 插件版本，必填，会在插件加载时输出至 StarBot 日志中 -->
<version>1.0.0</version>
<!-- 插件名称，必填，会在插件加载时输出至 StarBot 日志中 -->
<name>StarBotExamplePlugin</name>
<!-- 插件描述，必填，会在插件加载时输出至 StarBot 日志中 -->
<description>Example Plugin For StarBot</description>
<!-- 插件主页 URL -->
<url>https://www.example.com</url>

<!-- 插件作者信息 -->
<developers>
    <developer>
        <!-- 插件作者 ID，必填，可与名称保持一致 -->
        <id>Author</id>
        <!-- 插件作者名称，必填，会在插件加载时输出至 StarBot 日志中 -->
        <name>Author</name>
        <!-- 插件作者邮箱 -->
        <email>example@example.com</email>
    </developer>
</developers>

打包配置

注意: 请不要随意修改 pom.xml 的 <build> 构建配置部分，否则可能导致插件无法被 StarBot 加载

注意事项

  • 开发插件时, 可以使用绝大多数的 Spring 注解, 例如使用 @Controller 创建 API 接口, 使用 @EventListener 监听事件等
  • 需要注册至 Spring 容器或使用 Spring 机制 (例如事件机制) 的类, 需要在类上使用 @StarBotComponent 注解, 该注解会将类注册为 StarBot 组件, 并被 StarBot 扫描并注册至 Spring 容器中
  • 使用了 @StarBotComponent 注解的类, 类名不可以与 StarBot 本体或其他插件中的类名重复, 请命名时尽量避免过于简单或过于通用的命名
  • StarBot 内部大量使用了 Spring 的事件机制, 插件可以通过创建事件监听器来处理这些事件, 常用事件类型请参考 StarBotCore 项目相关文档

依赖管理

StarBot 插件使用 Maven 进行依赖管理, 插件可以依赖其他第三方库, 这些库将在被 StarBot 加载时自动下载

核心依赖

每个 StarBot 插件必须直接依赖 StarBotCore 或通过依赖其他插件的方式间接依赖 StarBotCore, 建议开发时使用最新版本：

<dependency>
    <groupId>com.starlwr</groupId>
    <artifactId>starbot-core</artifactId>
    <version>3.0.0</version>
</dependency>

添加第三方依赖

插件可以按需添加其他第三方依赖，例如：

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <scope>provided</scope>
    <optional>true</optional>
</dependency>

构建与部署

构建插件

使用 Maven 构建 StarBot 插件：

mvn clean package

构建成功后，插件 JAR 文件将生成在 target 目录中，文件名格式为 {artifactId}-{version}.jar，例如 starbot-example-plugin-1.0.0.jar。

部署插件

将生成的 JAR 文件复制到 StarBot 的插件目录中：

  1. 找到 StarBot 的插件目录（plugins 文件夹）
  2. 将插件 JAR 文件复制到该目录
  3. 启动 StarBot