mirror of
https://github.com/wwiinnddyy/LanMountainDesktop.git
synced 2026-06-20 23:54:26 +08:00
0.5.9
中文与插件市场
This commit is contained in:
@@ -1,27 +1,21 @@
|
||||
# LanAirApp
|
||||
|
||||
`LanAirApp` 是阑山桌面插件生态的对外发布工作区。
|
||||
## 中文
|
||||
|
||||
这里集中放置:
|
||||
- 插件开发标准
|
||||
- 插件打包与构建工具
|
||||
- 插件开发与打包文档
|
||||
- 示例插件
|
||||
`LanAirApp` 是阑山桌面插件生态的对外工作区。这个目录是宿主仓库中的镜像副本,权威版本以独立 `LanAirApp` 仓库为准。
|
||||
|
||||
目录结构:
|
||||
- `docs/`:插件开发文档、打包文档
|
||||
- `plugins/`:第一方插件项目,例如插件市场插件
|
||||
- `releases/`:已经打包完成、可直接分享与安装的 `.laapp` 插件包
|
||||
- `samples/`:示例插件,其中 `LanMountainDesktop.SamplePlugin` 是示例开发插件
|
||||
- `standards/`:插件标准文件与模板
|
||||
- `tools/`:插件打包与构建工具
|
||||
### 目录说明
|
||||
|
||||
面向用户的安装流程:
|
||||
1. 将插件构建或打包为 `.laapp` 文件。
|
||||
2. 打开 `设置 -> 插件`。
|
||||
3. 点击 `打开 .laapp 插件包`。
|
||||
4. 选择插件包完成安装。
|
||||
- `docs/`:插件开发与打包文档。
|
||||
- `samples/`:示例插件与参考项目。
|
||||
- `standards/`:插件清单和目录结构约定。
|
||||
- `tools/`:插件打包与辅助工具。
|
||||
|
||||
宿主侧的插件加载、安装、发现、解析与设置页接入逻辑,保留在 `LanMountainDesktop/plugins/`。
|
||||
### 与宿主的关系
|
||||
|
||||
`LanMountainDesktop.PluginSdk` 仅作为插件开发 SDK 使用,提供 `IPlugin`、`IPluginContext`、清单模型与扩展注册接口。
|
||||
- 宿主程序只连接独立 `LanAirApp` 仓库中的官方市场索引。
|
||||
- 每个插件项目应在仓库根目录提供 `.laapp` 和 `README.md`。
|
||||
|
||||
## English
|
||||
|
||||
`LanAirApp` is the external-facing workspace for the LanMountainDesktop plugin ecosystem. This copy is only a mirror inside the host repository; the standalone `LanAirApp` repository remains the source of truth.
|
||||
|
||||
@@ -1,41 +1,16 @@
|
||||
# 插件开发文档
|
||||
# 插件开发指南
|
||||
|
||||
LanMountainDesktop 插件基于 `LanMountainDesktop.PluginSdk` 开发。
|
||||
## 中文
|
||||
|
||||
`LanAirApp/` 负责对外发布插件开发标准、示例插件和打包工具;宿主应用内部的插件加载与解析逻辑位于 `LanMountainDesktop/plugins/`。
|
||||
`LanMountainDesktop.PluginSdk` 只提供插件作者需要依赖的开发契约,不再承载宿主侧运行时加载实现。
|
||||
使用 `LanMountainDesktop.PluginSdk` 开发插件时,至少需要准备:
|
||||
|
||||
## 必需文件
|
||||
- `plugin.json`
|
||||
- `plugin.json` 中声明的入口程序集
|
||||
- 使用插件入口特性标记的入口类型
|
||||
- 插件入口程序集
|
||||
- 入口类
|
||||
- 本地化资源
|
||||
|
||||
## 推荐开发流程
|
||||
1. 以 `LanAirApp/samples/LanMountainDesktop.SamplePlugin` 为起点。
|
||||
2. 修改 `plugin.json`,填写你自己的插件 `id`、名称、作者、版本和入口程序集。
|
||||
3. 实现 `IPlugin` 或继承 `PluginBase`。
|
||||
4. 通过 `IPluginContext` 注册服务、设置页和桌面组件。
|
||||
5. 将输出内容打包为 `.laapp` 文件。
|
||||
推荐从示例插件开始,先完成清单、入口、设置页和桌面组件,再逐步扩展业务逻辑。
|
||||
|
||||
## 运行时能力
|
||||
- 插件可以注册自己的设置页。
|
||||
- 插件可以注册自己的桌面组件。
|
||||
- 插件可以注册自己的服务,并通过插件消息总线进行通信。
|
||||
- 宿主优先加载 `.laapp` 包,其次才是散装清单。
|
||||
## English
|
||||
|
||||
## 多语言建议
|
||||
- 插件应当内置 `Localization/zh-CN.json` 与 `Localization/en-US.json`。
|
||||
- 插件界面文案、组件文案、状态文案建议统一通过插件本地化层读取。
|
||||
- 建议优先读取宿主传入的语言代码,再回退到插件默认语言。
|
||||
|
||||
## 目录建议
|
||||
一个标准插件项目建议至少包含:
|
||||
- `plugin.json`
|
||||
- `Localization/zh-CN.json`
|
||||
- `Localization/en-US.json`
|
||||
- 插件程序集与依赖文件
|
||||
|
||||
## 示例项目与工具
|
||||
- 示例插件:`LanAirApp/samples/LanMountainDesktop.SamplePlugin`
|
||||
- 打包工具:`LanAirApp/tools/LanMountainDesktop.PluginPackager`
|
||||
- 标准模板:`LanAirApp/standards/plugin.template.json`
|
||||
To build a plugin with `LanMountainDesktop.PluginSdk`, prepare the manifest, plugin assembly, entrance class, and localization resources first.
|
||||
|
||||
@@ -1,34 +1,14 @@
|
||||
# 插件打包文档
|
||||
# 插件打包指南
|
||||
|
||||
LanMountainDesktop 插件的安装包格式固定为 `.laapp`。
|
||||
## 中文
|
||||
|
||||
`LanAirApp/` 负责提供打包标准与打包工具;`.laapp` 的安装、发现和运行时加载由 `LanMountainDesktop/plugins/` 负责。
|
||||
阑山桌面插件的标准安装格式为 `.laapp`。插件项目应在仓库根目录提供:
|
||||
|
||||
## `.laapp` 格式说明
|
||||
- 本质上是一个标准 zip 压缩包
|
||||
- 包根目录必须包含 `plugin.json`
|
||||
- 包根目录还必须包含入口程序集及其依赖
|
||||
- `.laapp` 安装包
|
||||
- `README.md`
|
||||
|
||||
## 建议打包内容
|
||||
- `plugin.json`
|
||||
- `YourPlugin.dll`
|
||||
- 依赖程序集
|
||||
- `Localization/zh-CN.json`
|
||||
- `Localization/en-US.json`
|
||||
- 插件运行所需的其他资源文件
|
||||
官方市场索引只负责记录链接和校验信息。
|
||||
|
||||
## 使用打包工具
|
||||
```powershell
|
||||
dotnet run --project .\LanAirApp\tools\LanMountainDesktop.PluginPackager -- --input .\path\to\plugin-output --output .\artifacts\YourPlugin.laapp --overwrite
|
||||
```
|
||||
## English
|
||||
|
||||
## 应用内安装流程
|
||||
1. 打开 `设置 -> 插件`
|
||||
2. 点击 `打开 .laapp 插件包`
|
||||
3. 选择要安装的插件包
|
||||
4. 如果插件注册了设置页或组件,安装后重启应用
|
||||
|
||||
## 注意事项
|
||||
- `plugin.json` 中的 `entranceAssembly` 必须能在包内找到。
|
||||
- 包内应尽量避免无关开发产物。
|
||||
- `.laapp` 是标准安装格式,建议不要对外分发散装目录。
|
||||
The standard package format is `.laapp`. Plugin repositories should keep the package and `README.md` in the repository root, while the official market index stores metadata and validation data.
|
||||
|
||||
@@ -1,16 +1,9 @@
|
||||
# LanMountainDesktop.SamplePlugin
|
||||
|
||||
这是阑山桌面的**示例开发插件**。
|
||||
## 中文
|
||||
|
||||
它用于演示以下能力:
|
||||
- 插件入口与 `plugin.json` 清单
|
||||
- 插件服务注册
|
||||
- 插件设置页注册
|
||||
- 插件桌面组件注册
|
||||
- 插件内通信与状态更新
|
||||
- `.laapp` 打包与安装流程
|
||||
- 插件多语言资源组织方式
|
||||
这是阑山桌面的标准示例插件,用于演示插件清单、设置页、桌面组件、服务注册、本地化和 `.laapp` 打包流程。
|
||||
|
||||
如果你要开发自己的插件,建议以这个目录为模板开始。
|
||||
## English
|
||||
|
||||
这个目录仅用于示例开发与打包发布,不承载宿主应用内部的插件加载逻辑。
|
||||
This is the standard sample plugin used to demonstrate manifests, settings pages, desktop components, service registration, localization, and `.laapp` packaging.
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
# 示例插件
|
||||
# 示例插件目录
|
||||
|
||||
本目录用于存放阑山桌面的示例开发插件。
|
||||
## 中文
|
||||
|
||||
当前示例:
|
||||
- `LanMountainDesktop.SamplePlugin`
|
||||
本目录用于存放阑山桌面的示例插件和参考实现。
|
||||
|
||||
说明:
|
||||
- 这个插件是**示例开发插件**,用于演示插件项目结构、服务注册、设置页注册、桌面组件注册、`.laapp` 打包与安装流程。
|
||||
- 开发新插件时,建议直接从这个示例插件复制一份再修改。
|
||||
- 示例插件属于 `LanAirApp/` 对外开发工作区;宿主应用里的插件运行时与解析实现位于 `LanMountainDesktop/plugins/`。
|
||||
当前标准示例为 `LanMountainDesktop.SamplePlugin`。
|
||||
|
||||
## English
|
||||
|
||||
This directory stores sample plugins and reference implementations. The current standard sample is `LanMountainDesktop.SamplePlugin`.
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
# 插件标准文件
|
||||
# 插件标准说明
|
||||
|
||||
这里存放 LanMountainDesktop 插件开发所使用的标准模板与约定文件。
|
||||
## 中文
|
||||
|
||||
当前标准:
|
||||
- 安装包扩展名:`.laapp`
|
||||
- 插件清单文件名:`plugin.json`
|
||||
- 多语言资源目录:`Localization/`
|
||||
- 建议内置语言文件:`zh-CN.json`、`en-US.json`
|
||||
本目录存放插件开发需要遵循的基础约定,包括 `.laapp`、`plugin.json`、`Localization/` 以及仓库根目录 README 和安装包等要求。
|
||||
|
||||
创建新插件时,建议优先参考本目录中的模板文件。
|
||||
## English
|
||||
|
||||
This directory stores the baseline conventions for plugin development, including `.laapp`, `plugin.json`, `Localization/`, and repository-root deliverables.
|
||||
|
||||
Reference in New Issue
Block a user