Console Variables

FaceFX Console variables control many user-modifiable properties in FaceFX Studio.  They are get and set using the get and set FaceFX commands.  They can also be get and set from python.

Global and Miscelaneous Console Variables

Variable	Default	Description
g_appdirectory	-	The application directory where FaceFX is installed.
g_userdirectory	-	A writable folder where FaceFX stores user-specific information.
g_sdkversion	-	The current SDK version.
g_licenseename	-	The person or entity that this version of FaceFX Studio was built for.
g_licenseeprojectname	-	The project name that this version of FaceFX Studio was built for.
g_licenseeversion	-	A version number for source code licensees that change the file format.
g_playbackspeed	"1.0"	The speed to playback animations in FaceFX Studio
g_audiosystem	"directx"	The audio system to use.  Should be "openal" or "directx"
g_defaultanalysisactor	"default"	The analysis actor to select by default during analysis.
g_unattended	"0"	When true, this suppresses dialog messages and warnings so that scripts can run uninterrupted.
g_clientspecroot	-	Audio file paths are made relative with respect to this variable.  Absolute paths are also stored for reference when the relative path can't be found.
g_maxaudioduration	"600"	The maximum duration in seconds of an audio file that can be loaded in FaceFX Studio.
g_autoaddmorphtargetnodes	"1"	When true, any morph target nodes found in ogre content that are not found in the face graph will be added to the face graph.  Set to false if you don't want the extra nodes automatically added to the graph.
fg_enableunrealnodes	"0"	When true, the application can insert Unreal-specific nodes.  (Keep in mind Unreal names may not have spaces.  They are replaced with underscores)
pl_realtimeupdate	"0"	When true, curves are updated in real time when the phoneme bar is tweaked.
a_audiomin	".5"	The minimum amount of audio that FaceFX Studio will accept for analysis.  Lower this at your own risk as the analysis libraries are not tested below this threshold.
a_audiomax	"90"	The maximum amount of audio that FaceFX Studio will accept for analysis.  Larger files are analyzed without text and chunked into smaller pieces.  Increase this at your own risk as the analysis libraries are not tested above this threshold.
a_detectspeech	"auto"	Set to "false" to turn off speech detection.  In earlier versions os FaceFX Studio, leaving this on could sometimes create an incorrect leading silence, but leaving it off would not correctly recognize digital silence.  The leading silence issue has been resolved, so it is recommended to leave this on.
py_scriptpath	-	The path to the currently executing Python script, if any.  If script is executing from the Python Shell this will be set to PYTHON_SHELL otherwise it is set to the full path of the currently executing .py script. Don't set this manually.
ogre_rendersystem	"direct3d"	Sets the ogre render system.  Should be "direct3d" or "opengl".  Must be set when application loads from the command prompt.
ogre_default_fov	"45"	Sets the default field of view for cameras.

Publishing Console Variables

Publishing an actor removes data that is not required for in-game use to save memory and speed up playback.  See Publishing Content for more info.

Variable	Default	Description
po_bake_events_to_curves	"1"	Controls if events are removed from the animation and replaced with equivalent curves.
po_collapse_face_graph	"0"	When true, the face graph is collapsed so that only target nodes remain.  Animations are baked down to curves for these targets.
po_remove_anim_editor_only_data	"1"	When true, removes animation data like the analysis actor, absolute audio path.
po_remove_mapping	"1"	When true, removes the mapping from published actors.
po_remove_phon_word_lists	"1"	When true, removes the phoneme word list from published actors.
po_remove_event_templates	"1"	When true, removes the event template from published actors.
po_excluded_anim_groups	""	An array of animation group names (separate with pipe character "|") to exclude from the published actor.
po_target_platform	"pc"	The target platform to publish to.  Should be "pc", "xbox 360", "little endian", or "big endian"
po_destination_dir	""	The directory to write the published files.

 

Progress Console Variables

Python scripts can display progress dialogs and control their display with the below console variables.  See python functions for more info.

Variable	Default	Description
pp_overall_progress	"0"	A number from 0 to 1 representing the overall progress.
pp_task_name	"unnamed"	The name of the task.
pp_task_progress	"0"	A number from 0 to 1 representing the task progress.
pp_subtask_name	"unnamed"	The name of the subtask
pp_subtask_progress	"0"	A number from 0 to 1 representing the subtask progress.