Retargeting

Retargeting: Move animation libraries between skeletons. Unreal Engine 5 command reference with parameters and examples.

32 commands. Each shows its parameters and an example, and has a copyable deep link, so you (or an AI agent) can jump straight to one.

create_ik_rig

Create an IK Rig for a skeletal mesh, auto-characterized for retargeting

Creates the IK Rig asset and sets its skeletal mesh. By default it runs Epic's auto-characterizer, which detects the retarget root (pelvis) and the standard chains (Spine, Head, LeftArm, RightLeg...) from the skeleton, the same as the "Auto Create Retarget Chains" button. Add --auto-fbik to also get a Full Body IK solver with hand and foot goals. Read the result with get_ik_rig, check it with validate_ik_rig.

Parameter	Type	Required	Description
asset_path	string	Yes	Asset path for the new IK Rig
skeletal_mesh	string	Yes	Skeletal mesh the rig is built for
auto_characterize	bool	No	Detect the retarget root and standard chains
auto_fbik	bool	No	Also add an auto-configured Full Body IK solver
save	bool	No	Save the asset

example

  cfa create_ik_rig --asset-path /Game/Rigs/IK_Manny --skeletal-mesh /Game/Characters/Mannequins/Meshes/SKM_Manny_Simple
  cfa create_ik_rig --asset-path /Game/Rigs/IK_UE4 --skeletal-mesh /Engine/Tutorial/SubEditors/TutorialAssets/Character/TutorialTPP --auto-fbik

get_ik_rig

Read an IK Rig: mesh, retarget root, chains, goals and solvers

Parameter	Type	Required	Description
asset_path	string	Yes	IK Rig asset path
filter	string	No	Substring filter on chain and goal names
max_results	int	No	Max chains and goals (0 = all)
solver_settings	bool	No	Include every solver's full settings struct

list_ik_solver_types

List the IK solver types this engine offers

Parameter	Type	Required	Description
filter	string	No	Substring filter on the type name

add_ik_solver

Add a solver (FullBodyIK, Limb, Pole, SetTransform, BodyMover...) to an IK Rig

Parameter	Type	Required	Description
asset_path	string	Yes	IK Rig asset path
solver_type	string	Yes	Name from list_ik_solver_types or its /Script path
start_bone	string	No	Root (start) bone
end_bone	string	No	End bone (Limb, Pole)

example

  cfa add_ik_solver --asset-path /Game/Rigs/IK_Manny --solver-type FullBodyIK --start-bone pelvis
  cfa add_ik_solver --asset-path /Game/Rigs/IK_Manny --solver-type Limb --start-bone thigh_l --end-bone foot_l

remove_ik_solver

Remove a solver from an IK Rig

Parameter	Type	Required	Description
asset_path	string	Yes	IK Rig asset path
solver_index	int	Yes	Solver index from get_ik_rig

set_ik_solver

Change a solver: enabled, start/end bone, stack position, settings fields

--settings takes a JSON object of fields from the solver's settings struct (see get_ik_rig --solver-settings for the names and current values), e.g. {"Iterations": 30, "RootBehavior": "Free"}. Unknown fields error.

Parameter	Type	Required	Description
asset_path	string	Yes	IK Rig asset path
solver_index	int	Yes	Solver index
enabled	string	No	true or false
start_bone	string	No	Root (start) bone
end_bone	string	No	End bone
move_to	int	No	Move to this stack index
settings	json	No	JSON object of settings fields to change

example

  cfa set_ik_solver --asset-path /Game/Rigs/IK_Manny --solver-index 0 --settings '{"Iterations":30}'

add_ik_goal

Add an IK goal on a bone, optionally connected to a solver

Parameter	Type	Required	Description
asset_path	string	Yes	IK Rig asset path
goal_name	string	Yes	Goal name, e.g. hand_r_Goal
bone_name	string	Yes	Bone the goal drives
solver_index	int	No	Solver to connect the goal to; an unknown or refusing solver fails the call and no goal is added

remove_ik_goal

Remove an IK goal

Parameter	Type	Required	Description
asset_path	string	Yes	IK Rig asset path
goal_name	string	Yes	Goal name

