一部分NativeAPI和一部分Milky

Lilyltt · Lilyltt · commit 3238590849dd · 2025-05-29T23:30:27.000+08:00
diff --git a/docs/v2/.vitepress/catalogue.ts b/docs/v2/.vitepress/catalogue.ts
@@ -27,6 +27,15 @@ export const milkySidebar = {
 		{
 			text: "Lagrange.Milky",
 			link: "/Lagrange.Milky/",
+		},
+		{
+			text: "快速开始",
+			items: [
+				{
+					text: "快速开始 & 配置",
+					link: "/Lagrange.Milky/Config/",
+				}
+			]
 		}
 	],
 }
diff --git a/docs/v2/.vitepress/nav.ts b/docs/v2/.vitepress/nav.ts
@@ -26,6 +26,10 @@ export const milkyNav = {
 		{
 			text: "Lagrange.Milky",
 			link: "/Lagrange.Milky/",
-		}
+		},
+		{
+			text: "快速开始",
+			link: "/Lagrange.Milky/Config/",
+		},
 	],
 }
diff --git a/docs/v2/Lagrange.Core.NativeAPI/Common/BotConfigStruct.md b/docs/v2/Lagrange.Core.NativeAPI/Common/BotConfigStruct.md
@@ -0,0 +1,11 @@
+# BotConfigStruct
+
+| 字段名               | 类型   | 默认值         | 说明              |
+|-------------------|------|-------------|-----------------|
+| Protocol          | byte | 0b00000100  | 协议标识位,默认为Linux  |
+| AutoReconnect     | bool | true        | 是否自动重连          |
+| UseIPv6Network    | bool | false       | 是否使用 IPv6 网络    |
+| GetOptimumServer  | bool | true        | 是否获取最优服务器       |
+| HighwayChunkSize  | uint | 1024 * 1024 | Highway的块大小（字节） |
+| HighwayConcurrent | uint | 4           | Highway并发数量     |
+| AutoReLogin       | bool | true        | 是否自动重新登录        |
diff --git a/docs/v2/Lagrange.Core.NativeAPI/Common/BotFriendCategoryStruct.md b/docs/v2/Lagrange.Core.NativeAPI/Common/BotFriendCategoryStruct.md
@@ -0,0 +1,8 @@
+# BotFriendCategoryStruct
+
+| 字段名    | 类型              | 默认值 | 说明         |
+|--------|-----------------|-----|------------|
+| Id     | int             | 0   | 分组 ID      |
+| Name   | ByteArrayNative | 无   | 分组名称（字节表示） |
+| Count  | int             | 0   | 分组内好友数量    |
+| SortId | int             | 0   | 分组排序 ID    |
diff --git a/docs/v2/Lagrange.Core.NativeAPI/Common/BotKeystoreStruct.md b/docs/v2/Lagrange.Core.NativeAPI/Common/BotKeystoreStruct.md
@@ -0,0 +1,28 @@
+# BotKeystoreStruct
+
+| 字段名                | 类型                  | 默认值      | 说明           |
+|--------------------|---------------------|----------|--------------|
+| Uin                | long                | 0        | 用户 UIN（QQ号）  |
+| Uid                | ByteArrayNative     | new()    | 用户唯一标识符      |
+| Guid               | ByteArrayNative     | new()    | 设备 GUID      |
+| AndroidId          | ByteArrayNative     | new()    | Android ID   |
+| Qimei              | ByteArrayNative     | new()    | 设备 QIMEI 号   |
+| DeviceName         | ByteArrayNative     | new()    | 设备名称         |
+| A2                 | ByteArrayNative     | new()    | 登录凭证 A2      |
+| A2Key              | ByteArrayNative     | byte[16] | A2 的密钥       |
+| D2                 | ByteArrayNative     | new()    | 登录凭证 D2      |
+| D2Key              | ByteArrayNative     | byte[16] | D2 的密钥       |
+| A1                 | ByteArrayNative     | new()    | 登录凭证 A1      |
+| A1Key              | ByteArrayNative     | byte[16] | A1 的密钥       |
+| NoPicSig           | ByteArrayNative     | new()    | 无图验证码签名      |
+| TgtgtKey           | ByteArrayNative     | new()    | TGTGT 加密密钥   |
+| Ksid               | ByteArrayNative     | new()    | 会话 ID        |
+| SuperKey           | ByteArrayNative     | new()    | 超级登录密钥       |
+| StKey              | ByteArrayNative     | new()    | ST 密钥        |
+| StWeb              | ByteArrayNative     | new()    | Web ST 密钥    |
+| St                 | ByteArrayNative     | new()    | ST 凭证        |
+| WtSessionTicket    | ByteArrayNative     | new()    | WtSession 凭证 |
+| WtSessionTicketKey | ByteArrayNative     | new()    | WtSession 密钥 |
+| RandomKey          | ByteArrayNative     | byte[16] | 会话随机密钥       |
+| SKey               | ByteArrayNative     | new()    | SKey 密钥      |
+| PsKey              | ByteArrayDictNative | new()    | PsKey 表      |
diff --git a/docs/v2/Lagrange.Core.NativeAPI/Common/ByteArrayDictNative.md b/docs/v2/Lagrange.Core.NativeAPI/Common/ByteArrayDictNative.md
@@ -0,0 +1,6 @@
+# ByteArrayDictNative
+
+| 字段名    | 类型     | 说明           |
+|--------|--------|--------------|
+| Length | int    | 字典中键值对的数量    |
+| Data   | IntPtr | 指向实际键值对数组的指针 |
diff --git a/docs/v2/Lagrange.Core.NativeAPI/Common/ByteArrayKVPStruct.md b/docs/v2/Lagrange.Core.NativeAPI/Common/ByteArrayKVPStruct.md
@@ -0,0 +1,6 @@
+# ByteArrayKVPNative
+
+| 字段名   | 类型              | 说明       |
+|-------|-----------------|----------|
+| Key   | ByteArrayNative | 字节数组形式的键 |
+| Value | ByteArrayNative | 字节数组形式的值 |
diff --git a/docs/v2/Lagrange.Core.NativeAPI/Common/NativeByteArray.md b/docs/v2/Lagrange.Core.NativeAPI/Common/NativeByteArray.md
@@ -0,0 +1,8 @@
+# NativeByteArray
+
+Byte[]的封送类型,指针需要送回给NativeAPI释放
+
+| 字段名    | 类型     | 说明        |
+|--------|--------|-----------|
+| Length | int    | 字节数组的长度   |
+| Data   | IntPtr | 指向字节数据的指针 |
diff --git a/docs/v2/Lagrange.Core.NativeAPI/Common/index.md b/docs/v2/Lagrange.Core.NativeAPI/Common/index.md
@@ -0,0 +1,3 @@
+# 基本类型
+
+这里包含了消息与事件以外的Core类型,以及为了封送必要的类型
diff --git a/docs/v2/Lagrange.Core.NativeAPI/Event/BotCaptchaEventStruct.md b/docs/v2/Lagrange.Core.NativeAPI/Event/BotCaptchaEventStruct.md
@@ -0,0 +1,5 @@
+# BotCaptchaEventStruct
+
+| 字段名        | 类型              | 默认值   | 说明       |
+|------------|-----------------|-------|----------|
+| CaptchaUrl | ByteArrayNative | new() | 验证码图片URL |
diff --git a/docs/v2/Lagrange.Core.NativeAPI/Event/ReverseEventCountStruct.md b/docs/v2/Lagrange.Core.NativeAPI/Event/ReverseEventCountStruct.md
@@ -0,0 +1,14 @@
+# ReverseEventCountStruct
+
+| 字段名                            | 类型 | 默认值 | 说明                         |
+|-----------------------------------|------|--------|------------------------------|
+| BotCaptchaEventCount              | int  | 0      | 验证码事件计数               |
+| BotLoginEventCount                | int  | 0      | 登录事件计数                 |
+| BotLogEventCount                  | int  | 0      | 日志事件计数                 |
+| BotMessageEventCount              | int  | 0      | 消息事件计数                 |
+| BotNewDeviceVerifyEventCount      | int  | 0      | 新设备验证事件计数           |
+| BotOnlineEventCount               | int  | 0      | 上线事件计数                 |
+| BotQrCodeEventCount               | int  | 0      | 二维码生成事件计数           |
+| BotQrCodeQueryEventCount          | int  | 0      | 二维码查询事件计数           |
+| BotRefreshKeystoreEventCount      | int  | 0      | Keystore 刷新事件计数        |
+| BotSMSEventCount                  | int  | 0      | 短信验证事件计数             |
diff --git a/docs/v2/Lagrange.Core.NativeAPI/index.md b/docs/v2/Lagrange.Core.NativeAPI/index.md
@@ -1 +1,26 @@
-### 未完工
+# Lagrange.Core.NativeAPI
+
+## 简介
+Lagrange.Core.NativeAPI(以下简称NAPI)是对Lagrange.Core使用[C ABI](https://zh.m.wikipedia.org/wiki/%E5%BA%94%E7%94%A8%E4%BA%8C%E8%BF%9B%E5%88%B6%E6%8E%A5%E5%8F%A3)封装的本机库,采用NativeAOT,无需运行时,旨在为各应用端提供封装的嵌入的协议端使用方法
+
+## 协议许可
+Lagrange.Core基于GPl3.0开源,所以在你使用它的衍生物二进制NativeAPI做动态链接调用的时候,不需要把你自己的代码开源,但你仍然需要在一个合适的位置声明协议的提供方,并附带原项目的链接
+
+## 约定
+NativeAPI的命名采取驼峰命名的方式,我们尽可能的保证与Core的类型命名一致,但对于实在没无办法避开的OOP/GC类型,文档里会进行额外的说明
+
+**所有**由NativeAPI发送的指针均需要通过NativeAPI的FreeMemory()方法进行释放,同时,所有传给NativeAPI的指针在方法调用结束后都需要由调用方释放,NativeAPI内部不会在方法结束调用后仍然持有传入的指针和内存
+
+所有的string都会被转化为以utf8编码的NativeByteArray类型封送,不会存在其他格式的字符串,NAPI也仅接受对应的格式传入
+
+NativeAPI不使用SAFEARRAY,所有的数组都有对应的封装,并声明其长度,相关封装定义可以在文档的Common类下查看
+
+## 开始开发
+
+1.基本类型
+
+2.登录
+
+3.事件
+
+4.发送消息
diff --git a/docs/v2/Lagrange.Milky/Config/index.md b/docs/v2/Lagrange.Milky/Config/index.md
@@ -0,0 +1,89 @@
+# 快速部署 & 配置
+
+## 下载安装
+
+开发期可以从[Actions](https://github.com/LagrangeDev/LagrangeV2/actions/workflows/milky-build.yaml)下载最新的构建
+
+## 运行
+
+::: code-group
+
+```text [Windows]
+双击 Lagrange.Milky.exe 运行即可
+```
+
+```shell [Linux/MacOS]
+# 可执行权限（可选）
+chmod +x ./Lagrange.Milky
+# 运行
+./Lagrange.Milky
+```
+
+:::
+
+第一次运行时, 会在同级目录下自动生成默认的 `appsettings.jsonc` 配置文件, 请按照下文的指导正确[修改配置文件](#配置文件)以设置 Lagrange.
+
+在配置文件按需修改后（推荐使用扫码登录）, 重新运行, Lagrange 将正式运行在同一文件夹下会出现一张登录二维码图片 qrcode.png, 在二维码过期前尽快使用手机 QQ 扫码连接
+
+::: tip 提示
+
+手机扫描登录二维码时, 推荐勾选「下次登录无需确认」
+
+:::
+
+::: warning 注意
+
+当前主签名尚未同步, 如出现签名相关错误请加入群获取Error签名地址
+
+:::
+
+## 配置文件
+
+```json5{11-12,24-43}
+
+{
+    "$schema": "https://json.schemastore.org/appsettings.json",
+    "Logging": {
+        "LogLevel": {
+            "Default": "Trace", // 开发阶段默认为 Trace, 提 Issue 时也请切换到 Trace
+        },
+    },
+    "Core": {
+        "Server": {
+            // "AutoReconnect": true, // 自动重连
+            // "UseIPv6Network": false, // 使用 IPv6 网络
+            // "GetOptimumServer": true, // 获取最佳服务器
+        },
+        "Signer": {
+            "Base": "https://sign.lagrangecore.org/api/sign", // 当前主签名尚未同步,请加入群获取Error签名地址 // 内置, 为 Cloudflare, 可能需要代理
+            "Version": "30366", // QQ版本号, 在不知道具体版本时不要修改
+            // "ProxyUrl": null, // 代理地址, 留空不使用代理, 仅支持 http 代理, example: http://127.0.0.1:7890
+        },
+        "Login": {
+            "Uin": 0, // 为0表示使用扫码登录, 否则使用指定的 Uin 登录, 扫码的账号Uin不能与此处不一致
+            // "Password": null, // 密码
+            // "DeviceName": "LGR-Milky", // 设备名称, 可选
+            // "AutoReLogin": true, // 自动重连
+            // "CompatibleQrCode": false, // 兼容模式下的二维码, 扫不上可选
+            // "UseOnlineCaptchaResolver": true, // 使用在线Captcha解析器, 使用由 Lagrange 提供的验证码链接
+        },
+    },
+    "Milky": {
+        "Host": "127.0.0.1", // 监听地址
+        "Port": 3000, // 监听端口
+        // "Prefix": "/", // 前缀, 可选, 默认为 "/"
+        // "UseWebSocket": true, // 是否使用 WebSocket, 默认为 true
+        // "WebHook": null, // Default WebHook 配置, 可选
+        // "WebHook": {
+        //     "Url": "http://127.0.0.1:3001/webhook" // WebHook 地址, 可选
+        // }
+    },
+}
+
+
+```
+
+## 协议相关
+
+参见[Milky文档](https://milky.ntqqrev.org/guide/introduction.html), 此处不做过多赘述
+
diff --git a/docs/v2/Lagrange.Milky/index.md b/docs/v2/Lagrange.Milky/index.md
@@ -1 +1,19 @@
-### 未完工
+# Lagrange.Milky
+
+Milky协议实现, 支持与主流Bot框架通信。
+
+## 获取方式
+
+1. [Actions](https://github.com/LagrangeDev/LagrangeV2/actions/workflows/milky-build.yaml)
+
+::: tip 提示
+
+AOT Publish 无需 .NET 运行时支持, 可直接运行。
+
+仅支持64位架构的win, linux, mac, 如需运行时支持其他架构, 请自行编译并使用JIT。
+
+:::
+
+## 部署 & 配置
+
+[快速部署 & 配置](/Lagrange.Milky/Config/)

Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,15 @@ export const milkySidebar = {`
`27`	`27`	`{`
`28`	`28`	`text: "Lagrange.Milky",`
`29`	`29`	`link: "/Lagrange.Milky/",`
	`30`	`+ },`
	`31`	`+ {`
	`32`	`+ text: "快速开始",`
	`33`	`+ items: [`
	`34`	`+ {`
	`35`	`+ text: "快速开始 & 配置",`
	`36`	`+ link: "/Lagrange.Milky/Config/",`
	`37`	`+ }`
	`38`	`+ ]`
`30`	`39`	`}`
`31`	`40`	`],`
`32`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,10 @@ export const milkyNav = {`
`26`	`26`	`{`
`27`	`27`	`text: "Lagrange.Milky",`
`28`	`28`	`link: "/Lagrange.Milky/",`
`29`		`- }`
	`29`	`+ },`
	`30`	`+ {`
	`31`	`+ text: "快速开始",`
	`32`	`+ link: "/Lagrange.Milky/Config/",`
	`33`	`+ },`
`30`	`34`	`],`
`31`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# 基本类型`
	`2`	`+`
	`3`	`+这里包含了消息与事件以外的Core类型,以及为了封送必要的类型`