/DAR-AnimationFileRelocator

CUI Tool for SkyrimSE, for managing animation files

Primary LanguageRubyMIT LicenseMIT

DAR-AnimationFileRelocator

日本語のReadmeはこちら

[OverView]

This is a ruby tool to manage Animation Files and DAR Custom Conditions for Skyrim SE.
Creating a DAR folder, _condition.txt, placing animation files, and annotating events
with HKanno.exe are all automated by this tool.

[Features]

  • Animation files will be relocated to DAR Custom Condition Folder by using the configuration file.
    You can create the configuration file from scratch, but highly recommended to edit from autogenerated file by this tool.
  • The configuration file can describe all DAR Custom Conditions, and placing animation files.
    You no longer have to walk around thousands of DAR Condition folders in Exlorer.
  • Hkanno annotation information can also describe in the configuration file, and Hkanno update process is also automated.

[Requirements]

[How to Use]

Preparation

  1. Put Hkanno.exe to "Hkanno" folder.
  2. Put animation mods to "Managed_Mods" folder.
    Structure must be {Mod Folder}->data->meshes->...
  3. Edit Config.ini if you need.
    Refer to "Editing Config.ini"

Run

  1. Double click "AnimFileRelocator.bat"
    "ModList.toml" and "ModList.csv" will be generated.
  2. Copy&Paste these files to another name. Two files must be the same name exclude extention.
  3. Edit these files for your purpose.
    Refer to [Editing CustomConditions(Csv)] and [Editing Animation List(Toml)]
  4. Drag&Drop the csv file to "AnimFileRelocator.bat"

Editing Config.ini

  • DARCondition_Generate_From = 100000
    Animation files are placed in the DAR management folder (_CustomConditions) from this number.
  • DARCondition_Generate_To = 110000
    Animation files are placed in the DAR management folder (_CustomConditions) until this number.
  • ExportFolder = ExportFolder
    Animation files are placed to the specified folder.
    Path must be the Windows format. (Copy from Explorer Path). If you use MO2, "overwrite" folder is good for use.
  • DoesNeedDumpAnnotation = false
    If true, dump the annotated events below "Hkanno/IMPORTED_ANNO_TEXT" folder.
  • DEBUG = false
    If true, debug mode is on.

[Editing CustomConditions (Csv)]

CsvEditSample

  • The 1st column represent the [Section Name] of Toml. Only listed section will be relocated.
  • The second and subsequent columns represent the DAR Custom Conditions.
    The horizontal cells represent "AND", the vertical cells represent "OR".
    e.g) The third line in the above image represent :
    NOT IsFemale() AND IsEquippedRightType(1) OR IsEquippedRightType(2) OR IsEquippedRightType(3) OR IsEquippedRightType(4)
    AND IsEquippedLeftType(1) OR IsEquippedLeftType(2) OR IsEquippedLeftType(3) OR IsEquippedLeftType(4)
  • OR condition always requires "OR" in the 1st column.

[Editing Animation List (Toml)]

tomlImage

  • [SkySA_Animation_For_One-Handed_by_Ni-iru_200]
    A unique section name generated based on the folder name placed in the "Managed_Mods" folder.
  • comment = "_TypeA&idle"
    Comments on animations. It seems that it is customary to describe the description with the text file name
    in the Custom Condition folder, so the text name is treated as a comment.
  • hkannoPreset = "SkySA_Ni-ru_Conversion"
    Specify the folder name placed in the "Hkanno" folder.
    Refer to [Hkanno's Annotation Method]
  • location = "200"
    A value that indicates where the animation file is located. Do not change this from the value generated by ModList.toml.
  • modFolder = "SkySA Animation For One-Handed by Ni-iru"
    The name of the folder you placed in the "Managed_Mods" folder. Enclose with " ".
  • skysa_sword1.sourceFileName = "1hm_attackright.hkx"
    The left side is the file name of the copy destination (excluding the extension), and the right side is the file name of the copy source.
  • skysa_sword1.hkannoConfig = "_skysa_sword1_Anno.txt"
    The left side is the file name of the copy destination (excluding the extension),
    and the right side is the Annotation definition file specified by "Hkanno.exe update -i".

[Hkanno's Annotation Method]

"Hkanno.exe update -i {anno.txt}" will be executed by the definition of Toml's {animation file name} .hkannoConfig = "{Annotate definition file name}".
If you want to check the commandline, set "Debug = true" in Config.ini, and read log.txt.

Credits