Arma Reforger:Weapon Animation/Basic Tutorial - Revision history

Lou Montana: Text replacement - "\{\{GameCategory\|armaR\|Modding\|(Guidelines|Tutorials)\|([^=↵]*)\}\}" to "{{GameCategory|armaR|Modding|$2|$1}}"

2025-02-26T12:32:04Z

Text replacement - "\{\{GameCategory\|armaR\|Modding\|(Guidelines|Tutorials)\|([^=↵]*)\}\}" to "{{GameCategory|armaR|Modding|$2|$1}}"

← Older revision		Revision as of 14:32, 26 February 2025
Line 477:		Line 477:
	==Continuation==		==Continuation==

	{{GameCategory\|armaR\|Modding~~\|Tutorials~~\|Assets\|Weapon Animation}}		{{GameCategory\|armaR\|Modding\|Assets\|Weapon Animation\|Tutorials}}
	{{GameCategory\|armaR\|Modding~~\|Tutorials~~\|Assets\|Weapon Creation}}		{{GameCategory\|armaR\|Modding\|Assets\|Weapon Creation\|Tutorials}}

Reyhard at 10:35, 4 December 2024

2024-12-04T10:35:07Z

← Older revision		Revision as of 12:35, 4 December 2024
Line 478:		Line 478:

	{{GameCategory\|armaR\|Modding\|Tutorials\|Assets\|Weapon Animation}}		{{GameCategory\|armaR\|Modding\|Tutorials\|Assets\|Weapon Animation}}
			{{GameCategory\|armaR\|Modding\|Tutorials\|Assets\|Weapon Creation}}

Reyhard: /* Setup Base Pose */

2024-09-07T06:45:44Z

Setup Base Pose

