Skip to content

Commit

Permalink
update some thing...
Browse files Browse the repository at this point in the history
  • Loading branch information
DarkCWK authored and DarkCWK committed Aug 4, 2024
1 parent 36e0a4e commit 34f7dac
Show file tree
Hide file tree
Showing 7 changed files with 67 additions and 32 deletions.
2 changes: 1 addition & 1 deletion docs/Lagrange.Core/Login/Extern.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 扩展

在使用上述两种方法之一登陆完毕后, 你可以通过订阅 `BotOnlineEvent` 来判断是否登陆成功, 该 Event 将在下文介绍
你可以通过在登陆前订阅 `BotOnlineEvent` 来获取是否登陆成功, 该 Event 将在下文介绍

此外, 在登陆完毕后你还可以使用 `UpdateKeystore()` 方法获取新的 KeyStore 文件并保存以方便下次快速登陆

Expand Down
4 changes: 3 additions & 1 deletion docs/Lagrange.Core/QuickStart.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# 快速上手

1. 从 Nuget 导入 [Lagrange.Core](https://www.nuget.org/packages/Lagrange.Core) 到你的项目
1. 使用以下任一方案引用 `Lagrange.Core`
- 从 Nuget 导入 [Lagrange.Core](https://www.nuget.org/packages/Lagrange.Core) 到你的项目 (Nuget 可能不为最新)
- 通过 git submodule 功能将 [Lagrange.Core](https://github.com/LagrangeDev/Lagrange.Core) 作为解决方案中的项目, 并在你的项目中引用
2. [创建 Bot 实例](/Lagrange.Core/Start/)
3. [登录](/Lagrange.Core/Login/)
4. [监听并处理 Bot 收到的消息等事件](/Lagrange.Core/Event/)
Expand Down
14 changes: 7 additions & 7 deletions docs/Lagrange.Core/Start/CreateBot.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ var bot = BotFactory.Create(new BotConfig(), _deviceInfo, _keyStore);

## BotConfig 配置类

| 字段 | 类型 | 描述 |
| :------------------: | :-----------: | :-----------------------------------------: |
| `Protocol` | Protocols | 协议平台,默认为 `Linux` |
| `AutoReconnect` | bool | 自动重连,默认为 `true` |
| `UseIPv6Network` | bool | 是否使用 IPv6, 默认为 `false` |
| `GetOptimumServer` | bool | 自动使用链接状态最优的服务器, 默认为 `true` |
| `CustomSignProvider` | SignProvider? | 自定义签名服务器, 无签名可能导致无法登陆 |
| 字段 | 类型 | 描述 |
| :------------------: | :-----------: | :--------------------------------------------------------------------------: |
| `Protocol` | Protocols | 协议平台,默认为 `Linux` |
| `AutoReconnect` | bool | 自动重连,默认为 `true` |
| `UseIPv6Network` | bool | 是否使用 IPv6, 默认为 `false` |
| `GetOptimumServer` | bool | 自动使用链接状态最优的服务器, 默认为 `true` |
| `CustomSignProvider` | SignProvider? | 自定义签名服务器, 需要与 Protocol 和版本匹配, 不匹配或无签名可能导致无法登陆 |

## BotDeviceInfo 设备信息类

Expand Down
12 changes: 11 additions & 1 deletion docs/Lagrange.OneBot/API/OneBot/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,11 @@
# OneBot V11 标准 API
# OneBot V11 标准 API

请参考 [OneBot V11 API](https://github.com/botuniverse/onebot-11/blob/master/api/public.md)

::: warning 注意

并非所有标准 API 都已实现

具体请参阅 [README.md](https://github.com/LagrangeDev/Lagrange.Core?tab=readme-ov-file#lagrangeonebot)

:::
51 changes: 32 additions & 19 deletions docs/Lagrange.OneBot/Config/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

下载 Lagrange.OneBot 可执行文件并解压

1. 可以从 [Releases](https://github.com/LagrangeDev/Lagrange.Core/releases) 下载对应系统版本
1. 可以从 [Releases](https://github.com/LagrangeDev/Lagrange.Core/releases) 下载对应系统版本 (该版本可能不为最新版本)
2. 还可以从 [Actions](https://github.com/KonataDev/Lagrange.Core/actions/workflows/Lagrange.OneBot-build.yml) 中获得当前最新的构建

::: warning 注意
Expand All @@ -13,6 +13,19 @@

:::

::: danger 运行前请阅读

遇到问题请按照以下步骤进行

1. 查看 [Github 仓库](https://github.com/LagrangeDev/Lagrange.Core)中的 `README.md` 以确保没有配置错误

2. 查看 [Github 仓库](https://github.com/LagrangeDev/Lagrange.Core)中的 Issue 查看此问题是否因为某种原因未能修复

3. 将 application.json 中的 `Logging.LogLevel.Default` 改为 `Trace` 并重启 Lagrange 复现问题
然后将 <span style="background: linear-gradient(to bottom right, skyblue, pink); color: black; font-weight: 900">Lagrange Lagrange Lagrange</span> 的日志 <span style="background: linear-gradient(to bottom right, skyblue, pink); color: black; font-weight: 900">全部 全部 全部 全部 全部 全部 全部 全部 全部</span> 复制并发送到 Issue 或群里提问

:::

## 运行

::: code-group
Expand Down Expand Up @@ -124,27 +137,27 @@ NTQQ 的 SignServer **不可与 Android 协议混用**(如 unidbg-fetch-qsign

```json5
{
"Type": "ReverseWebSocket",
"Host": "127.0.0.1",
"Port": 8080,
"Suffix": "/onebot/v11/ws",
"ReconnectInterval": 5000,
"HeartBeatInterval": 5000,
"HeartBeatEnable": true,
"AccessToken": "",
Type: "ReverseWebSocket",
Host: "127.0.0.1",
Port: 8080,
Suffix: "/onebot/v11/ws",
ReconnectInterval: 5000,
HeartBeatInterval: 5000,
HeartBeatEnable: true,
AccessToken: "",
}
```

### 正向 WebSocket 配置

```json5
{
"Type": "ForwardWebSocket",
"Host": "127.0.0.1",
"Port": 8081,
"HeartBeatInterval": 5000,
"HeartBeatEnable": true,
"AccessToken": "",
Type: "ForwardWebSocket",
Host: "127.0.0.1",
Port: 8081,
HeartBeatInterval: 5000,
HeartBeatEnable: true,
AccessToken: "",
}
```

Expand Down Expand Up @@ -173,10 +186,10 @@ NTQQ 的 SignServer **不可与 Android 协议混用**(如 unidbg-fetch-qsign

```json5
{
"Type": "Http",
"Host": "*",
"Port": 8083,
"AccessToken": ""
Type: "Http",
Host: "*",
Port: 8083,
AccessToken: "",
}
```

Expand Down
12 changes: 11 additions & 1 deletion docs/Lagrange.OneBot/Segment/OneBot/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,11 @@
# OneBot V11 标准消息链
# OneBot V11 标准消息链

请参考 [OneBot V11 Segment](https://github.com/botuniverse/onebot-11/blob/master/message/segment.md)

::: warning 注意

并非所有标准 API 都已实现

具体请参阅 [README.md](https://github.com/LagrangeDev/Lagrange.Core?tab=readme-ov-file#lagrangeonebot)

:::
4 changes: 2 additions & 2 deletions docs/Lagrange.OneBot/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

Lagrange.Core 实现了 OneBot V11 的通信协议, 可以和主流 Bot 框架进行通信

1. [nightly](https://github.com/LagrangeDev/Lagrange.Core/releases/tag/nightly) 通过 Nightly Release 获取最新的 Self-Contained .NET 8 程序包
2. [Docker](https://github.com/LagrangeDev/Lagrange.Core/pkgs/container/lagrange.onebot) 通过 ghcr.io 的 Docker 部署 (CI 自动打包, 可以获取每一个 Commit 的更新内容)
1. [nightly](https://github.com/LagrangeDev/Lagrange.Core/releases/tag/nightly) 通过 Nightly Release 获取 Self-Contained .NET 8 程序包 (该版本可能不为最新版本)
2. [Docker](https://github.com/LagrangeDev/Lagrange.Core/pkgs/container/lagrange.onebot) 通过 ghcr.io 的 Docker 部署
3. [Actions](https://github.com/LagrangeDev/Lagrange.Core/actions) 通过 Docker 获取 Framework-Dependent .NET 7 / 8 程序包

::: tip 提示
Expand Down

0 comments on commit 34f7dac

Please sign in to comment.