Files
Workspace/README.md
T
cneicy 2a513cbd5b
Validate ShrinkSDK Workspace / unity (push) Successful in 3m7s
feat(workspace): adopt context-first package management
2026-08-26 12:49:24 +08:00

46 lines
1.8 KiB
Markdown

# ShrinkSDK Workspace
ShrinkSDK 的 Workspace 用于跨包集成、场景验证、生成器验证和 SDK 文档。每个 `Assets/Modules/<Module>` 是独立公开仓库的 Git submodule;根仓库保留相邻 `.meta`,因此不要删除或重新生成这些文件。
## 获取 Workspace
```text
git clone --recurse-submodules https://git.crash.work/ShrinkSDK/Workspace.git
cd Workspace
git submodule update --init --recursive
```
所有模块都可以独立打开其 `Development~/UnityProject`。根 Workspace 仅用于跨包组合与验收。
## 安装 SDK
首选公开 Gitea NPM/UPM registry,在消费者项目的 `Packages/manifest.json` 中保留既有配置并加入:
```json
{
"scopedRegistries": [
{
"name": "ShrinkSDK",
"url": "https://git.crash.work/api/packages/ShrinkSDK/npm/",
"scopes": ["com.cneicy"]
}
]
}
```
然后按精确版本添加包,例如 `com.cneicy.shrink-app-starter-basic: 0.2.0`。Git 备用安装同样必须固定标签,例如:
```text
https://git.crash.work/ShrinkSDK/ShrinkEventBus.git#v2.0.0
```
也可先通过固定标签安装 Editor 引导包:
```text
https://git.crash.work/ShrinkSDK/Installer.git#v0.2.0
```
随后在 Unity 打开 `ShrinkSDK/包管理`。UI Toolkit 窗口会显示直接与间接依赖的真实安装状态,并按 Context 组合基础、应用宿主、独立功能和模块集成组织固定版本包与推荐组合。安装器只合并 `com.cneicy` registry 和依赖数据,不写认证信息,也不复制模板到 `Assets`
发布、子模块迁移和独立开发宿主生成规则位于 [Tools/RepositoryMigration/Initialize-ShrinkSdkPackageRepositories.ps1](Tools/RepositoryMigration/Initialize-ShrinkSdkPackageRepositories.ps1)。架构约束与跨包验证要求见 [DESIGN.md](DESIGN.md)。