← Older revision		Revision as of 08:45, 7 September 2024
Line 230:		Line 230:
	*Select all '''Rig''' armature bones (make sure you did unhide all the '''Rig Layers''' in '''Item''' tab! )		*Select all '''Rig''' armature bones (make sure you did unhide all the '''Rig Layers''' in '''Item''' tab! )
	* In '''Pose Library''', apply appropriate base pose - for rifle it is '''Pose Rifle Rigify''' - to the selection (''see '''Applying poses from Pose Library''' paragraph for details'')		* In '''Pose Library''', apply appropriate base pose - for rifle it is '''Pose Rifle Rigify''' - to the selection (''see '''Applying poses from Pose Library''' paragraph for details'')
	** Different type of weapon archetypes are using different base IK pose and this is working together with '''Animation Instance''' parameter in '''SCR_WeaponAttachmentsStorageComponent''' - more on that latter		** Different type of '''weapon archetypes''' are using '''different base IK''' pose and this is working together with '''Animation Instance''' parameter in '''SCR_WeaponAttachmentsStorageComponent''' - more on that latter. If you are f.e. creating RPG-7 type of weapon then use '''Pose RPG Rigify'''
	**🔵It is also possible to use [https://docs.blender.org/manual/en/latest/editors/asset_browser.html '''Asset Browser'''] for management and creation of new poses		**🔵It is also possible to use [https://docs.blender.org/manual/en/latest/editors/asset_browser.html '''Asset Browser'''] for management and creation of new poses
	[[File:armareforger-new-weapon-animation-apply-ik-pose.gif]]		[[File:armareforger-new-weapon-animation-apply-ik-pose.gif]]

Reyhard: /* Setup Base Pose */

2024-09-07T06:44:29Z

Setup Base Pose

← Older revision		Revision as of 08:44, 7 September 2024
Line 229:		Line 229:
	*''Optionally'': Turn on [https://docs.blender.org/manual/en/latest/editors/timeline.html#bpy-types-toolsettings-use-keyframe-insert-auto '''Auto Keying'''] option - without it, keyframe will have to be created manually at the end of the process		*''Optionally'': Turn on [https://docs.blender.org/manual/en/latest/editors/timeline.html#bpy-types-toolsettings-use-keyframe-insert-auto '''Auto Keying'''] option - without it, keyframe will have to be created manually at the end of the process
	*Select all '''Rig''' armature bones (make sure you did unhide all the '''Rig Layers''' in '''Item''' tab! )		*Select all '''Rig''' armature bones (make sure you did unhide all the '''Rig Layers''' in '''Item''' tab! )
	* In '''Pose Library''', apply '''Pose Rifle Rigify''' ~~animation~~ to the selection (''see '''Applying poses from Pose Library''' paragraph for details'')		* In '''Pose Library''', apply appropriate base pose - for rifle it is '''Pose Rifle Rigify''' - to the selection (''see '''Applying poses from Pose Library''' paragraph for details'')
			** Different type of weapon archetypes are using different base IK pose and this is working together with '''Animation Instance''' parameter in '''SCR_WeaponAttachmentsStorageComponent''' - more on that latter
	**🔵It is also possible to use [https://docs.blender.org/manual/en/latest/editors/asset_browser.html '''Asset Browser'''] for management and creation of new poses		**🔵It is also possible to use [https://docs.blender.org/manual/en/latest/editors/asset_browser.html '''Asset Browser'''] for management and creation of new poses
	[[File:armareforger-new-weapon-animation-apply-ik-pose.gif]]		[[File:armareforger-new-weapon-animation-apply-ik-pose.gif]]
Line 330:		Line 331:
	First step towards assigning this animation will be loading weapon prefab in '''World Editor''' (''[enfusion://ResourceManager/~SampleMod_NewWeapon:Prefabs/Weapons/Rifles/SampleWeapon_01_base.et SampleWeapon_01_Base.et]'') and then locating '''SCR_WeaponAttachmentsStorageComponent''' component.		First step towards assigning this animation will be loading weapon prefab in '''World Editor''' (''[enfusion://ResourceManager/~SampleMod_NewWeapon:Prefabs/Weapons/Rifles/SampleWeapon_01_base.et SampleWeapon_01_Base.et]'') and then locating '''SCR_WeaponAttachmentsStorageComponent''' component.
	Over there, find '''Animation IK Pose''' parameter in '''Attributes → Item Animation Attributes''' section of the component and assign your '''previously exported IK animation''' (''p_rfl_sampleweapon_01_ik.anm'').		Over there, find '''Animation IK Pose''' parameter in '''Attributes → Item Animation Attributes''' section of the component and assign your '''previously exported IK animation''' (''p_rfl_sampleweapon_01_ik.anm'').

			If you plan to do different type of weapon, make sure to also change '''Animation Instance''' parameter so it matches desired type - of course you need to use also proper IK base animation in Blender! In most cases, if you are duplicating similar type of weapon then this parameter will be already set correctly.

	This animation is very important for proper handling of character weapon holding animation but it doesn't work alone and it requires '''IKOffset, Safety & Idle''' animations which were assigned before in '''Animation Editor''' itself. Once that animation was assigned to '''Animation IK Pose field, don't forget to save your changes to prefab (use '''Apply to prefab button''' if change was made to entity instead of prefab).'''		This animation is very important for proper handling of character weapon holding animation but it doesn't work alone and it requires '''IKOffset, Safety & Idle''' animations which were assigned before in '''Animation Editor''' itself. Once that animation was assigned to '''Animation IK Pose field, don't forget to save your changes to prefab (use '''Apply to prefab button''' if change was made to entity instead of prefab).'''

Reyhard: /* Export Weapon Animations */ Made segment about weapon animation export bit more clear

2024-09-04T10:45:21Z

Export Weapon Animations: Made segment about weapon animation export bit more clear

← Older revision		Revision as of 12:45, 4 September 2024
Line 417:		Line 417:
	*Add 1 export field to '''w_sampleweapon_safety''' action		*Add 1 export field to '''w_sampleweapon_safety''' action
	**'''w_rfl_sampleweapon_01_safety''' with '''701_Rifle_Idle''' export profile		**'''w_rfl_sampleweapon_01_safety''' with '''701_Rifle_Idle''' export profile
			{{Feature\|important\|Please note that in above example weapon specific animations were created in [https://github.com/BohemiaInteractive/Arma-Reforger-Samples/blob/main/SampleMod_NewWeapon/Assets/Weapons/Rifles/SampleWeapon_01/SampleWeapon_01.blend\|separate blend file]. Since there is no other armature present, controls for armature selection are not present.

			If you have for instance character armature present, make sure to use '''Additional Armature''' option and select over there armature of the weapon like on picture below
			[[File:armareforger-new-weapon-animation-export-weapon-anims-additional.png]]}}
			[[File:armareforger-new-weapon-animation-export-weapon-anims-additional.png\|thumb]]
	[[File:armareforger-new-weapon-animation-filling-more-anims.png\|thumb\|Adding animations to '''weapon (sampleweapon_01_weapon.asi)''' animation instance]]		[[File:armareforger-new-weapon-animation-filling-more-anims.png\|thumb\|Adding animations to '''weapon (sampleweapon_01_weapon.asi)''' animation instance]]
	Once animations are exported, import & register them in Workbench and then proceed to animation workspace of the rifle in '''Animation Editor'''. Over there activate '''weapon animation instance''' '''(sampleweapon_01_weapon.asi)''' and in '''Anim Sets''' window and fill animations to '''Erc & Pne''' columns as on list below:		Once animations are exported, import & register them in Workbench and then proceed to animation workspace of the rifle in '''Animation Editor'''. Over there activate '''weapon animation instance''' '''(sampleweapon_01_weapon.asi)''' and in '''Anim Sets''' window and fill animations to '''Erc & Pne''' columns as on list below:

Reyhard: /* Importing TXA in Resource Manager */

2024-09-03T11:06:27Z

Importing TXA in Resource Manager

← Older revision		Revision as of 13:06, 3 September 2024
Line 275:		Line 275:
	{{Messagebox\|'''Recommended read:''' More information about TXA export can be found in [[Arma_Reforger:Enfusion_Blender_Tools:_Import/Export_Animation\|'''Enfusion Blender Tools''']] documentation \|📖\|lightgrey}}		{{Messagebox\|'''Recommended read:''' More information about TXA export can be found in [[Arma_Reforger:Enfusion_Blender_Tools:_Import/Export_Animation\|'''Enfusion Blender Tools''']] documentation \|📖\|lightgrey}}
	====Importing TXA in Resource Manager ====		====Importing TXA in Resource Manager ====
	If action was correctly exported, '''three TXA files''' should be present in selected location.		If action was correctly exported, '''three TXA files''' should be present in selected location. By default, Enfusion Blender Tools will try to '''automatically register TXA files''' '''-''' it might fail however if you are using symbolic links or save location is incorrect (outside of your project).
	In '''Resource Manager''' click on them with Right Mouse Button and select '''Register & Import''' option in context menu.
			If registration didn't succeed yet TXA files are inside of your project, in '''Resource Manager''' click on them with '''Right Mouse Button''' {{Controls\|rmb\|}} and select '''Register & Import''' option in context menu.
	This should trigger conversion of txa files into anm - binary form of animation - and generate meta file for it.		This should trigger conversion of txa files into anm - binary form of animation - and generate meta file for it.

Reyhard: /* First Time TXA Export */ updated picture & description of that segment. Add few useful notes regarding frequently encountered issues

2024-09-03T10:56:11Z

First Time TXA Export: updated picture & description of that segment. Add few useful notes regarding frequently encountered issues

Reyhard: /* Preparing Blender */

2024-07-26T11:57:40Z

Preparing Blender

← Older revision		Revision as of 13:57, 26 July 2024
Line 25:		Line 25:
	This tutorial covers animation creation workflow in '''Blender''' using the '''[[Arma_Reforger:Enfusion_Blender_Tools\|Enfusion Blender Tools]]''' plugin. This plugin is used to export '''Blender actions''' to '''Enfusion text based animation''' files (''.txa'') which can be then converted to '''Enfusion binary animation''' files (''.anm''). With this addon it is also possible to export '''actions''' with '''selected amount of bones''' (''which is extremely important when it comes to Enfusion animations'') ''via'' the '''[[Arma_Reforger:Animation_Export_Profiles\|export profiles]]''' functionality and '''export of additive animations'''.		This tutorial covers animation creation workflow in '''Blender''' using the '''[[Arma_Reforger:Enfusion_Blender_Tools\|Enfusion Blender Tools]]''' plugin. This plugin is used to export '''Blender actions''' to '''Enfusion text based animation''' files (''.txa'') which can be then converted to '''Enfusion binary animation''' files (''.anm''). With this addon it is also possible to export '''actions''' with '''selected amount of bones''' (''which is extremely important when it comes to Enfusion animations'') ''via'' the '''[[Arma_Reforger:Animation_Export_Profiles\|export profiles]]''' functionality and '''export of additive animations'''.

	'''Enfusion Blender Tools''' addon is designed to work with '''[https://www.blender.org/download/lts/3-3/ Blender 3.3 LTS]'''version so it is recommended to use at least this version of Blender.		'''Enfusion Blender Tools''' addon is designed to work with '''[https://www.blender.org/download/lts/3-6/ Blender 3.6 LTS]'''version so it is recommended to use at least this version of Blender.
	Newer versions of Blender might work without problem although this is not guaranteed (especially with snapshot builds).		Newer versions of Blender might work without problem although this is not guaranteed (especially with snapshot builds).
	Installation instructions of the plugin can be found on the '''[[Arma_Reforger:Enfusion_Blender_Tools#Installation\|Enfusion Blender Tools Wiki page]]''' - pay attention to paragraph about configuration of '''Export Profile Folder''' parameter which is '''mandatory for TXA exporter'''.		Installation instructions of the plugin can be found on the '''[[Arma_Reforger:Enfusion_Blender_Tools#Installation\|Enfusion Blender Tools Wiki page]]''' - pay attention to paragraph about configuration of '''Export Profile Folder''' parameter which is '''mandatory for TXA exporter'''.

Reyhard: /* Testing result in game */

2023-11-21T10:19:15Z

Testing result in game

← Older revision		Revision as of 12:19, 21 November 2023
Line 309:		Line 309:
	*Assign same animation for '''Pne''' column and then for '''Erc''' & '''Pne''' columns in '''Safety (5)''' row.		*Assign same animation for '''Pne''' column and then for '''Erc''' & '''Pne''' columns in '''Safety (5)''' row.
	*In '''IKOffset (6)''' row assign '''p_rfl_sampleweapon_01_offset''' animation in both '''Erc''' & '''Pne''' columns.		*In '''IKOffset (6)''' row assign '''p_rfl_sampleweapon_01_offset''' animation in both '''Erc''' & '''Pne''' columns.
	[[File:armareforger-new-weapon-animation-assign-safety-anim.gif]]		Additionally, to avoid hand animation distortion when weapon is picked up, 🔴 '''temporarily 🔴''' assign '''p_rfl_sampleweapon_01_offset to Switch_Mode_On & Off''' fields. 🔴 '''You should later replace that animation with proper one 🔴''', since with this temporary incorrect animation you will get glitch when weapon fire mode (or safety) is changed.{{Feature\|important\|Remember, '''weapon needs full animation set to be fully functional'''. This test is just to verify that animations are working correctly for now. Things like weapon inspection, reloading or even switching fire mode are not going to work yet!}}[[File:armareforger-new-weapon-animation-assign-safety-anim.gif]]

	=== Animation playback in Animation Editor ===		=== Animation playback in Animation Editor ===
Line 334:		Line 334:
	With all those pieces in place, it should be now possible to test the animations in game already. To do so, load i.e. [enfusion://WorldEditor/Worlds/Modding/Assets_Showcase_Basic.ent;117.741,6.55589,125.792;-24.0249,42.014,0;21 Assets_Showcase_Basic] scenario from main sample mod and place in the world weapon prefab (''[enfusion://ResourceManager/~SampleMod_NewWeapon:Prefabs/Weapons/Rifles/SampleWeapon_01.et SampleWeapon_01.et]'').		With all those pieces in place, it should be now possible to test the animations in game already. To do so, load i.e. [enfusion://WorldEditor/Worlds/Modding/Assets_Showcase_Basic.ent;117.741,6.55589,125.792;-24.0249,42.014,0;21 Assets_Showcase_Basic] scenario from main sample mod and place in the world weapon prefab (''[enfusion://ResourceManager/~SampleMod_NewWeapon:Prefabs/Weapons/Rifles/SampleWeapon_01.et SampleWeapon_01.et]'').
	Alternatively, it is also possible to load [enfusion://ResourceManager/~ArmaReforger:worlds/MP/MpTest.ent MpTest.ent] scenario, make new sub-scene world and then place the weapon in the world.		Alternatively, it is also possible to load [enfusion://ResourceManager/~ArmaReforger:worlds/MP/MpTest.ent MpTest.ent] scenario, make new sub-scene world and then place the weapon in the world.

			{{Feature\|important\|Remember, '''weapon needs full animation set to be fully functional'''. This test is just to verify that animations are working correctly for now. Things like weapon inspection, reloading or even switching fire mode are not going to work yet!}}

	[[File:armareforger-new-weapon-animation-testing-ik-pose.png]]		[[File:armareforger-new-weapon-animation-testing-ik-pose.png]]

Reyhard: /* Adding magazine to the Scene */

2023-07-24T13:08:02Z

Adding magazine to the Scene

← Older revision		Revision as of 15:08, 24 July 2023
Line 198:		Line 198:
	**In '''Target (4)''' field select '''Character''' armature		**In '''Target (4)''' field select '''Character''' armature
	**In '''Bone (4)''' field select '''LeftHandProp''' bone		**In '''Bone (4)''' field select '''LeftHandProp''' bone
	[[File:armareforger-new-weapon-animation-magazine-object-constraint.png]]{{Messagebox\|'''Tip:''' You might consider hiding ''snap_magazine'' object in viewport.\|✩\|#88cc88}}Once this has been done, it is already possible to set up the '''magazine''' in such a way that it is '''attached to the gun''' itself.{{Feature\|important\|This step is important for weapon deployment feature!}}To do this, follow the instructions below:		[[File:armareforger-new-weapon-animation-magazine-object-constraint.png]]{{Messagebox\|'''Tip:''' You might consider hiding ''snap_magazine'' object in viewport.\|✩\|#88cc88}}Once this has been done, it is already possible to set up the '''magazine''' in such a way that it is '''attached to the gun''' itself.{{Feature\|important\|This step is important for [[Arma_Reforger:Weapon_Creation/Prefab_Configuration#Deployment_IK_Targets\|'''weapon deployment feature!''']]}}To do this, follow the instructions below:

	*Select '''Rig''' armature in the scene		*Select '''Rig''' armature in the scene

← Older revision		Revision as of 12:56, 3 September 2024
Line 259:		Line 259:
	Next, click on [https://community.bistudio.com/wiki/Arma_Reforger:Enfusion_Blender_Tools:_Import/Export_Animation#Export_animations_from_Blender '''Enfusion Tools → Export → Enfusion Animation (.txa)'''] in top section of the '''3D Viewport'''.		Next, click on [https://community.bistudio.com/wiki/Arma_Reforger:Enfusion_Blender_Tools:_Import/Export_Animation#Export_animations_from_Blender '''Enfusion Tools → Export → Enfusion Animation (.txa)'''] in top section of the '''3D Viewport'''.

	This should open a new window in the center of Blender showing '''two parameters''' and '''listing all actions''' present in the blend file with ~~unchecked~~ '''~~Show exports~~ (1)''' parameter next to them.		This should open a new window in the center of Blender showing '''two parameters''' and '''listing all actions''' present in the blend file with collapsed '''visibility (1)''' parameter next to them.
	~~Once~~ it ~~is present,~~ perform following actions:		Expand action params by clicking on it once and then perform following actions:

	*Select save location by either copy pasting path in text field or by pressing '''Change save location''' button		*Select save location by either copy pasting path in text field or by pressing '''Change save location''' button
			**Save location should be pointing to a folder '''inside of your project'''. By default, Enfusion Blender Tools suggest using '''relative path''' which is quite handy if you share project between multiple people.
			**''In Sample New Weapon, save location is located in '''Assets/Weapons/Rifles/SampleWeapon_01/Anims''' folder inside the addon''
	*Select '''Character''' armature in '''Armature name''' - exporter will attempt to export bones movement from this skeleton		*Select '''Character''' armature in '''Armature name''' - exporter will attempt to export bones movement from this skeleton
	*In '''Secondary armature name''' select '''rig''' skeleton.		*In '''Secondary armature name''' select '''rig''' skeleton.
	**At this stage this is not going to do anything but it is nice to have it filled in table now. 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.		**At this stage this is not going to do anything but it is nice to have it filled in table now. 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.
	*Add 3 entries to the list by clicking on ~~plus~~ button on the right side of the window		*Add 3 entries to the list by clicking on '''+ Add (2)''' button on the right side of the window
	*Fill in data as picture below		*Fill in data as picture below
	* Click on large '''OK''' button to start TXA export		* Click on large '''OK''' button to start TXA export
	[[File:armareforger-new-weapon-animation-export-txa-blender.png]]		[[File:armareforger-new-weapon-animation-export-txa-blender.png]]

			{{Messagebox\|'''Recommended read:''' More information about TXA export can be found in [[Arma_Reforger:Enfusion_Blender_Tools:_Import/Export_Animation\|'''Enfusion Blender Tools''']] documentation \|📖\|lightgrey}}
	====Importing TXA in Resource Manager ====		====Importing TXA in Resource Manager ====
	If action was correctly exported, '''three TXA files''' should be present in selected location.		If action was correctly exported, '''three TXA files''' should be present in selected location.