mirror of
https://github.com/wwiinnddyy/LanMountainDesktop.git
synced 2026-06-23 09:54:25 +08:00
feat.新增了插件开发文档
This commit is contained in:
92
docs/Plugins develop/07-发布与运营/01-插件打包规范.md
Normal file
92
docs/Plugins develop/07-发布与运营/01-插件打包规范.md
Normal file
@@ -0,0 +1,92 @@
|
||||
# 01-插件打包规范
|
||||
|
||||
了解 .laapp 包的规范和结构,确保插件能正确安装和运行。
|
||||
|
||||
---
|
||||
|
||||
## 📦 .laapp 文件格式
|
||||
|
||||
`.laapp` 是阑山桌面的插件包格式,本质上是一个 **ZIP 压缩包**。
|
||||
|
||||
### 文件结构
|
||||
|
||||
```
|
||||
MyPlugin.laapp
|
||||
├── plugin.json # 插件清单(必需)
|
||||
├── MyPlugin.dll # 主程序集(必需)
|
||||
├── Localization/ # 本地化文件夹
|
||||
│ ├── zh-CN.json
|
||||
│ └── en-US.json
|
||||
└── *.dll # 依赖项
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📋 plugin.json 规范
|
||||
|
||||
### 必需字段
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "com.example.myplugin",
|
||||
"name": "我的插件",
|
||||
"description": "插件描述",
|
||||
"author": "作者名",
|
||||
"version": "1.0.0",
|
||||
"apiVersion": "4.0.1",
|
||||
"entranceAssembly": "MyPlugin.dll",
|
||||
"sharedContracts": []
|
||||
}
|
||||
```
|
||||
|
||||
### 字段验证规则
|
||||
|
||||
| 字段 | 规则 |
|
||||
|-----|------|
|
||||
| `id` | 小写字母、数字、点号,反向域名格式 |
|
||||
| `version` | 语义化版本(x.y.z) |
|
||||
| `apiVersion` | 必须与 SDK 版本兼容 |
|
||||
| `entranceAssembly` | 必须与 DLL 文件名一致 |
|
||||
|
||||
---
|
||||
|
||||
## 🔨 构建配置
|
||||
|
||||
### .csproj 关键配置
|
||||
|
||||
```xml
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
<PropertyGroup>
|
||||
<TargetFramework>net10.0</TargetFramework>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="LanMountainDesktop.PluginSdk" Version="4.0.1" />
|
||||
</ItemGroup>
|
||||
|
||||
<!-- 确保资源文件复制到输出目录 -->
|
||||
<ItemGroup>
|
||||
<None Update="plugin.json">
|
||||
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
|
||||
</None>
|
||||
<None Update="Localization\**\*.json">
|
||||
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
|
||||
</None>
|
||||
</ItemGroup>
|
||||
</Project>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ✅ 打包检查清单
|
||||
|
||||
- [ ] `plugin.json` 格式正确
|
||||
- [ ] `id` 全局唯一
|
||||
- [ ] `apiVersion` 与 SDK 版本匹配
|
||||
- [ ] DLL 文件名与 `entranceAssembly` 一致
|
||||
- [ ] 所有依赖项已包含
|
||||
- [ ] 本地化文件完整
|
||||
|
||||
---
|
||||
|
||||
*最后更新:2026年4月*
|
||||
Reference in New Issue
Block a user