200 lines
9.7 KiB
Markdown
200 lines
9.7 KiB
Markdown
# avatar-graph-comfyui
|
||
|
||
|
||
|
||
A custom_nodes module for creating real-time interactive avatars powered by blender bpy mesh api + Avatech Shape Flow runtime.
|
||
|
||
# Demo
|
||
|
||
https://github.com/avatechai/avatar-graph-comfyui/assets/18395202/47fd5a98-ab0f-4c5c-b132-5d4b0aa02763
|
||
|
||
[➡️Open in Avatech Labs]()
|
||
|
||
https://github.com/avatechai/avatar-graph-comfyui/assets/18395202/b229a4b3-88ba-4755-a8e0-9149260eef12
|
||
|
||
[➡️Open in Avatech Labs]()
|
||
|
||
https://github.com/avatechai/avatar-graph-comfyui/assets/18395202/e054e1a9-eb20-4ca6-be44-0ba9c7c07d50
|
||
|
||
[➡️Open in Avatech Labs]()
|
||
|
||
# Contents
|
||
- [Demo](#demo)
|
||
- [Custom Nodes](custom-nodes)
|
||
- [Workflow Template](workflow-template)
|
||
- [Image Preprocess Guide](#image-preprocess-guide)
|
||
- [Shape Flow](#shape-flow)
|
||
- [Installation](#installation)
|
||
- [Development](#development)
|
||
|
||
# Custom Nodes
|
||
Custom nodes for ComfyUI.
|
||
<details>
|
||
<summary> Expand to see all the nodes available✨</summary>
|
||
|
||
## Image Segmentation Nodes
|
||
| Name | Description | Preview |
|
||
| ---------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
|
||
| `Segmentation (SAM)` | Integrative SAM node allowing you to directly select and create multiple image segment output. | <img src="https://github.com/avatechai/avatar-graph-comfyui/assets/18395202/8aabeba8-5450-4d39-8203-e91f9ab47190" width="300"> |
|
||
|
||
## Mesh Edit Nodes
|
||
| Name | Description | Preview |
|
||
| ---------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
|
||
| `Create Mesh Layer` | Create a mesh object from the input images (usually a segmented part of the entire image) | <img src="https://github.com/avatechai/avatar-graph-comfyui/assets/18395202/40740d25-9411-4cd3-a6c0-8b9008bca41c" width="300"> |
|
||
| `Join Meshes` | Combine multiple meshes into a single mesh object | <img src="https://github.com/avatechai/avatar-graph-comfyui/assets/18395202/ba7afbc5-9cd5-4f97-9614-f71133f5783e" width="300"> |
|
||
| `Match Texture Aspect Ratio` | Since the mesh is created in 1:1 aspect ratio, a re-scale is needed at the end of the operation | <img src="https://github.com/avatechai/avatar-graph-comfyui/assets/18395202/cb7155be-fb31-49f8-a24a-d001a1484ea7" width="300"> |
|
||
| `Plane Texture Unwrap` | Will perform mesh face fill and UV Cube project on the target plane mesh, scaled to bounds. | <img src="https://github.com/avatechai/avatar-graph-comfyui/assets/18395202/4b9c0cf5-0497-47bf-8e06-5a3370084c11" width="300"> |
|
||
|
||
## Shape Keys Nodes
|
||
| Name | Description | Preview |
|
||
| ---------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
|
||
| `Mesh Modify Shape Key` | Given shape key name & target vertex_group, modify the vertex / all vertex’s transform | <img src="https://github.com/avatechai/avatar-graph-comfyui/assets/18395202/ab4f259c-89a7-4f51-bc54-fd179e252073" width="300"> |
|
||
| `Create Shape Flow` | Create runtime shape flow graph, allowing interactive inputs affecting shape keys value in runtime | <img src="https://github.com/avatechai/avatar-graph-comfyui/assets/18395202/abfdd801-0387-4c5d-9c11-6c23337ff1dd" width="300"> |
|
||
|
||
## Avatar Output Nodes
|
||
| Name | Description | Preview |
|
||
| ---------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
|
||
| `Avatar Main Output` | The primary output of the .ava file. The embeded Avatar View will auto update with this node's output | <img src="https://github.com/avatechai/avatar-graph-comfyui/assets/18395202/6a9a8bb4-05ec-4a2e-98bf-194b6af3a62a" width="300"> |
|
||
|
||
</details>
|
||
|
||
# Workflow Template
|
||
|
||
## Simple Rig Workflow
|
||
To enable the character to blink eyes and talking.
|
||
|
||
> **🎯Notice**
|
||
>
|
||
> For optimal results, please input a character image with an open mouth and a minimum resolution of 768x768. This higher resolution will enable the tool to accurately recognize and work with facial features.
|
||
|
||
[💡Generate new image Guide](#character-gen-prompting-guide)
|
||
|
||
[💡Make your character mouth open Guide](#mouth-open-guide-inpaint)
|
||
|
||
|
||
|
||
### Download: 📂[Simple Rig Template](https://github.com/avatechai/avatar-graph-comfyui/blob/main/workflow_templates/SimpleEye+MouthMovement.json)
|
||
|
||
|
||
# Image Preprocess Guide
|
||
|
||
### 💡If you want to generate a new character image
|
||
> you can download this Template and refer to the Guide!
|
||
> <details>
|
||
> <summary> Character Gen Prompting Guide </summary>
|
||
>
|
||
> # Character Gen Prompting Guide
|
||
>> **🎯Notice**
|
||
>>
|
||
>> We need a character image with an open mouth and enable the tool to easily recognize facial features, so please add to the prompt:
|
||
>>
|
||
>> ```looking at viewer, detailed face, open mouth, [smile], solo,eye-level angle```
|
||
>
|
||
>
|
||
>
|
||
> ### Download: 📂[Character Gen Template](https://github.com/avatechai/avatar-graph-comfyui/blob/main/workflow_templates/SimpleCharacterGen.json)
|
||
> Feel free to change any checkpoint model that suits your needs.
|
||
>
|
||
> </details>
|
||
|
||
### 💡If you have a character image but it's not mouth open
|
||
> you can download this Template and refer to the Guide!
|
||
> <details>
|
||
> <summary> Mouth Open Guide (Inpaint) </summary>
|
||
>
|
||
> # Mouth Open Guide (Inpaint)
|
||
> To maintain consistency with the base image, it is recommended to utilize a checkpoint model that aligns with its style.
|
||
>
|
||
> 
|
||
>
|
||
> ### Download: 📂[MouthOpen Template](https://github.com/avatechai/avatar-graph-comfyui/blob/main/workflow_templates/MouthOpen_(inpaint).json)
|
||
>
|
||
> ### Inpaint Demonstration
|
||
>
|
||
> https://github.com/avatechai/avatar-graph-comfyui/assets/48451938/ff48c3d9-7292-4505-8993-8f117cee34ff
|
||
>
|
||
> ### Recommend Checkpoint Model List
|
||
>
|
||
> ##### Anime Style SD1.5
|
||
>- https://civitai.com/models/35960/flat-2d-animerge
|
||
>- https://civitai.com/models/24149/mistoonanime
|
||
>- https://civitai.com/models/22364/kizuki-anime-hentai-checkpoint
|
||
>##### Realistic Style SD1.5
|
||
>- https://civitai.com/models/4201/realistic-vision-v51
|
||
>- https://civitai.com/models/49463/am-i-real
|
||
>- https://civitai.com/models/43331/majicmix-realistic
|
||
>
|
||
> </details>
|
||
|
||
# Shape Flow
|
||
|
||
|
||
# Installation
|
||
|
||
1. `cd custom_nodes`
|
||
|
||
2. `git clone https://github.com/avatechgg/avatar-graph-comfyui.git`
|
||
|
||
3. Install deps `cd avatar-graph-comfyui && python -m pip install -r requirements.txt`
|
||
|
||
4. Navigate to in your comfyui installation folder, open `comfyui/main.py` and add the following lines:
|
||
```py
|
||
def prompt_worker(q, server):
|
||
e = execution.PromptExecutor(server)
|
||
|
||
# This is a workaround since using blender as a python module, the bpy module has to be imported after in the custom thread, otherwise it will cause a segfault if imported in the custom nodes.
|
||
|
||
# Add next line
|
||
import global_bpy
|
||
|
||
while True:
|
||
item, item_id = q.get()
|
||
# Add next line
|
||
global_bpy.reset_bpy()
|
||
```
|
||
|
||
5. Restart comfyui
|
||
|
||
6. Run comfyui with enable-cors-header `python main.py --enable-cors-header` or (mac)`python main.py --force-fp16 --enable-cors-header`
|
||
|
||
# Development
|
||
|
||
<details>
|
||
<summary> If you are interested in contributing expand to see development details✨ </summary>
|
||
|
||
|
||
For comfyui frontend extension, frontend js located at `avatar-graph-comfyui/js`
|
||
|
||
Web stack used: [vanjs](https://github.com/vanjs-org/van) [tailwindcss](https://github.com/tailwindlabs/tailwindcss)
|
||
|
||
## Install deps
|
||
|
||
```
|
||
pnpm i
|
||
```
|
||
|
||
Run the dev command to start the tailwindcss watcher
|
||
|
||
```
|
||
pnpm dev
|
||
```
|
||
|
||
For each changes, simply refresh the comfyui page to see the changes.
|
||
|
||
<details>
|
||
<summary>p.s. For tailwind autocomplete, add the following to your vscode settings.json.</summary>
|
||
|
||
```json
|
||
{
|
||
"tailwindCSS.experimental.classRegex": [
|
||
["class\\s?:\\s?([\\s\\S]*)", "(?:\"|')([^\"']*)(?:\"|')"]
|
||
]
|
||
}
|
||
```
|
||
|
||
</details>
|
||
|
||
</details>
|
||
|
||
|