Embedded Files
The Tools Config file contains all project level settings for the V1 Helix Toolset. The file is organized into settings groups, with individual settings relating to each group within. All settings can be overridden per user by including the same group and setting in the local User Settings file.
It is a standard .json file that should be located at the top level of the V1 Helix codebase, which will be the directory set in the V1TOOLSROOT environment variable, and named "tools_config.json".
Developer
Developer
Defines development code bin file path that differ from the standard users.
DevToolsPath - The path to the development code bin folder containing project .DLL files.
DeveloperMode - Whether or not to use the Development path instead of the standard user path for DLLs.
ProjectDrive - Which computer drive the development code is on.
Exporter
Exporter
Defines where exported animation .FBX files will be saved and what they will be named.
ExportPattern - Pattern to follow from the Maya animation file to determine where to save exported animation .FBX files.
.../FolderName - Navigate up directories until 'FolderName' is found.
../ - Navigate up 1 directory.
/FolderName/OtherFolderName - Navigate down directories following the given folder names.
ExportNamespace - Namespace to apply to exported skeletons. Using an empty string "" will not apply a namespace.
FileNamePattern - Pattern to use to name animation files.
<Asset> - Insert the name of the export asset from the Exporter UI
<Definition> - Insert the name of the exporter group from the Exporter UI
MatchDirectory - When true, will record the folder structure that is navigated up from the Maya animation file, and re-apply all directories to the to the export folder directory.
Perforce
Perforce
Perfoce source control settings.
Enabled - Whether or not to use Perforce source control checks.
Host - Host ID for the Perforce server
Server - Server ID for the Perforce server
<Host> - will insert the Host ID into the Server ID.
Project
Project
Definition of all directory paths relevant to the toolset when working on a larger project.
CharacterFolder - Name of the folder that character assets are located under. Used to limit directory searches when finding all character files.
In the provided example file below, the full path to the Character Folder would be "D:/V1/Prototype/ProjectNova/Data/Characters"
ContentRootPath - Path to the source content directory from the ProjectDrive + ProjectRootPath
In the provided example file below, the full ContentRootPath would be "D:/V1/Prototype/ProjectNova/Data"
EngineContentPath - Path to the engine data files created from the source content files.
In the provided example file below, the full EngineContentPath would be "D:/V1/Prototype/ProjectNova/Nova/Content"
ProjectRootPath - Path to the top level project folder from ProjectDrive.
In the provided example file below, the full ProjectRootPath would be "D:/V1/Prototype"
ProjectDrive - The System Drive that the project is located on.
RigSearchPathList - List of folder names to limit directory searches when finding rig files.
PropSearchPathList - List of directories from ContentRootPath to limit searches for prop .fbx files.
PropFolderList - List of folder names to limit directory searches when finding prop files within the PropSearchPathList folders.
UseProject - Whether or not the tools should use Project settings. For individual users that would just like to rig their own characters, this should be 'false'.
RigFolder - The name of the folder that rigging files can be found in. This includes the settings and rigging .json files as well as a base rig Maya file.
RigFilePattern - File name convention for character rig Maya files.
JointNamePattern - Whether joint name side strings tags are before or after the joint names.
*<side> - The side string comes after the joint name, ex. upper_arm_l.
<side>* - The side string comes before the joint name, ex. l_upper_arm.
Tools
Tools
General settings for the V1 Helix tools.
RemovePycFiles - Whether or not to remove all .pyc files within the V1TOOLSROOT environment variable directory when Maya launches. Set to true will force all python code to re-build with each Maya launch, this is very fast and ensures that each Maya launch starts with a fresh load of the tools code.
BinFolder - Folder path from the location in the V1TOOLSROOT environment variable to find the .DLL files for the toolset.
Example Tools Config File
Example Tools Config File
{
"Developer": {
"DevToolsPath": "Helix/bin/x64/Debug",
"DeveloperMode": false,
"ProjectDrive": "D:/"
},
"Exporter": {
"ExportPattern": ".../Working/../",
"ExportNamespace": "export",
"FileNamePattern": "<Asset>_<Definition>",
"MatchDirectory": true
},
"Perforce": {
"Enabled": true,
"Host": "xx.xx.xx.xxx",
"Server": "xxx:<Host>:xxx"
},
"Project": {
"CharacterFolder": "Characters",
"ContentRootPath": "ProjectNova/Data",
"EngineContentPath": "ProjectNova/Nova/Content",
"ProjectRootPath": "V1/Prototype",
"ProjectDrive": "D:/",
"RigSearchPathList": [
"Weapons",
"Vehicles",
"Characters"
],
"PropSearchPathList": [
"Weapons/Unit_Weapons",
"Characters"
],
"PropFolderList": [
"Weapons",
"Prop"
],
"UseProject": true
},
"Rigging": {
"RigFolder": "Rigging",
"RigFilePattern": "*_rig.ma",
"JointNamePattern": "*<side>"
},
"Tools": {
"RemovePycFiles": true,
"BinFolder": "bin"
}
}
Page updated
Google Sites
Report abuse