更新文档

Writerside/topics/Home.md

@@ -1,8 +1,8 @@
 # 前言&简介
 
-<tldr>
-    <p>文档当前目标版本: <a href="https://github.com/simple-robot/simbot-component-miyoushe-villa/releases/v%version%"><b>v%version%</b></a></p>
-</tldr>
+<note>
+<include from="snippets.md" element-id="doc-desc-version" />
+</note>
 
 欢迎来到 [<tooltip term="Simple Robot">Simple Robot</tooltip>](https://github.com/simple-robot/simpler-robot)
 （下文简称 <tooltip term="simbot">simbot</tooltip> ）

Writerside/topics/Welcome.topic

@@ -24,17 +24,17 @@
         <!--    Add up to 2 topics that you want to promote. Use the "type" attribute to select an icon.    -->
         <spotlight>
 <!--            <a href="" type="account" summary="This overrides the card summary of the topic">Custom card title</a>-->
-            <a type="account" summary="欢迎来到米游社大别野组件应用&amp;开发手册！">欢迎！</a>
+            <a type="account" summary="欢迎来到米游社大别野组件应用&amp;开发手册！手册仍在完善中，期待您的反馈或贡献！">欢迎！</a>
             <a href="Home.md" type="search" summary="米游社大别野组件的概述以及各个模块的简介" />
         </spotlight>
 
         <!--    Add several topics that are most important for this section.    -->
         <primary>
             <title>快速开始</title>
-            <a href="use-api.md"/>
-            <a href="use-stdlib.md"/>
-            <a href="use-core.md"/>
-            <a href="use-spring-boot.md"/>
+            <a href="use-api.md" summary="使用 API模块 请求大别野API的说明与示例" />
+            <a href="use-stdlib.md" summary="使用 标准库模块 请求大别野API的说明与示例"/>
+            <a href="use-core.md" summary="使用 核心模块 请求大别野API的说明与示例"/>
+            <a href="use-spring-boot.md" summary="使用 核心模块 配合Spring Boot的说明与示例"/>
         </primary>
 
         <!--    Add several topics that are less important or are relevant only for advanced/experienced users.    -->

Writerside/topics/bot-config.md

@@ -0,0 +1,148 @@
+# Bot配置文件
+
+<tldr>
+<p>在使用 <b>Spring Boot</b> 时自动注册 bot 所需的配置文件。</p>
+</tldr>
+
+## 简单示例
+
+```json
+{
+    "component": "simbot.villa",
+    "ticket": {
+        "botId": "你的botId",
+        "botSecret": "你的botSecret"
+    }
+}
+```
+{collapsible="true" default-state="expanded" collapsed-title="简单示例"}
+
+```json
+{
+    "component": "simbot.villa",
+    "ticket": {
+        "botId": "你的botId",
+        "botSecret": "你的botSecret"
+    },
+    "config": {
+        "loginVillaId": "0",
+        "loginMeta": null,
+        "loginRegion": null,
+        "timeout": null
+    }
+}
+```
+{collapsible="true" default-state="collapsed" collapsed-title="完整示例"}
+
+## 属性描述
+
+<deflist>
+<def title="component">
+
+固定值：`simbot.villa`
+
+</def>
+<def title="ticket">
+
+bot用于登录的票据信息，必填。
+
+<deflist style="wide">
+<def title="botId">
+
+`String`
+
+bot开发配置中的 `bot_id`
+
+</def>
+<def title="botSecret">
+
+`String`
+
+bot开发配置中的 `secret`
+
+</def>
+</deflist>
+
+</def>
+
+<def title="config">
+可选项，提供一些额外的可配置属性。
+
+<deflist>
+<def title="loginVillaId">
+
+`String`
+
+创建连接（获取 ws 连接信息）时提供给 API 的 token 中的 `villa_id` 属性。
+
+机器人未上线时，`villa_id` 使用测试别野，上线后可传 `0`。
+
+默认为 `0`。
+
+</def>
+<def title="loginMeta">
+
+`Map<String, String>?`
+
+应用在 `PLogin.meta` 上的属性。
+
+默认为 `null`。
+
+</def>
+<def title="loginRegion">
+
+`String?`
+
+应用在 `PLogin.region` 上的属性。如果为 `null` 则会使用一个随机值。
+
+默认为 `null`。
+
+</def>
+<def title="timeout" style="wide">
+
+`TimeoutConfig?`
+
+与部分超时相关的配置信息。
+当任意属性不为 `null` 时会为 bot 中用于请求API的 `HttpClient`
+配置 [HttpTimeout][HttpTimeout] 插件。
+
+默认为 `null`。
+
+<deflist>
+<def title="apiHttpRequestTimeoutMillis">
+
+`Long?`
+
+API请求中的超时请求配置。参考 [HttpTimeout][HttpTimeout] 中的相关说明。
+
+默认为 `null`。
+
+</def>
+<def title="apiHttpConnectTimeoutMillis">
+
+`Long?`
+
+API请求中的超时请求配置。参考 [HttpTimeout][HttpTimeout] 中的相关说明。
+
+默认为 `null`。
+
+</def>
+<def title="apiHttpSocketTimeoutMillis">
+
+`Long?`
+
+API请求中的超时请求配置。参考 [HttpTimeout][HttpTimeout] 中的相关说明。
+
+默认为 `null`。
+
+</def>
+</deflist>
+
+</def>
+</deflist>
+
+</def>
+
+</deflist>
+
+[HttpTimeout]: https://ktor.io/docs/timeout.html