Unity 编辑器扩展项目 Alchemy 的安装与配置指南
1. 项目基础介绍
Alchemy 是一个为 Unity 编辑器提供丰富扩展功能的库。它通过使用属性(Attributes)来添加强大的编辑器扩展功能,并且支持任何类型(如 Dictionary、HashSet、Nullable、Tuple 等)的序列化,使其可以在编辑器中编辑。Alchemy 通过 Source Generator 动态生成所需代码,用户只需对目标类型添加属性即可,无需像使用 Odin 那样继承特定的类。
主要编程语言:C#
2. 项目使用的关键技术和框架
- 属性(Attributes): Alchemy 使用属性来扩展 Unity 编辑器的功能,这允许开发者通过简单的代码注解来定制编辑器中的行为。
- 序列化扩展: 通过自定义序列化过程,Alchemy 支持Unity编辑器无法直接序列化的数据类型,如字典和可空类型。
- Source Generator: 用于在编译时动态生成代码,减少手动编码的工作量。
- Unity 编辑器API: 利用 Unity 的编辑器API来创建自定义的编辑器窗口和扩展层次结构视图。
3. 项目安装和配置
准备工作
在开始安装之前,请确保您的开发环境满足以下要求:
- Unity 版本:2021.2 或更高版本(推荐 2022.1 或更高版本以使用序列化扩展)
- Serialization 2.0 或更高版本(如果需要使用序列化扩展)
安装步骤
-
打开 Unity 编辑器,从菜单中选择
Window > Package Manager
打开包管理器。 -
点击包管理器界面中的
+
按钮并选择Add package from git URL
。 -
在弹出的输入框中粘贴以下 Git URL 并点击添加:
https://github.com/annulusgames/Alchemy.git?path=/Alchemy/Assets/Alchemy
-
等待包下载和安装完成。
-
安装完成后,您可以在 Unity 的
Assets
文件夹中找到Alchemy
文件夹。 -
根据项目需求,在您的脚本中使用 Alchemy 提供的属性和功能。
安装完成后,您可以参照项目的文档和示例代码来学习如何使用 Alchemy 提供的各种功能。请注意,Alchemy 的功能需要通过在类和成员变量上添加相应的属性来实现编辑器的扩展和自定义。