User Settings

The User Settings file contains all V1 Helix Toolset settings that need to be saved per user. The file is organized into settings groups, with individual settings relating to each group within. Any setting in Tools Config can be manually added to this file in order to override that setting for the user.

The file user_settings.json is located within the V1 folder in the users windows Documents folder. This is also the location where all toolset temporary files gets saved as well as DCC program log files from the toolset.

Bake Settings

All settings for how to handle Maya bake keys commands that are initiated by the user. The user can set these via the Helix Rigger UI Baking Settings.

current_frame - Bake only the current frame and the next. Note: Baking requires 2 frames.
end_frame - The last frame of the bake range if frame_range is being used.
frame_range - Bake the frame range defined by start_frame and end_frame.
key_range - Gather the bake range from the keyframes currently on the bake objects, using the first and last keyframe applied to the objects as the bake range.
sample_by - How often to place baked keyframes when baking.
smart_bake - Whether or not to use the Maya smart bake feature.
start_frame - The first frame of the bake range if frame_range is being used.
time_range - Bake the frame range currently framed by the Maya time slider.

Character Settings

All settings for how rigging will apply and be removed by the Helix Rigger Regions section. These settings will save into rig .json files so Rig Components loaded via load rigging will apply the same as they were initially created. The user can set these via the Helix Rigger UI Character Settings and Remove Component Settings.

bake_component - see Remove Component Settings Bake Component.
force_remove - see Remove Component Settings Force Remove.
overdriver_remove_parent - see Character Settings Overdrivers - No Parent Space.
remove_existing - see Character Settings Remove Existing.
revert_animation - see Remove Component Settings Revert Animaton.
world_orient_ik - see Character Settings IKs - World Oriented.

ExporterSettings

User settings for the Exporter UI

asset_sort - Saves how the user has set the asset list to sort.
definition_sort - Saves how the user as set the definition list to sort.

Optimization Settings

Settings to optimize performance of the Rigger UI. The user can set these via the Helix Rigger UI Optimization Settings

ui_manual_update - See Optimization Settings Manual Loading.

Perforce

User specific setting for Perforce source control

ClientHostName - Name of the client host for the user's Perforce connection.
UserName - Perforce UserName for the user.
WorkspaceName - User Workspace to apply checkout/in commands to.

Project

User overrides from Tools Config incase project paths are not managed by tools.

Same as the Project section of Tools Config

Rig_Materials

Definition of user defined color sets from the Color Sets Editor that define which colors/materials should be applied to rig controls.

user_color_set - Whether or not the tools should apply user color sets or use the default rig control colors.
set_name - Name of the color set.
- side_name - Name of the side to override default coloring for.
  - color - Color values for the material.
    - r : 0-1 value for Red channel.
    - g : 0-1 value for Green channel.
    - b : 0-1 value for Blue channel.
  - name - Name of the shader. (Auto populated and should not be modified)
  - translucence - Translucence value for the material, 0-1.
  - transparency - Transparency value for the material.
    - r : 0-1 value for Red channel.
    - g : 0-1 value for Green channel.
    - b : 0-1 value for Blue channel.
...Repeated for every user color set.

ToolVisibilitySettings

Stores whether or not to display each individual tools button in the Rigger UI Toolbar Buttons.

See Toolbar Buttons for list. Entries here will be the button name + ".isVisible"

Example User Settings File

{

"BakeSettings": {

"current_frame": false,

"end_frame": 10,

"frame_range": false,

"key_range": false,

"sample_by": 1,

"smart_bake": false,

"start_frame": 0,

"time_range": true

},

"CharacterSettings": {

"bake_component": false,

"force_remove": false,

"overdriver_remove_parent_space": true,

"remove_existing": true,

"revert_animation": false,

"world_orient_ik": true

},

"ExporterSettings": {

"asset_sort": "Index",

"definition_sort": "Index"

},

"OptimizationSettings": {

"ui_manual_update": false

},

"Perforce": {

"ClientHostName": "Kaimelar-PC",

"UserName": "micahz",

"WorkspaceName": "micahz"

},

"Project": {

"ContentRootPath": "ProjectNova/Data",

"ProjectDrive": "D:/",

"ProjectRootPath": "V1/Prototype"

},

"Rig_Materials": {

"default": {

"CENTER": {

"color": [

0.0,

0.0

],

"name": "rig_control__center_SG",

"translucence": 1,

"transparency": [

0.7019608020782471,

0.7019608020782471

]

}

},

"my_color_set": {

"CENTER": {

"color": [

0.0,

0.0

],

"name": "rig_control___new_side_SG",

"translucence": 1,

"transparency": [

0.7019608020782471,

0.7019608020782471

]

}

},

"ToolVisibilitySettings": {

"Bake and Remove Component.isVisible": true,

"Build Pickwalking.isVisible": true,

"Characterize Skeleton.isVisible": true,

"Dynamics - AIM.isVisible": false,

"FK/IK Switch.isVisible": true,

"Lock All.isVisible": false,

"Overdrive - One Driver.isVisible": true,

"Overdrive - One Target.isVisible": true,

"Overdrive - Rotate.isVisible": false,

"Overdrive - Translate.isVisible": false,

"Overdrive - World.isVisible": false,

"Pin Rig Control.isVisible": false,

"Remove Component.isVisible": true,

"Remove Overdrivers.isVisible": true,

"Rig Mirror.isVisible": true,

"Rig Switcher.isVisible": true,

"Space Switcher.isVisible": true,

"Switcher.isVisible": true,

"Temporary FK.isVisible": true,

"Temporary IK.isVisible": true,

"Toggle Lock Selected Controls.isVisible": true,

"Toggle Proximity Visibility.isVisible": false,

"Toggle Visibility.isVisible": true,

"Un-Pin Rig Control.isVisible": false,

"Unlock All.isVisible": false,

"Zero Component.isVisible": true

}