Skip to content

Commit

Permalink
补充部分文档说明
Browse files Browse the repository at this point in the history
  • Loading branch information
ForteScarlet committed Jun 12, 2024
1 parent e637158 commit da785f3
Show file tree
Hide file tree
Showing 5 changed files with 66 additions and 27 deletions.
8 changes: 4 additions & 4 deletions Writerside/ob.tree
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@
name="Simple Robot | OneBot"
start-page="Home.md">
<toc-element topic="Home.md"/>
<toc-element topic="quick-start.md">
<toc-element topic="use-onebot11.md"/>
</toc-element>
<toc-element toc-title="基础内容">
<toc-element topic="modules.md"/>
<toc-element toc-title="OneBot11">
<toc-element topic="OneBot11.md">
<toc-element topic="onebot11-quick-start.md">
<toc-element topic="use-onebot11.md"/>
</toc-element>
<toc-element topic="onebot11-bot-config.md"/>
<toc-element topic="onebot11-event.md">
</toc-element>
Expand Down
15 changes: 15 additions & 0 deletions Writerside/topics/OneBot11.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# OneBot11

OneBot组件是一个对
[OneBot11协议](https://github.com/botuniverse/onebot-11)
**客户端**实现。

## 交互方式

OneBot组件选择使用
[正向 HTTP](https://github.com/botuniverse/onebot-11/blob/master/communication/http.md)
作为API交互方式、
[正向 WebSocket](https://github.com/botuniverse/onebot-11/blob/master/communication/ws.md)
作为事件订阅的方式。

简单来说,就是不论是API交互还是事件订阅,都由OneBot组件作为**主动方**:主动发起HTTP请求、主动发起WebSocket连接。
43 changes: 43 additions & 0 deletions Writerside/topics/onebot11-quick-start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# 开始使用

开始使用OneBot11协议组件。

## 前期准备

### OneBot11协议服务端

OneBot组件是一个OneBot协议的**客户端**实现,
因此在使用之前,你需要安装、下载、启动一个支持OneBot11协议的**服务端**

<warning>

鉴于OneBot协议的主要应用场景的特殊性,
大多数服务端的实现库都**不建议、不允许**公开讨论、宣传有关它们的信息(尤其是影响力较大的简中互联网网站),
因此此处将 **不做列举**

你可以选择去GitHub等开源网站搜索各种实现库,
或者可以前往 [社群](https://simbot.forte.love/communities.html)
向其他人寻求帮助。

</warning>


### Java

如果你打算使用 Java,请确保你的Java版本至少为 **Java11**,因为
<tooltip term="simbot4">simbot4</tooltip>
在JVM平台上最低要求Java11。

如果你打算配合使用Spring Boot v3.x版本,确保Java版本至少为 **Java17**

### Kotlin

如果打算使用Kotlin,建议使用 Kotlin 2.0 以上版本。
具体的最低推荐版本以最新的 [simbot4版本](%simbot4-release%) 中的Kotlin版本为准。

### Kotlin multiplatform

如果打算使用Kotlin的其他非JVM平台或多平台,需要注意组件库中由于引入了Ktor(v2.x),
因此暂时无法使用Ktor Client不支持的平台(例如 `wasm-js`)。

> Ktor Client 支持平台可参考 [官方文档](https://ktor.io/docs/client-supported-platforms.html)
3 changes: 0 additions & 3 deletions Writerside/topics/quick-start.md

This file was deleted.

24 changes: 4 additions & 20 deletions Writerside/topics/use-onebot11.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,10 @@
# 使用OneBot11协议实现
# 使用核心库或Spring

## 前期准备

### Java

如果你打算使用 Java,请确保你的Java版本至少为 **Java11**,因为
<tooltip term="simbot4">simbot4</tooltip>
在JVM平台上最低要求Java11。

如果你打算配合使用Spring Boot v3.x版本,确保Java版本至少为 **Java17**

### Kotlin

如果打算使用Kotlin,建议使用 Kotlin 2.0 以上版本。
具体的最低推荐版本以最新的 [simbot4版本](%simbot4-release%) 中的Kotlin版本为准。

### Kotlin multiplatform

如果打算使用Kotlin的其他非JVM平台或多平台,需要注意组件库中由于引入了Ktor(v2.x),
因此暂时无法使用Ktor Client不支持的平台(例如 `wasm-js`)。

> Ktor Client 支持平台可参考 [官方文档](https://ktor.io/docs/client-supported-platforms.html)
参考
<a href="onebot11-quick-start.md"/>

## 安装
### 安装组件库
Expand Down

0 comments on commit da785f3

Please sign in to comment.