set_ik_goal

Rename, re-bone, connect/disconnect a goal, or set its properties and per-solver settings

Parameter	Type	Required	Description
asset_path	string	Yes	IK Rig asset path
goal_name	string	Yes	Goal name
new_name	string	No	Rename the goal
bone_name	string	No	Move the goal to another bone
connect_solver	int	No	Connect to this solver index
disconnect_solver	int	No	Disconnect from this solver index
solver_index	int	No	Solver whose per-goal settings --settings changes
settings	json	No	JSON object of per-solver goal settings
properties	json	No	JSON object of goal properties (PositionAlpha, RotationAlpha, bExposePosition...)

example

  cfa set_ik_goal --asset-path /Game/Rigs/IK_Manny --goal-name hand_r_Goal --connect-solver 0
  cfa set_ik_goal --asset-path /Game/Rigs/IK_Manny --goal-name hand_r_Goal --solver-index 0 --settings '{"PullChainAlpha":0.5}'

set_ik_bone

Exclude a bone from solving, or set/remove its per-solver bone settings

Parameter	Type	Required	Description
asset_path	string	Yes	IK Rig asset path
bone_name	string	Yes	Bone name
excluded	string	No	true or false
solver_index	int	No	Solver for per-bone settings
settings	json	No	JSON object of per-solver bone settings
remove_settings	bool	No	Remove the bone's settings for --solver-index

example

  cfa set_ik_bone --asset-path /Game/Rigs/IK_Manny --bone-name spine_02 --solver-index 0 --settings '{"RotationStiffness":0.8}'

add_retarget_chain

Add a retarget chain (start bone to end bone) to an IK Rig

Parameter	Type	Required	Description
asset_path	string	Yes	IK Rig asset path
chain_name	string	Yes	Chain name (same name on both rigs maps automatically)
start_bone	string	Yes	First bone (closest to root)
end_bone	string	Yes	Last bone
goal_name	string	No	IK goal at the chain end

example

  cfa add_retarget_chain --asset-path /Game/Rigs/IK_Manny --chain-name Tail --start-bone tail_01 --end-bone tail_04

remove_retarget_chain

Remove a retarget chain

Parameter	Type	Required	Description
asset_path	string	Yes	IK Rig asset path
chain_name	string	Yes	Chain name

set_retarget_chain

Rename a chain or change its start bone, end bone or goal

Parameter	Type	Required	Description
asset_path	string	Yes	IK Rig asset path
chain_name	string	Yes	Chain name
new_name	string	No	Rename
start_bone	string	No	New start bone
end_bone	string	No	New end bone
goal_name	string	No	New goal ('None' clears)

set_retarget_root

Set the retarget root (pelvis) and, on UE 5.8, the root motion bone

Parameter	Type	Required	Description
asset_path	string	Yes	IK Rig asset path
bone_name	string	No	Pelvis bone
root_motion_bone	string	No	Root motion bone (UE 5.8 only)

validate_ik_rig

Verdict on an IK Rig: mesh, retarget root, chains, goals, solver wiring

Parameter	Type	Required	Description
asset_path	string	Yes	IK Rig asset path

create_retargeter

Create an IK Retargeter between two IK Rigs, set up like Epic's Retarget Animations dialog

Wires the source and target rigs (their meshes become the preview meshes) and runs the same automatic setup as Epic's "Retarget Animations" dialog: default op stack, EXACT chain mapping (fuzzy maps toes to fingers), target retarget pose auto-aligned to the source with the feet kept flat, the IK pass disabled, root motion generated from the pelvis when the source has no root bone, and IK helper bones pinned to the bones they sit on. Every piece can then be changed by hand (set_chain_mapping, set_retarget_pose, set_retarget_op...). Check with validate_retarget, then run batch_retarget.

Parameter	Type	Required	Description
asset_path	string	Yes	Asset path for the new IK Retargeter
source_rig	string	Yes	Source IK Rig (animations come FROM)
target_rig	string	Yes	Target IK Rig (animations go TO)
auto_setup	bool	No	Run Epic's automatic retarget setup
auto_map	string	No	Without auto setup: fuzzy, exact or none
default_ops	bool	No	Without auto setup: add the default op stack
save	bool	No	Save the asset

