一键安装指令大全

提供关于一键安装涉及到的所有配置和指令的说明。

一键安装的配置涉及三个文档：
xxxSetupConfig.json：用于配置一键安装需要执行的指令，xxx一般为项目代码或名称。

SetupConfig.json文件分为5个部分：

• 变量（下图红色部分）：变量的值可以通过ui界面中的选择来修改
  
• AdminCmds（下图黄色部分）：一般在这里配置一键安装中需要管理员权限的指令
  
• UserCmds（下图绿色部分）：一般在这里配置一键安装中不需要管理员权限的指令
  
• CustomCmds（下图紫色部分）：一般在这里配置不在一键安装入口执行的指令，比如Pangu窗口右上角的ArtUpdate按钮被点击后执行的指令
  
• UserOverridableList（下图白色部分）：当变量的名字出现在此部分时，用户在界面上的选择会被保存下来，在您下一次打开一键安装界面时将会保留上一次一键安装的选择

xxxSetupUI.json：用于配置一键安装界面的UI控件，xxx一般为项目代码或名称，一般与xxxSetupConfig.json中的xxx保持一致。如果项目无修改UI控件的需求，可不配置该文件，此时会使用默认的SetupUI。

我们在二进制包体中提供了KaiTianSetupConfig.json和KaiTianSetupUI.json文件，这两份配置文件中几乎包含了最全的一键安装配置，您可以将这两份文件复制为副本，作为项目的一键安装配置文件的参考，然后按需修改内容即可。

ini配置文件：如果项目需要自己组装文件夹结构，比如从A地址拉取文件然后链接到B地址，那么可以在项目文件夹下新增ini配置文件实现。我们在KaiTian项目的文件夹下准备好了KaiTian需要的各种组装文件夹组装的ini配置文件，您可以将该文件复制为一份副本，作为项目组装的ini配置文件的参考，然后按需修改其中的模块。一般项目需要组装的文件夹复杂度远远小于KaiTian，只需要删除大部分其中的条目，以及替换仓库地址即可。

这些变量在代码中有其他用途，或者会被系统运行自动写入，请不要用他们来存项目自定义的值。

• Job： 用来匹配CodeUnifier中的配置
• Project：用来区分项目的名称
• SourceControlSoftware：SVN或者perforce，决定项目用什么来拉取资源文件
• CurUnrealEngineMajorVersion：当前ue的大版本号，如ue5值为5，ue4值为4
• CurUnrealEngineMinorVersion：当前ue的小版本好，如ue5.3为3，ue4.27为27
• CurProjectContentPath：当前ue项目运行时的Content目录（用来建立资源路径关系）
• CurProjectConfigPath：当前ue项目运行时的Config目录（用来建立某些pangu版本可能需要的PanguConfig Meta路径）
• CurProjectPath：当前项目运行的根目录

一键安装的变量特殊处理的一点是，允许变量替换，如果变量的值是一个字符串且被大括号{ }包围，则认为要被会取大括号内的字符串为变量名的变量的值与其他字符串拼接。

一键安装中使用的指令如下图所示，可由指令名(图中红色)、执行条件（图中蓝色）、执行参数（图中绿色）三个部分组成。

指令名与python中被setup_command装饰的函数的name一致，指令参数与python中被setup_command装饰的函数的参数一致。

@setup_command('change_ue_settings')
def change_ue_settings(uclass_name, setting_name, setting_value):
	...

指令在python源码中可以由Pangu方的项目接口人添加。

上图中的change_ue_settings指令，实际就会执行这个change_ue_settings()函数。指令参数的数量需要与函数变量数量对上。

指令的包装器有两个参数，第一个参数是指令名称，第二个可省参数是这条指令是否需要阻塞执行，如果不需要阻塞执行则会另开线程执行。一般情况下，需要管理员权限的指令和影响后续指令执行的指令需要blocking。

执行条件由--condition字符串开始，后面最接近的一个字符串为这条语句的执行条件，条件中也支持变量替换。不符合执行条件的指令在运行时就被过滤掉了。

json中引号用\"表示。当条件为真的时候这条语句才会实际执行。

管理员权限通过windows的CMD命令行获取，所以这个部分的指令最终会生成一个PcgInstallAdmin.bat文件来执行，所以这个部分的指令都是按配置顺序生成。 当前版本的指令可以参考各个项目中的SetupConfig.json中的使用情况。

不同的语句有不同的作用，以kaitian为例进行说明，选取项目常用语句进行说明，具体各个项目的配置请自行取舍修改。

这部分指令无需管理员权限，可以在后台执行，也是按顺序执行。 以kaitian为例进行说明，选取项目常用语句进行说明，具体各个项目的配置请自行取舍修改。

这个部分的指令迭代较快，当前版本的指令可以参考各个项目中的SetupConfig.json中的使用情况。

get_kaitian_files和clone_from_codeunifier_by_symbol_list的区别只是用什么symbol来拉取资源文件，这个词会出现在下面的介绍中。

@setup_command('get_kaitian_files')
def clone_from_codeunifier(version_branch='trunk', symbol='all'):
	...

@setup_command('clone_from_codeunifier_by_symbol_list')
def clone_from_codeunifier_by_symbol_list(version_branch='trunk', symbol_list_str='[]'):
	...

可以调用Plugins\Pangu\Content\Python\PanguSetup\ClientSrc\PanguSetupMgr.py中的run_custom_cmds_by_part函数开始运行指令。

请注意：下面例子中两个按钮的名称和位置可能随版本而修改，具体请参考对应版本的文档或者咨询Pangu开发者。

在现在的Pangu中ArtDataHouToolsUpdate的模块决定了ArtUpdate按钮执行什么逻辑。 同理在现在的Pangu中AllUpdate的模块决定了OneForAllUpdate按钮执行什么逻辑。 图中只展示了部分的语句，详细请阅读一键安装配置中对于配置一键热更的部分。

所有的指令都在Plugins\Pangu\Content\Python\Plugins\PanguSetup\ClientSrc\SetupCommand\Actions文件下的py文件中。

所在目录：Plugins\Pangu\Content\Python\Plugins\PanguSetup\ClientConfig\UIConfig\

命名：项目名称+SetupUI.json

有了这个文件后，Pangu的一键安装界面上的Project选到这个项目名称的时候就会使用这个ui配置文件中的界面控件和指令。在进行完修改配置文件后可以看到一键安装的界面修改。

这部分指令无需管理员权限，可以在后台执行，也是按顺序执行。 以kaitian为例进行说明，选取项目常用语句进行说明，具体各个项目的配置请自行取舍修改。

所在目录：Plugins\Pangu\Content\Python\Plugins\CodeUnifier\config\项目名称

命名：任意名称.ini

有了这个文件后，Pangu的一键安装界面上的Project选到这个项目名称并且满足对应的过滤条件的时候就会使用这个ini文件中的配置来拉取组装用户本地文件。