Perforce

Perforce 框架

各种应用和挂钩常用的 Perforce 功能
开发者:Shotgun Software
最新版本:v0.1.15 (Alpha)
我们的版本号遵循语义化版本标准。
系统名称:tk-framework-perforce

概述

此框架提供常见 Perforce 动作和实用程序功能,这些功能可由其他应用和挂钩用于与 Perforce 集成。它还包括游戏配置用于此集成的默认应用挂钩集。

这是一个实验框架!

请注意,此框架的最新版本为 v0.1.15,意味着其接口仍处于实验阶段。虽然我们努力尝试不影响每次更新的向后兼容性,但是版本号以零开头的版本有时仍会发生这种情况。等到框架版本达到 1.0 时,界面将不会因重大版本号变化而出现兼容问题。有关这些约定的详细信息,请参见语义化版本标准。

概述视频

下面的视频对特性和功能进行了简要的介绍。

 

文档

目前,我们正在编写此框架的文档。在此期间,如果您想从较高层面概括了解我们如何将 Perforce 集成到 Shotgun Pipeline Toolkit 之中,请参见此页面:

框架包含什么?

Perforce 框架不仅用来打包 Perforce API,还整合了 P4Python 和一组实用工具函数,可提供多种常见功能,比如通过对话框打开连接、检出最新版本等。连接的 P4Python 实例始终可用,方便更直接地访问 Perforce 命令。

P4Python

Toolkit 的 Perforce 集成使用 Perforce 提供的标准 P4Python 模块。此框架包括各种版本的 P4Python,适用于 Toolkit 支持的各种操作系统和应用程序。但是,如果框架中没有您需要的版本,它将从您的 Python 路径进行加载(如果可以的话)。

参考

(即将提供...)

 

安装和更新

更新至最新版本

如果您已在某个项目中安装了此应用,要获取最新版本,可运行 update 命令。您可以导航到该特定项目随附的 tank 命令,并在该项目中运行它:

> cd /my_tank_configs/project_xyz
> ./tank updates

或者,也可以运行您的工作室的 tank 命令并指定项目名称,指示该命令要对哪个项目运行更新检查:

> tank Project XYZ updates

协作和代码演进

如果您可以获取 Shotgun Pipeline Toolkit,意味着也可以获取我们在 GitHub 中存储和管理的所有应用、插件和框架的源代码。欢迎根据实际需要演进和完善这些内容,以它们为基础做进一步的独立开发,修改它们(以及向我们提交 Pull 请求!),或者只是随手玩一玩,简单了解它们的构建方式和 Toolkit 的工作原理。您可以通过以下网址访问此代码库:https://github.com/shotgunsoftware/tk-framework-perforce

特殊要求

  • 需要安装 Shotgun Pipeline Toolkit 核心 API 版本 v0.14.61 或更高版本才能使用此功能。
 

配置

下面是使用的所有配置设置的摘要。您需要在要启用此应用或插件的环境文件中定义这些设置。

hook_get_perforce_user

类型:hook

默认值:get_perforce_user

说明:指定一个挂钩,返回指定的 Shotgun 用户名对应的 Perforce 用户名

hook_store_publish_data

类型:hook

默认值:store_publish_data

说明:

host

类型:str

说明:连接 Perforce 时要伪装的主机计算机的名称 此配置通常留空!

server

类型:str

说明:要连接的 Perforce 服务器。格式应该为:“协议:服务器:端口”。例如“tcp:perforce:1666”

hook_get_shotgun_user

类型:hook

默认值:get_shotgun_user

说明:指定一个挂钩,返回指定的 Perforce 用户名对应的 Shotgun 用户名

hook_store_review_data

类型:hook

默认值:store_review_data

说明:

server_aliases

类型:list

说明:Perforce 服务器的别名列表 - 如果 Perforce 服务器被移动或指定了新的协议、名称或端口,将原始服务器添加到此列表将让 Toolkit 可以继续使用已发布到旧服务器的发布内容。在“server”设置中,应始终指定当前服务器。

hook_load_publish_data

类型:hook

默认值:load_publish_data

说明:

hook_load_review_data

类型:hook

默认值:load_review_data

说明:

 
关注

0 评论

登录写评论。