Toolkit 开发 - 最佳实践

下面是我们建议在编写 Toolkit 代码时遵循一些最佳实践。

挂钩

我们建议您从工作流配置(通常位于其 install/apps 文件夹)中复制一个挂钩到 config/hooks 文件夹,并更新 config/env 下的环境以引用这些新挂钩。在编辑挂钩时,如果有必要,最好能有一份可以还原的备份。

配置

我们还建议您在 Git 中管理工作流配置的 config 文件夹,并使用基于 Git 的工作流。因此,挂钩也将在 Git 中管理。这样,无论您何时配置新项目,都可以重用这份集中管理的配置副本。

例如,在 Shotgun Desktop 中,您只需将项目设置向导指向 Git 库,Toolkit 就会将该库克隆到新工作流配置的 config 文件夹中。由于 config 文件夹现在是克隆的 Git 库,意味着您还可以在集中管理的配置中执行 Push 和 Pull 操作,从而更轻松地更新或回滚工作流的配置。

应用

有时,挂钩可能不足以让 Toolkit 实现您想要的操作,这时您需要调整应用的代码。我们建议您 Fork 我们在 GitHub 上的应用。

作为 Shotgun 用户,您可以完全自由地 Fork 这些应用,并将自己的更改保存在私人库中。我们也欢迎您与我们分享更改,让整个社区都能从您的努力成果中获益,而且这样做时,您不必随着我们的更新维护应用的私人 Fork。

在向我们提交更改时,请记住,这些工具必须适用于大众用户,因此针对您工作室的特定更改需要更加通用(我们很高兴在这方面提供建议)。在应用中建议更改的最佳方法是引入一个新挂钩,既让您的工作室能够执行自定义的功能,又让现有用户能够保留默认挂钩中的原始功能。

最后,当您编写自己的应用或调整现有应用时,强烈建议使用开发描述符。它让您可以从文件系统的任意位置加载应用,并在 Shotgun 菜单中公开“Reload and Restart”菜单项,以便更快进行迭代,而无需退出 Maya 或 Nuke 重新加载代码。

关注

0 评论

登录写评论。