Zinnia.Unity 项目使用教程
1. 项目的目录结构及介绍
Zinnia.Unity 项目的目录结构如下:
Zinnia.Unity/
├── Assets/
│ ├── Zinnia.Unity/
│ │ ├── Behaviours/
│ │ ├── Collections/
│ │ ├── DataTypes/
│ │ ├── Events/
│ │ ├── Extensions/
│ │ ├── Patterns/
│ │ ├── Utilities/
│ │ └── Zinnia.Unity.asmdef
├── Packages/
│ └── manifest.json
├── ProjectSettings/
│ └── ProjectVersion.txt
└── README.md
目录介绍:
-
Assets/Zinnia.Unity/: 包含项目的主要代码和资源文件。
- Behaviours/: 包含各种行为脚本。
- Collections/: 包含集合相关的脚本。
- DataTypes/: 包含数据类型相关的脚本。
- Events/: 包含事件相关的脚本。
- Extensions/: 包含扩展方法的脚本。
- Patterns/: 包含设计模式的脚本。
- Utilities/: 包含工具类脚本。
- Zinnia.Unity.asmdef: 项目的程序集定义文件。
-
Packages/manifest.json: 项目的包管理文件,用于管理依赖包。
-
ProjectSettings/ProjectVersion.txt: 项目版本信息文件。
-
README.md: 项目的说明文档。
2. 项目的启动文件介绍
Zinnia.Unity 项目的启动文件主要是 Zinnia.Unity.asmdef
,这是一个程序集定义文件,用于定义项目的程序集。
Zinnia.Unity.asmdef 文件介绍:
{
"name": "Zinnia.Unity",
"references": [],
"includePlatforms": [],
"excludePlatforms": [],
"allowUnsafeCode": false,
"overrideReferences": false,
"precompiledReferences": [],
"autoReferenced": true,
"defineConstraints": [],
"versionDefines": [],
"noEngineReferences": false
}
- name: 程序集的名称。
- references: 引用的其他程序集。
- includePlatforms: 包含的平台。
- excludePlatforms: 排除的平台。
- allowUnsafeCode: 是否允许不安全的代码。
- overrideReferences: 是否覆盖引用。
- precompiledReferences: 预编译的引用。
- autoReferenced: 是否自动引用。
- defineConstraints: 定义约束。
- versionDefines: 版本定义。
- noEngineReferences: 是否不引用引擎。
3. 项目的配置文件介绍
Zinnia.Unity 项目的主要配置文件是 Packages/manifest.json
,这个文件用于管理项目的依赖包。
manifest.json 文件介绍:
{
"scopedRegistries": [
{
"name": "npmjs",
"url": "https://registry.npmjs.org/",
"scopes": [
"io.extendreality"
]
}
],
"dependencies": {
"io.extendreality.zinnia.unity": "X.Y.Z"
}
}
-
scopedRegistries: 定义了包的注册表。
- name: 注册表的名称。
- url: 注册表的URL。
- scopes: 注册表的作用域。
-
dependencies: 定义了项目的依赖包。
- io.extendreality.zinnia.unity: 依赖包的名称和版本。
通过配置 manifest.json
文件,可以确保项目正确地引用所需的依赖包。