example

  cfa create_retargeter --asset-path /Game/Rigs/RTG_UE4_to_Manny --source-rig /Game/Rigs/IK_UE4 --target-rig /Game/Rigs/IK_Manny

auto_setup_retargeter

Re-run Epic's automatic retarget setup on an existing retargeter

Rebuilds the op stack, exact-maps the chains, resets and auto-aligns the target retarget pose (feet kept flat), disables the IK pass, configures root motion and pins IK helper bones. Use after set_retargeter changed a rig or mesh, or to throw away manual edits.

Parameter	Type	Required	Description
asset_path	string	Yes	IK Retargeter asset path

get_retargeter

Read an IK Retargeter: rigs, meshes, op stack, chain mapping, retarget poses

Parameter	Type	Required	Description
asset_path	string	Yes	IK Retargeter asset path
filter	string	No	Substring filter on chain names
max_results	int	No	Max chain mappings (0 = all)

set_retargeter

Set the source/target IK Rig or preview mesh

Parameter	Type	Required	Description
asset_path	string	Yes	IK Retargeter asset path
source_rig	string	No	Source IK Rig
target_rig	string	No	Target IK Rig
source_mesh	string	No	Source preview mesh
target_mesh	string	No	Target preview mesh

list_retarget_op_types

List the retarget op types this engine offers

Parameter	Type	Required	Description
filter	string	No	Substring filter on the type name

add_retarget_op

Add an op (PinBone, StrideWarping, CurveRemap, ScaleSource...) to the op stack

Parameter	Type	Required	Description
asset_path	string	Yes	IK Retargeter asset path
op_type	string	Yes	Name from list_retarget_op_types or its /Script path
name	string	No	Display name for the op
parent_op	string	No	Parent op name (child ops live under Run IK Rig)
run_setup	bool	No	Run the op's initial setup

example

  cfa add_retarget_op --asset-path /Game/Rigs/RTG_UE4_to_Manny --op-type PinBone --name "Pin Weapon"
  cfa add_retarget_op --asset-path /Game/Rigs/RTG_UE4_to_Manny --op-type StrideWarping --parent-op "Run IK Rig"

remove_retarget_op

Remove one op or every op

Parameter	Type	Required	Description
asset_path	string	Yes	IK Retargeter asset path
op_index	int	No	Op index
op_name	string	No	Op name
all	bool	No	Remove every op

set_retarget_op

Change an op: enabled, name, stack position, settings fields

--settings takes a JSON object of fields from the op's settings struct (see get_retarget_op for names and values). Nested arrays such as FK Chains' ChainsToRetarget take a whole-array value.

Parameter	Type	Required	Description
asset_path	string	Yes	IK Retargeter asset path
op_index	int	No	Op index
op_name	string	No	Op name
enabled	string	No	true or false
new_name	string	No	Rename the op
move_to	int	No	Move to this stack index
settings	json	No	JSON object of settings fields to change

example

  cfa set_retarget_op --asset-path /Game/Rigs/RTG_UE4_to_Manny --op-name "Pelvis Motion" --settings '{"BlendToSource":0.5}'

get_retarget_op

Read one op's settings (field names and values)

Parameter	Type	Required	Description
asset_path	string	Yes	IK Retargeter asset path
op_index	int	No	Op index
op_name	string	No	Op name
filter	string	No	Substring filter on field names

auto_map_chains

Map target chains to source chains by name (fuzzy, exact or clear)

Parameter	Type	Required	Description
asset_path	string	Yes	IK Retargeter asset path
mode	string	No	fuzzy, exact or clear
force	bool	No	Remap chains that are already mapped
op_name	string	No	Only this op's chain map

set_chain_mapping

Map a target chain to a source chain, or many at once

Parameter	Type	Required	Description
asset_path	string	Yes	IK Retargeter asset path
target_chain	string	No	Target chain
source_chain	string	No	Source chain ('None' unmaps)
mappings	json	No	JSON object {"TargetChain": "SourceChain"}
op_name	string	No	Only this op's chain map

