v0.9.0

HowToUse.md

@@ -0,0 +1,47 @@
+     .----------------.  .----------------.  .----------------. 
+    | .--------------. || .--------------. || .--------------. |
+    | |  ________    | || |  _________   | || |  ____  ____  | |
+    | | |_   ___ `.  | || | |_   ___  |  | || | |_  _||_  _| | |
+    | |   | |   `. \ | || |   | |_  \_|  | || |   \ \  / /   | |
+    | |   | |    | | | || |   |  _|      | || |    > `' <    | |
+    | |  _| |___.' / | || |  _| |_       | || |  _/ /'`\ \_  | |
+    | | |________.'  | || | |_____|      | || | |____||____| | |
+    | |              | || |              | || |              | |
+    | '--------------' || '--------------' || '--------------' |
+     '----------------'  '----------------'  '----------------' 
+
+           DarknessFX @ https://dfx.lv | Twitter: @DrkFX
+
+# AdvancedPickerFX - How to Use
+
+- Create a new project using Third Person Template. <br/>
+<img src=".gitimages/HowToUse_01.png" width="640px" /> <br/>
+
+- Open the project, then at Toolbar > Level Sequence > Add Level Sequence . <br/>
+<img src=".gitimages/HowToUse_02.png" width="640px" /> <br/>
+
+- Save this sequence. <br/>
+<img src=".gitimages/HowToUse_03.png" width="640px" /> <br/>
+
+- Content Browser > Characters > Mannequins > Meshes > SKM_Manny , drag-drop SKM_Manny to your level viewport. <br/>
+<img src=".gitimages/HowToUse_04.png" width="640px" /> <br/>
+
+- Should look like this. <br/>
+<img src=".gitimages/HowToUse_05.png" width="640px" /> <br/>
+
+- At Level Sequence, click + ADD and select SKM_Manny. <br/>
+<img src=".gitimages/HowToUse_06.png" width="640px" /> <br/>
+
+- With luck, not only Manny but CR_Mannequin_Body is also added. <br/>
+<img src=".gitimages/HowToUse_07.png" width="640px" /> <br/>
+
+- Without luck, you need select SKM_Manny manually and click a + sign, at the right of the table cell. Then Control Rig -> Control Rig Classes and it will show avaiable ControlRigs for this skeleton.<br/>
+<img src=".gitimages/HowToUse_08.png" width="640px" /> <br/>
+
+- Back to Content Browser -> Tools Folder -> Right-click AdvancedPickerFX and Run Editor Utility Widget. <br/>
+<img src=".gitimages/HowToUse_09.png" width="640px" /> <br/>
+
+- You can now just attach AdvancedPickerFX tab anywhere in the LevelEditor and start using it.<br/>
+<img src=".gitimages/HowToUse_10.png" width="640px" /> <br/>
+<br/><br/>
+**[Return to Main Page](./README.md)**

README.md

@@ -12,5 +12,59 @@
 
            DarknessFX @ https://dfx.lv | Twitter: @DrkFX
 
-# AdvancedPickerFX
-WIP
+# AdvancedPickerFX for Unreal Engine 5 Character Animation
+
+<img src="./.gitimages/AdvancedPickerFX_banner.png" width="640px" /> <br/>
+
+## About
+
+AdvancedPickerFX is free and open source Editor Utility Tool for Unreal Engine GameDev Community. Created to work with any skeletons (UE4, UE5 Manny+Quinn, Echo, MetaHuman, others) and inpired by Epic's Unreal Engine MetaHuman ControlRig Picker, AdvancedPickerFX provides the expetected main Picker features (bones and control groups shortcuts) and also feature customizable categories to access and edit Expressions and Morph Targets.
+
+## Installation
+
+Simply copy \Tool\ folder from this repository to your Unreal Engine project.
+
+## How to use
+
+If the phrase "Add a controlrig in LevelSequence" don't make sense or if you can not find the tool with the instructions below, then check <a href="./HowToUse.md" target="_blank">How To Use - Basic Steps</a>.
+
+- Create or open a Level Sequence.
+- Add a SkeletalMesh actor to Level Sequence.
+- Attach a ControlRig to SkeletalMesh.
+- Content Browser, right-click AdvancedPickerFX -> Run Editor Utility Widget. After the 1st run, AdvancedPickerFX also register as a menu at LevelEditor Menu > Tools > Editor Utility Widgets > AdvancedPickerFX .
+- AdvancedPickerFX tab will show up and sync to your ControlRig and Level Sequence.
+
+## Features
+
+| Screen | Description |
+| ------------- | ------------- |
+| <img src="./.gitimages/MainScreen.png" width="480px" /> <br/> | AdvancedPickerFX main screen, here you can choose what ControlRig in Sequence to sync and work with. If needed the refresh button will search for new ControlRigs. |
+| <img src="./.gitimages/Body.png" width="480px" /> <br/> | Collection of shortcuts to main bones controls. |
+| <img src="./.gitimages/Hand.png" width="480px" /> <br/> | Collection of shortcuts to hand and fingers controls. |
+| <img src="./.gitimages/Foot.png" width="480px" /> <br/> | Collection of shortcuts to foot and toes controls. |
+| <img src="./.gitimages/Expressions.png" width="480px" /> <br/> | Collection of shortcuts of available expressions. |
+| <img src="./.gitimages/Categories.png" width="480px" /> <br/> | Categories feature an accessible and expansible list of sub-categories and filters. |
+| <img src="./.gitimages/BodyParts.png" width="480px" /> <br/> | Pre-configured category grouping Body Morph Target controls. |
+| <img src="./.gitimages/Eye.png" width="480px" /> <br/> | Pre-configured category grouping Eye Morph Target controls. |
+| <img src="./.gitimages/Nose.png" width="480px" /> <br/> | Pre-configured category grouping Nose Morph Target controls. |
+| <img src="./.gitimages/Mouth.png" width="480px" /> <br/> | Pre-configured category grouping Mouth Morph Target controls. |
+| <img src="./.gitimages/Viseme.png" width="480px" /> <br/> | Pre-configured category grouping Viseme Morph Target controls. |
+
+## Credits
+
+Logo Icon use Clamp icon fom icons8 - https://icons8.com/icon/ju3rmQ3k4Ymh/clamp <br/>
+Logo Font use Gamecuben from Bleutuna - https://www.dafont.com/gamecuben.font <br/>
+
+Unreal Engine from Epic Games - https://www.unrealengine.com/ <br/>
+Unreal Engine MetaHuman ControlRig Picker - https://www.unrealengine.com/metahuman <br/>
+Skeleton images use Midnight Bones for Genesis 9 from Daz3D - https://www.daz3d.com/midnight-bones-for-genesis-9 <br/>
+Expressions images use Genesis 9 Expressions with Victoria 9 model from Daz3D - https://www.daz3d.com/genesis-9-expressions <br/>
+Microsoft Fluent Icons - https://github.com/microsoft/fluentui-system-icons <br/>
+icons8 - https://icons8.com <br/>
+FontAwesome - https://fontawesome.com <br/>
+Google Material Design Icons - https://fonts.google.com/icons<br/>
+
+## License
+
+@MIT - Free for everyone and any use. <br/><br/>
+DarknessFX @ <a href="https://dfx.lv" target="_blank">https://dfx.lv</a> | Twitter: <a href="https://twitter.com/DrkFX" target="_blank">@DrkFX</a> <br/>https://github.com/DarknessFX/AdvancedPickerFX