将版本控制功能与 VPM 一起使用
我们非常喜欢版本控制工具,用于保存您的工作和协作内容。我们使用 Git 来管理我们自己的包,甚至 VRChat 客户端也是如此。VPM 被设计为与版本控制系统友好相处,以下是具体的工作方式。如果您使用其他系统,如 Plastic,您可以通过 反馈 向我们发送分享的提示。
包含和排除的内容
我们通常使用 这个 Unity .gitignore 来开始我们的项目,它会忽略大多数生成的文件等。
VRChat SDK 从技术上讲只允许由 VRChat 分发,不应该提交到版本控制系统。我们基于这个想法来管理所有与版本控制系统一起使用的 VPM 兼容包。有了这个想法,以下是应该包含或不包含的内容:
包含:
Assets
文件夹- Unity 所需,包含您的所有项目特定资产
ProjectSettings
文件夹- Unity 所需,包含您的所有项目设置,如物理和标签。
Packages
文件夹- Unity 所需,包含您的项目清单(Unity 包依赖项)以及 解析器 和 VPM 清单。
Packages\com.vrchat.core.vpm-resolver
文件夹- 这个工具可以在没有 VCC 的情况下将 VPM 包恢复到您的项目中。 0
排除:
- 所有 VPM 包(在
Packages/
中),除了解析器 - 临时文件/缓存文件夹,如
Library
,Temp
等。
如果您的项目的 Packages
文件夹中没有 .gitignore
文件,VPM 将会自动为您添加一个,并排除所有以 com.vrchat.*
开头的文件夹,同时通过特别包含 com.vrchat.core.*
来添加对解析器的排除。
在新克隆的项目中会发生什么
当有人从版本控制系统获取您的项目时,如果创建者遵循了上述指南,项目将缺少一些必需的包。此时最好的做法就是简单地在 Unity 中打开项目,并在恢复缺失包的对话框中按 "OK" - 参见 解析器。