example

  cfa set_chain_mapping --asset-path /Game/Rigs/RTG --target-chain LeftArm --source-chain LeftArm
  cfa set_chain_mapping --asset-path /Game/Rigs/RTG --mappings '{"Head":"Neck","Tail":"None"}'

create_retarget_pose

Create a named retarget pose on the source or target skeleton

Parameter	Type	Required	Description
asset_path	string	Yes	IK Retargeter asset path
pose_name	string	Yes	Pose name
skeleton	string	No	source or target
set_current	bool	No	Make it current

set_retarget_pose

Select a retarget pose and edit bone rotation offsets, pelvis offset, or reset bones

Parameter	Type	Required	Description
asset_path	string	Yes	IK Retargeter asset path
skeleton	string	No	source or target
pose_name	string	No	Pose to edit and make current
bone_rotations	json	No	JSON object {bone: [pitch, yaw, roll]} in degrees
root_offset	json	No	Pelvis translation offset [x, y, z]
reset_bones	stringlist	No	Bones to reset, or 'all'

example

  cfa set_retarget_pose --asset-path /Game/Rigs/RTG --skeleton target --bone-rotations '{"upperarm_l":[0,0,-45],"upperarm_r":[0,0,45]}'
  cfa set_retarget_pose --asset-path /Game/Rigs/RTG --reset-bones all

remove_retarget_pose

Remove a retarget pose

Parameter	Type	Required	Description
asset_path	string	Yes	IK Retargeter asset path
pose_name	string	Yes	Pose name
skeleton	string	No	source or target

auto_align_retarget_pose

Auto-align the retarget pose so the two skeletons' chains match

Parameter	Type	Required	Description
asset_path	string	Yes	IK Retargeter asset path
skeleton	string	No	source or target
bones	stringlist	No	Bones to align (default: all mapped chains)
method	string	No	ChainToChain, MeshToMesh, LocalRotationAxes or GlobalRotationAxes
snap_to_ground_bone	string	No	Snap this bone to the ground afterwards

batch_retarget

Duplicate and retarget animation assets through an IK Retargeter

Retargets Anim Sequences, Montages, Blend Spaces and Anim Blueprints from the retargeter's source mesh onto its target mesh, creating new assets and returning their paths. Give explicit --assets or a --folder (recursive, optionally --filter). Names get --prefix / --suffix / --search+--replace; every copy is named after its own source, montage segments and referenced assets included. A listed asset that is missing or not an animation, a batch that creates nothing, or fewer copies than requested is an error and every new asset is removed; assets are saved only after the whole batch succeeded. Prove the result with validate_anim_asset on a new sequence.

Parameter	Type	Required	Description
asset_path	string	Yes	IK Retargeter asset path
assets	stringlist	No	Animation assets to retarget
folder	string	No	Retarget every animation asset under this folder
filter	string	No	With --folder: substring filter on names
prefix	string	No	Prefix for new names
suffix	string	No	Suffix for new names
search	string	No	Substring to replace in new names
replace	string	No	Replacement for --search
include_referenced	bool	No	Also retarget referenced assets
target_path	string	No	Folder for the new assets. Default: the retargeter's folder
overwrite	bool	No	Overwrite existing assets: UE 5.8 in target_path; UE 5.7 only when target_path is /Game; refused on 5.6
source_mesh	string	No	Override the source mesh
target_mesh	string	No	Override the target mesh
save	bool	No	Save the new assets

example

  cfa batch_retarget --asset-path /Game/Rigs/RTG_UE4_to_Manny --assets /Engine/Tutorial/SubEditors/TutorialAssets/Character/Tutorial_Walk_Fwd --prefix Manny_ --target-path /Game/Anims/Retargeted
  cfa batch_retarget --asset-path /Game/Rigs/RTG_UE4_to_Manny --folder /Game/Anims/UE4 --filter Walk --suffix _Manny

validate_retarget

Verdict on an IK Retargeter: rigs, meshes, retarget roots, chain mapping, op stack

Parameter	Type	Required	Description
asset_path	string	Yes	IK Retargeter asset path

Loading…

PreviousCurves NextSkeletal Meshes