diff --git a/rigify/README b/rigify/README index ae26c8066edfd1a0471dc44f31b3f3b77fddb9eb..39e8cda65a5c3555f1795feaca1736546f77a159 100644 --- a/rigify/README +++ b/rigify/README @@ -236,3 +236,17 @@ especially with more complex samples. There is a function in utils.py that will generate the code for create_sample() for you, based on a selected armature. The function is called write_metarig() + +GENERATING A PYTHON UI +---------------------- +The generate() method can also, optionally, return python code as a string. +This python code is added to the "rig properties" panel that gets +auto-generated along with the rig. This is useful for exposing things like +IK/FK switches in a nice way to the animator. + +The string must be returned in a list: + +return ["my python code"] + +Otherwise it won't work. +