UniTyped 项目使用教程

UniTyped 项目使用教程

UniTypedUniTyped is a source generator that allows typed access to data such as SerializedObjects, material parameters, tags and layers.项目地址:https://gitcode.com/gh_mirrors/un/UniTyped

1. 项目的目录结构及介绍

UniTyped 项目的目录结构如下：

UniTyped/
├── Assets/
├── Packages/
│   └── com.ruccho.unityped/
│       └── manualgenerator/
│           └── Editor/
│               └── Executable~/
│                   └── netcoreapp3.1/
├── ProjectSettings/
├── UniTyped Generator/
├── .gitignore
├── LICENSE
├── README.md
├── README_ja.md

目录结构介绍

• Assets/: 包含 Unity 项目的资源文件。
• Packages/: 包含项目的包文件，其中 com.ruccho.unityped 是 UniTyped 的主要包。
• ProjectSettings/: 包含 Unity 项目的设置文件。
• UniTyped Generator/: 包含 UniTyped 生成器的相关文件。
• .gitignore: Git 忽略文件。
• LICENSE: 项目的许可证文件，采用 MIT 许可证。
• README.md: 项目的英文介绍文档。
• README_ja.md: 项目的日文介绍文档。

2. 项目的启动文件介绍

UniTyped 项目的启动文件位于 Packages/com.ruccho.unityped/manualgenerator/Editor/Executable~/netcoreapp3.1/ 目录下，主要是一个可执行文件 UniTyped Generator Standalone.exe。

启动文件介绍

• UniTyped Generator Standalone.exe: 这是一个独立的可执行文件，用于从命令行生成代码。可以通过以下命令行选项运行：

  UniTyped Generator Standalone.exe --project=<CSPROJ PATH> --output=<OUTPUT SCRIPT PATH>
  

3. 项目的配置文件介绍

UniTyped 项目的配置文件主要是 UniTyped Generator Profile 资产文件，可以通过 Unity 编辑器创建。

配置文件介绍

• UniTyped Generator Profile: 这是一个资产文件，用于配置代码生成器。可以通过以下步骤创建和配置：
  1. 在 Unity 编辑器中，选择 Create > UniTyped > Manual Generator Profile。
  2. 添加生成器项，注册包含目标脚本的项目的 .csproj 路径。
  3. 注册输出 C# 脚本的路径（该路径将被覆盖）。
  4. 点击 Generate 按钮。

通过以上配置，可以生成所需的类型化访问代码。

---

以上是 UniTyped 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用 UniTyped 项目。

UniTypedUniTyped is a source generator that allows typed access to data such as SerializedObjects, material parameters, tags and layers.项目地址:https://gitcode.com/gh_mirrors/un/UniTyped