46 lines
1.7 KiB
Markdown
46 lines
1.7 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.1.2`。Git 备用安装同样必须固定标签，例如：
|
|
|
|
```text
|
|
https://git.crash.work/ShrinkSDK/ShrinkEventBus.git#v2.0.0
|
|
```
|
|
|
|
也可先通过固定标签安装 Editor 引导包：
|
|
|
|
```text
|
|
https://git.crash.work/ShrinkSDK/Installer.git#v0.1.5
|
|
```
|
|
|
|
随后在 Unity 打开 `ShrinkSDK/Packages`。安装器只合并 `com.cneicy` registry，并将内置目录中的固定版本及其必要的固定 UniTask revision 写入 manifest；它不写认证信息，也不复制模板到 `Assets`。
|
|
|
|
发布、子模块迁移和独立开发宿主生成规则位于 [Tools/RepositoryMigration/Initialize-ShrinkSdkPackageRepositories.ps1](Tools/RepositoryMigration/Initialize-ShrinkSdkPackageRepositories.ps1)。架构约束与跨包验证要求见 [DESIGN.md](DESIGN.md)。
|