llms.txt: machine-readable documentation index. Markdown version of this page is also available.

Simple Robot 4.x Help

开始使用

  1. 安装核心库或Spring starter, 或者其他任意的 Application 实现。

  2. 选择并安装你所需的组件库, 配置它们

  3. 启动你的程序, 或者打包、部署。

安装 Application 实现

先添加一个基于 simbot-api 、实现了完整 Application 能力的库,再按它的要求配置或使用。

官方实现

simbot4 提供了两个这样的库: simbot-core (也就是 “核心库” )和 Spring Boot 的 starter 实现。

  • 前往 核心库 了解如何添加并使用 simbot-core 以及它提供的 Application 实现: Simple。

  • 前往 Spring Boot 3 了解如何添加并使用 simbot-core-spring-boot-starter 以及它提供的 Application 实现。

  • 如果你仍在使用 Spring Boot 2.x, 前往 Spring Boot 2 了解如何添加并使用 simbot-core-spring-boot-starter-v2。

安装组件、插件

Application 提供了 simbot-api (也就是**“标准库”**)定义的诸多能力,比如组件、插件安装和事件调度, 但它不包含 具体的平台实现 ,比如 QQ 频道、KOOK、大别野等 特定平台 的事件和消息。

这些特定平台的实现,就是一个个不同的组件或插件 。它们一般在各自独立的仓库中维护、发版, 依赖标准库,但彼此独立。 下文将它们称为 “组件库”。

以我们 官方维护的组件库 为例,它们都有各自的应用手册, 手册里也会提供类似“快速开始”的章节,说明如何配置、如何搭建项目。

接下来只要选择要用的组件库,把依赖加上,再完成配置就行。 如果只用一个组件库,也可以直接看对应的“快速开始”,里面会一起介绍核心库和组件库实现的安装。

下面是一个简单的添加依赖的伪例子:

// 使用核心库 implementation("love.forte.simbot:simbot-core:4.15.0") // 添加组件库, 假设有两个叫做 foo1、bar2 的组件实现 implementation("com.example.component:foo1-core:x.xx") implementation("io.github.Jojo.cp:bar2-impl:x.xx")
// 使用核心库 implementation 'love.forte.simbot:simbot-core:4.15.0' // 添加组件库, 假设有两个叫做 foo1、bar2 的组件实现 implementation 'com.example.component:foo1-core:x.xx' implementation 'io.github.Jojo.cp:bar2-impl:x.xx'
<!-- 使用核心库 --> <dependency> <groupId>love.forte.simbot</groupId> <artifactId>simbot-core</artifactId> <version>4.15.0</version> </dependency> <!-- 添加组件库, 假设有两个叫做 foo1、bar2 的组件实现 --> <dependency> <groupId>com.example.component</groupId> <artifactId>foo1-core</artifactId> <version>x.xx</version> </dependency> <dependency> <groupId>io.github.Jojo.cp</groupId> <artifactId>bar2-impl</artifactId> <version>x.xx</version> </dependency>

官方组件

  • 前往 组件库 找到需要的组件,再按引导或手册添加依赖并使用。

社区组件

  • 前往 社区组件 找到需要的组件,或者自行开发组件、插件再使用。

组件开发

  • 前往 组件开发 了解开发组件库的方式与步骤。

07 November 2026