An Editor for hkbClipGenerators in Elden Ring Havok Behavior files.
Load a Behbnd or Havok Behavior hkx file using File > Open.
New generators can be added based on tae entries imported from your custom anibnd using File > Import From Anibnd. They can also be added individually using the "Add" button or duplicated from existing generators by selecting them in the list and using the "Duplicate" option in the context menu.
Generator properties can either be set as static values or bound to hkbVariables which can be set dynamically from hks scripts.
All operations can be undone/redone in the Edit menu.
It is recommended to use Ivi's modified c0000.hks in conjunction with this tool to reduce the amount of hks work necessary to have certain types of animations such as custom Ashes of War play in the game.
This tool provides a simplified view of the behavior graph at the clip generator level, aiming for ease of use rather than attempting to provide all the tools necessary to edit behavior graphs. For edits to any other components or the general structure of the graph use HKLib.CLI and refer to this wiki article.
Clip generators directly represent individual TAE entries in the behavior file. When adding new TAE entries to the game new clip generators representing these entries must be added to the behavior file so that the corresponding animations can be triggered by the animation state machine. Clip generators are selected for playback based on their animation name property which is of the following form: a[TaeId]_[AnimationId] where the TaeId is three digits long and AnimationId is 6 digits long. The selection is performed by Fromsoftware's custom generator class, CustomManualSelectorGenerator or CMSG for short. CMSGs each represent a single animation id and contain all clip generators with this animation id. The selection between generators is performed based on the character's active tae ids. For further info on Havok Behaviors see this wiki article.
A: This is not the aim of the tool as attempting to ensure this would require handling too many edge cases to be viable. Simple behaviors such as regular attacks will usually not require any further work but more complex behaviors will often require extra hks edits. Please refer to the troubleshooting section.
Q: Why does the tool create only a single new generator when duplicating a range of generators with identical animation names?
A: All clip generators which share an animation name perform the same function: to play the tae entry which corresponds to said animation name. Typically the properties of the clip will be identical regardless of where in the behavior graph it is triggered. As the tool does not aim to expose the structure of the entire behavior graph and opts for a simplified approach, it does not make sense to attempt to expose the context in which a generator instance is generated and so the tool creates only a single instance for a given animation name. Setting different properties based on clip generator context therefore requires manual edits, which can be made to the behavior graph in xml form using HKLib.CLI.
A: The "hkx_AutoSet" suffix is an arbitrary naming convention used by fromsoftware for distinguishing multiple clip generator instances which all generate the same animation id. The "Name" property of hkbGenerators is simply a unique identifier and does not serve any other function. Since Fromsoftware do not always reuse the same clip generator instance everywhere when an animationId is generated by multiple parent generators, they need a way to distinguish generator instances when the animation names are identical. To this end, their tooling automatically applies this suffix, incrementing the last two digits as necessary.
A: The tool does the supported operations equally well for all behavior files. However, due to differences between player and enemy behaviors additional edits which are not supported by this tool might be necessary in order to actually get the animations to play in game.
Combo length/composition is controlled in hks and in most cases by the "IsEnableNextAttack" function.
Landing Jump attack clips should have their "Start Time" property bound to the "TimeActEditor_10" variable to synchronize the transition from the mid-air jump attack animation. This variable is set directly by the BlendToIdleOrMovementAnim tae event in the previous animation.
This happens when hks logic which controls the triggering of events is dependent on the tae section and does not default correctly when it encounters an unexpected tae section which was added by the user. Typically the cause will lie somewhere in the corresponding Exec function in hks. Common_define.hks also contains some tables which are expected to contain all valid taes for the player character, using the modified c0000.hks linked above can bypass this issue.
The animation plays but cannot be canceled or causes the character lock up and become unresponsive after playback.
This typically happens when hks logic which controls the transition to the next event is dependent on the tae section and does not default correctly when it encounters an unexpected tae section which was added by the user. Typically the cause will lie somewhere in the corresponding onUpdate function in hks.
This indicates that the clip generator was not added properly. Make sure that the new clip generator appears in the sidebar and that you have saved the behavior file, repacked it into the bnd if editing a loose hkx file and reloaded the character in game. If the issue persists please submit a GitHub issue or message me on Discord at The12thAvenger#6149 with a bug report listing the exact steps taken and please ensure that the bug can be reproduced using these steps.
- SoulsFormats by TKGP
- Code from SoulsAssetPipeline by Meowmaritus