Enfusion Blender Tools: Import/Export Animation – Arma Reforger

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " " to " ")
No edit summary
Line 1: Line 1:
{{TOC|side}}
{{TOC|side}}Animations for Enfusion are exported into an intermediate human-readable format TXA. This format needs to be further compiled by the Enfusion engine into ANM - a binary format used during the runtime.<!--
Animations for Enfusion are exported into an intermediate human-readable format TXA.
This format needs to be further compiled by the Enfusion engine into ANM - a binary format used during the runtime.
<!--
{{Feature|informative|
{{Feature|informative|
See the following formats documentation:
See the following formats documentation:
Line 10: Line 7:
}}
}}
-->
-->
{{Feature|important|Before going any further, make sure that [[Arma_Reforger:Enfusion_Blender_Tools#Installation|'''Enfusion Blender Tools Data''']] is installed correctly. Without it, '''export profiles will be missing'''!}}
APR files are used for animations export. These files contain export profiles. Profiles can be found in {{hl|anims\export_profiles}}.
The export profile defines which bones to export and how to export them. Export profiles have to correspond with the used skeleton in the take.


It exports animation data for Enfusion. To have an animation created in Blender in Enfusion, follow these steps:
It exports animation data for Enfusion. To have an animation created in Blender in Enfusion, follow these steps:
 
#[[#Export_FBX_from_Blender |Export the FBX model from Blender with an armature matching the animation you want to export]]
# [[#Export_FBX_from_Blender |Export the FBX model from Blender with an armature matching the animation you want to export]]
#[[#Import_FBX_to_Enfusion|Import the FBX model into Enfusion]]
# [[#Import_FBX_to_Enfusion|Import the FBX model into Enfusion]]
#[[#Export_Animation_from_Blender|Export the animation from Blender (TXA format)]]
# [[#Export_Animation_from_Blender|Export the animation from Blender (TXA format)]]
#[[#Import_Animation_to_Enfusion|Import the animation TXA file into the Enfusion]]
# [[#Import_Animation_to_Enfusion|Import the animation TXA file into the Enfusion]]
 
{{Feature|informative|If you are trying to make animation to already existing character then you can skip directly to [[#Export_Animation_from_Blender|Export Animation from Blender ]] paragraph}}
{{Feature|informative|If you are trying to make animation to already existing character then you can skip directly to [[#Export_Animation_from_Blender|Export Animation from Blender ]] paragraph}}
 
==FBX==
== FBX ==
===Export FBX from Blender===
 
<gallery mode="packed-hover" heights="500px" style="text-align:left">
=== Export FBX from Blender ===
 
<gallery mode="packed-hover" heights=500px style="text-align:left" >
Image:armareforger-blender-txa-export-rest-position.png|Rest position
Image:armareforger-blender-txa-export-rest-position.png|Rest position
Image:armareforger-blender-txa-export-fbx-export.jpg|Blender FBX export settings
Image:armareforger-blender-txa-export-fbx-export.jpg|Blender FBX export settings
</gallery>
</gallery>Set the pose mode to rest for a given skeleton to export the rig. When exporting this FBX, make sure that you uncheck '''Add leaf bones''' option.
===Import FBX to Enfusion===
<gallery mode="packed-hover" heights="250" style="text-align:left">
File:armareforger-blender-txa-export-register-as-anim.png
File:armareforger-blender-txa-export-fbx-import.jpg
</gallery>Import the model "'''As Model'''" and afterwards set import to import skinning too.
==Animation==
===Export animations from Blender===
TXA Export is available in top section of 3D viewport. To perform export, following things are necessary:


Set the pose mode to rest for a given skeleton to export the rig. When exporting this FBX, make sure that you uncheck '''Add leaf bones''' option.
* at least one '''Armature''' & '''Action''' present in the current scene
* at least one folder is defined in '''Export Profile Folder'''  with some valid animation export profiles (see [[Arma_Reforger:Enfusion_Blender_Tools#Installation|'''Enfusion Blender Tools''']] page for instructions)
*
* running '''Workbench''' with '''net API enabled'''


=== Import FBX to Enfusion ===
If all above conditions are meet, from top bar select '''Enfusion Tools -> Export -> Enfusion Animation (.txa)''' to initiate animation export.


[[Image:armareforger-blender-txa-export-fbx-import.jpg|thumb|right|x500px|Import settings inside Workbench]]
[[Image:armareforger-blender-txa-export-toolbar.jpg|800px]]
[[Image:armareforger-blender-txa-export-register-as-anim.png]]


Import the model "As Model" and afterwards set import to import skinning too.
Once that button is pressed, following window should be visible:
{{Clear}}


== Animation ==
[[File:armareforger-blender-txa-export-animation3.png|frameless|800x800px]]


=== Export Animation from Blender ===
==== Top section ====
[[File:armareforger-blender-txa-export-animation-top-section.png]]


TXA Export is available in top section of viewport. From there, select '''Enfusion Tools -> Export -> Enfusion Animation (.txa)''' to initiate animation export.
Top section contains following things:


[[Image:armareforger-blender-txa-export-toolbar.jpg|800px]]
* '''Save location''' - folder where the exported actions will be stored. You can either type in the location or use '''Change save location''' button located on the right side
* '''Folder with export profiles -''' folder with animation export profiles which should be currently used. This list populated through '''Export Profile Folder''' parameter located in  '''Enfusion Blender Tools settings.'''
* '''Armature name -''' name of the armature which will be used for export. Bone transformations from this armature are processed by the exporter and stored in exported TXA file.
* '''Secondary armature name''' ''(optional)'' '''-''' name of the secondary armature which will be used during export . This is parameter is useful when armature which you want to export, is constrained to another armature and doesn't have any motion itself and you want to export multiple actions at once. In case of Rigify rig, in this field should be selected name of the Rigify control rig.  


Once that button is pressed, following window should be visible:
==== Action list ====
[[File:armareforger-blender-txa-export-animation-list.png]]


[[Image:armareforger-blender-txa-export-animation2.jpg]]
Action list contains actions found in the scene. Actions marked as assets are hidden from this list. Each individual action has '''Show exports''' checkbox, which controls the visibility of '''Action export list''' - this option is quite useful when dealing with large amount of actions like on example picture above.


In '''export section''' all animation takes related to selected Armature (picked in '''Armature name''' option) should be listed. By clicking on '''Show exports''' checkbox next to desired action name, it is possible to enable export of that animation and further define what action should be exported.
==== Action export list ====
[[File:armareforger-blender-txa-export-export-list.png]]


In '''export options''' section it is possible to change following things:
Action export list is the hear of TXA exporter. Over there it is possible to '''add exports''' & define '''how those actions will be processed'''. New entries in that list can be added by clicking on '''+''' button located on the right side.
* Pick animation '''export profile'''. All the profiles have to be in {{hl|anims\export_profiles}} or in a subdirectory. By default, assuming [[Arma_Reforger:Enfusion_Blender_Tools#Installation|Enfusion Blender Tools Data]] was correctly installed, there should be dozens of available animation exports which were used on Reforger assets. Selected profile has to correspond with the skeleton - otherwise no animation will be exported.
* Select animation for difference animations. This is only used if additive animation export profile is used.
* Change '''file name''' of exported animation. If this field is empty, plugin will use action name for creation of new txa


* '''Enable checkbox -''' control if this export is active or not. In inactive state '''no txa''' will be generated
* '''Profile -''' [[Arma Reforger:Animation Export Profiles|animation export profile]] which will be used on this export. By default, assuming [[Arma_Reforger:Enfusion_Blender_Tools#Installation|Enfusion Blender Tools Data]] was correctly installed, there should be dozens of available animation exports which were used on Reforger assets. Selected profile has to correspond with the skeleton - otherwise no animation will be exported.
* '''File''' - name of resulting txa file
* '''Diff pose''' ''(optional)'' - name of the action which will be used as difference target for additive transformations. If you are using animation profile which doesn't have any additive transformations, you can leave that field empty
* '''Diff pose frame''' ''(optional)'' -  frame of '''diff pose''' which will be used as a base for additive animations export
{{Feature|warning|Selecting proper '''export profile''' is crucial for correct export of animation! In case of custom rig, it might be necessary to create '''custom animation export profiles'''}}
{{Feature|warning|Selecting proper '''export profile''' is crucial for correct export of animation! In case of custom rig, it might be necessary to create '''custom animation export profiles'''}}


Location of where TXA files will be generated can be changed by selecting different directory in the '''save location''' field in the top section of export window.
Once all desired animation actions are selected and properly configured for export (meaning they have '''correct animation export profile''' selected), it is now possible to finally perform export to TXA. To do so, press '''OK''' button in bottom section of the export window.
 
====Default Profile====
Once all desired animation actions are selected and properly configured for export (meaning they have '''correct animation export profile''' selected), it is now possible to finally perform export to TXA. To do so, press '''Export TXA''' button in bottom right section of the export window.  
 
{{Feature|important|Deepening on complexity of the animation (''character animations can be especially demanding''), export can take up to 4 minutes while using 100% of the CPU.}}
 
==== Default Profile ====
If you create a new rig, you will need to create a new set of export profiles for it. As this can get tedious, you can generate a new export profile from the Workbench:<br>
in the model's import settings, check the "Generate Default Profile" option that will generate a sample profile. This default profile will export the transformation and rotation of each bone as absolute values. You can build your own profiles based on this profile.
 
=== Import Animation to Enfusion ===


===Import animation to Enfusion===
Once TXA is generated, there are two ways how to convert TXA into .ANM file:
Once TXA is generated, there are two ways how to convert TXA into .ANM file:
* Drag and drop the TXA file into the [[Arma Reforger:Resource Manager|Resource Browser]].
*Drag and drop the TXA file into the [[Arma Reforger:Resource Manager|Resource Browser]].
* Click on TXA with Right Mouse Button and select '''"Register and Import"''' option from the Context Menu.
*Click on TXA with Right Mouse Button and select '''"Register and Import"''' option from the Context Menu.
 
Once animation is imported, .ANM file will be automatically regenerated every time Workbench detects change in .TXA. If TXA was modified when Workbench was closed, manual reimport might be necessary.
Once animation is imported, .ANM file will be automatically regenerated every time Workbench detects change in .TXA. If TXA was modified when Workbench was closed, manual reimport might be necessary.
{{GameCategory|armaR|Modding|Tutorials|Official Tools|Enfusion Blender Tools}}
{{GameCategory|armaR|Modding|Tutorials|Official Tools|Enfusion Blender Tools}}

Revision as of 12:13, 8 December 2022

Animations for Enfusion are exported into an intermediate human-readable format TXA. This format needs to be further compiled by the Enfusion engine into ANM - a binary format used during the runtime.

It exports animation data for Enfusion. To have an animation created in Blender in Enfusion, follow these steps:

  1. Export the FBX model from Blender with an armature matching the animation you want to export
  2. Import the FBX model into Enfusion
  3. Export the animation from Blender (TXA format)
  4. Import the animation TXA file into the Enfusion
If you are trying to make animation to already existing character then you can skip directly to Export Animation from Blender paragraph

FBX

Export FBX from Blender

Set the pose mode to rest for a given skeleton to export the rig. When exporting this FBX, make sure that you uncheck Add leaf bones option.

Import FBX to Enfusion

Import the model "As Model" and afterwards set import to import skinning too.

Animation

Export animations from Blender

TXA Export is available in top section of 3D viewport. To perform export, following things are necessary:

  • at least one Armature & Action present in the current scene
  • at least one folder is defined in Export Profile Folder with some valid animation export profiles (see Enfusion Blender Tools page for instructions)
  • running Workbench with net API enabled

If all above conditions are meet, from top bar select Enfusion Tools -> Export -> Enfusion Animation (.txa) to initiate animation export.

armareforger-blender-txa-export-toolbar.jpg

Once that button is pressed, following window should be visible:

armareforger-blender-txa-export-animation3.png

Top section

armareforger-blender-txa-export-animation-top-section.png

Top section contains following things:

  • Save location - folder where the exported actions will be stored. You can either type in the location or use Change save location button located on the right side
  • Folder with export profiles - folder with animation export profiles which should be currently used. This list populated through Export Profile Folder parameter located in Enfusion Blender Tools settings.
  • Armature name - name of the armature which will be used for export. Bone transformations from this armature are processed by the exporter and stored in exported TXA file.
  • Secondary armature name (optional) - name of the secondary armature which will be used during export . This is parameter is useful when armature which you want to export, is constrained to another armature and doesn't have any motion itself and you want to export multiple actions at once. In case of Rigify rig, in this field should be selected name of the Rigify control rig.

Action list

armareforger-blender-txa-export-animation-list.png

Action list contains actions found in the scene. Actions marked as assets are hidden from this list. Each individual action has Show exports checkbox, which controls the visibility of Action export list - this option is quite useful when dealing with large amount of actions like on example picture above.

Action export list

armareforger-blender-txa-export-export-list.png

Action export list is the hear of TXA exporter. Over there it is possible to add exports & define how those actions will be processed. New entries in that list can be added by clicking on + button located on the right side.

  • Enable checkbox - control if this export is active or not. In inactive state no txa will be generated
  • Profile - animation export profile which will be used on this export. By default, assuming Enfusion Blender Tools Data was correctly installed, there should be dozens of available animation exports which were used on Reforger assets. Selected profile has to correspond with the skeleton - otherwise no animation will be exported.
  • File - name of resulting txa file
  • Diff pose (optional) - name of the action which will be used as difference target for additive transformations. If you are using animation profile which doesn't have any additive transformations, you can leave that field empty
  • Diff pose frame (optional) - frame of diff pose which will be used as a base for additive animations export
Selecting proper export profile is crucial for correct export of animation! In case of custom rig, it might be necessary to create custom animation export profiles

Once all desired animation actions are selected and properly configured for export (meaning they have correct animation export profile selected), it is now possible to finally perform export to TXA. To do so, press OK button in bottom section of the export window.

Default Profile

Import animation to Enfusion

Once TXA is generated, there are two ways how to convert TXA into .ANM file:

  • Drag and drop the TXA file into the Resource Browser.
  • Click on TXA with Right Mouse Button and select "Register and Import" option from the Context Menu.

Once animation is imported, .ANM file will be automatically regenerated every time Workbench detects change in .TXA. If TXA was modified when Workbench was closed, manual reimport might be necessary.