Instructions to use vidfom/Ltx-3 with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- llama-cpp-python
How to use vidfom/Ltx-3 with llama-cpp-python:
# !pip install llama-cpp-python from llama_cpp import Llama llm = Llama.from_pretrained( repo_id="vidfom/Ltx-3", filename="ComfyUI/models/text_encoders/gemma-3-12b-it-qat-UD-Q4_K_XL.gguf", )
llm.create_chat_completion( messages = "No input example has been defined for this model task." )
- Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- llama.cpp
How to use vidfom/Ltx-3 with llama.cpp:
Install from brew
brew install llama.cpp # Start a local OpenAI-compatible server with a web UI: llama-server -hf vidfom/Ltx-3:UD-Q4_K_XL # Run inference directly in the terminal: llama-cli -hf vidfom/Ltx-3:UD-Q4_K_XL
Install from WinGet (Windows)
winget install llama.cpp # Start a local OpenAI-compatible server with a web UI: llama-server -hf vidfom/Ltx-3:UD-Q4_K_XL # Run inference directly in the terminal: llama-cli -hf vidfom/Ltx-3:UD-Q4_K_XL
Use pre-built binary
# Download pre-built binary from: # https://github.com/ggerganov/llama.cpp/releases # Start a local OpenAI-compatible server with a web UI: ./llama-server -hf vidfom/Ltx-3:UD-Q4_K_XL # Run inference directly in the terminal: ./llama-cli -hf vidfom/Ltx-3:UD-Q4_K_XL
Build from source code
git clone https://github.com/ggerganov/llama.cpp.git cd llama.cpp cmake -B build cmake --build build -j --target llama-server llama-cli # Start a local OpenAI-compatible server with a web UI: ./build/bin/llama-server -hf vidfom/Ltx-3:UD-Q4_K_XL # Run inference directly in the terminal: ./build/bin/llama-cli -hf vidfom/Ltx-3:UD-Q4_K_XL
Use Docker
docker model run hf.co/vidfom/Ltx-3:UD-Q4_K_XL
- LM Studio
- Jan
- Ollama
How to use vidfom/Ltx-3 with Ollama:
ollama run hf.co/vidfom/Ltx-3:UD-Q4_K_XL
- Unsloth Studio
How to use vidfom/Ltx-3 with Unsloth Studio:
Install Unsloth Studio (macOS, Linux, WSL)
curl -fsSL https://unsloth.ai/install.sh | sh # Run unsloth studio unsloth studio -H 0.0.0.0 -p 8888 # Then open http://localhost:8888 in your browser # Search for vidfom/Ltx-3 to start chatting
Install Unsloth Studio (Windows)
irm https://unsloth.ai/install.ps1 | iex # Run unsloth studio unsloth studio -H 0.0.0.0 -p 8888 # Then open http://localhost:8888 in your browser # Search for vidfom/Ltx-3 to start chatting
Using HuggingFace Spaces for Unsloth
# No setup required # Open https://huggingface.co/spaces/unsloth/studio in your browser # Search for vidfom/Ltx-3 to start chatting
- Docker Model Runner
How to use vidfom/Ltx-3 with Docker Model Runner:
docker model run hf.co/vidfom/Ltx-3:UD-Q4_K_XL
- Lemonade
How to use vidfom/Ltx-3 with Lemonade:
Pull the model
# Download Lemonade from https://lemonade-server.ai/ lemonade pull vidfom/Ltx-3:UD-Q4_K_XL
Run and chat with the model
lemonade run user.Ltx-3-UD-Q4_K_XL
List all available models
lemonade list
| from typing_extensions import override | |
| from comfy_api.latest import IO, ComfyExtension, Input | |
| from comfy_api_nodes.apis.tripo import ( | |
| TripoAnimateRetargetRequest, | |
| TripoAnimateRigRequest, | |
| TripoConvertModelRequest, | |
| TripoFileEmptyReference, | |
| TripoFileReference, | |
| TripoImageToModelRequest, | |
| TripoModelVersion, | |
| TripoMultiviewToModelRequest, | |
| TripoOrientation, | |
| TripoRefineModelRequest, | |
| TripoStyle, | |
| TripoTaskResponse, | |
| TripoTaskStatus, | |
| TripoTaskType, | |
| TripoTextToModelRequest, | |
| TripoTextureModelRequest, | |
| TripoUrlReference, | |
| ) | |
| from comfy_api_nodes.util import ( | |
| ApiEndpoint, | |
| download_url_to_file_3d, | |
| poll_op, | |
| sync_op, | |
| upload_images_to_comfyapi, | |
| ) | |
| def get_model_url_from_response(response: TripoTaskResponse) -> str: | |
| if response.data is not None: | |
| for key in ["pbr_model", "model", "base_model"]: | |
| if getattr(response.data.output, key, None) is not None: | |
| return getattr(response.data.output, key) | |
| raise RuntimeError(f"Failed to get model url from response: {response}") | |
| async def poll_until_finished( | |
| node_cls: type[IO.ComfyNode], | |
| response: TripoTaskResponse, | |
| average_duration: int | None = None, | |
| ) -> IO.NodeOutput: | |
| """Polls the Tripo API endpoint until the task reaches a terminal state, then returns the response.""" | |
| if response.code != 0: | |
| raise RuntimeError(f"Failed to generate mesh: {response.error}") | |
| task_id = response.data.task_id | |
| response_poll = await poll_op( | |
| node_cls, | |
| poll_endpoint=ApiEndpoint(path=f"/proxy/tripo/v2/openapi/task/{task_id}"), | |
| response_model=TripoTaskResponse, | |
| completed_statuses=[TripoTaskStatus.SUCCESS], | |
| failed_statuses=[ | |
| TripoTaskStatus.FAILED, | |
| TripoTaskStatus.CANCELLED, | |
| TripoTaskStatus.UNKNOWN, | |
| TripoTaskStatus.BANNED, | |
| TripoTaskStatus.EXPIRED, | |
| ], | |
| status_extractor=lambda x: x.data.status, | |
| progress_extractor=lambda x: x.data.progress, | |
| estimated_duration=average_duration, | |
| ) | |
| if response_poll.data.status == TripoTaskStatus.SUCCESS: | |
| url = get_model_url_from_response(response_poll) | |
| file_glb = await download_url_to_file_3d(url, "glb", task_id=task_id) | |
| return IO.NodeOutput(f"{task_id}.glb", task_id, file_glb) | |
| raise RuntimeError(f"Failed to generate mesh: {response_poll}") | |
| class TripoTextToModelNode(IO.ComfyNode): | |
| """ | |
| Generates 3D models synchronously based on a text prompt using Tripo's API. | |
| """ | |
| def define_schema(cls): | |
| return IO.Schema( | |
| node_id="TripoTextToModelNode", | |
| display_name="Tripo: Text to Model", | |
| category="api node/3d/Tripo", | |
| inputs=[ | |
| IO.String.Input("prompt", multiline=True), | |
| IO.String.Input("negative_prompt", multiline=True, optional=True), | |
| IO.Combo.Input( | |
| "model_version", options=TripoModelVersion, default=TripoModelVersion.v2_5_20250123, optional=True | |
| ), | |
| IO.Combo.Input("style", options=TripoStyle, default="None", optional=True), | |
| IO.Boolean.Input("texture", default=True, optional=True), | |
| IO.Boolean.Input("pbr", default=True, optional=True), | |
| IO.Int.Input("image_seed", default=42, optional=True, advanced=True), | |
| IO.Int.Input("model_seed", default=42, optional=True, advanced=True), | |
| IO.Int.Input("texture_seed", default=42, optional=True, advanced=True), | |
| IO.Combo.Input("texture_quality", default="standard", options=["standard", "detailed"], optional=True, advanced=True), | |
| IO.Int.Input("face_limit", default=-1, min=-1, max=2000000, optional=True, advanced=True), | |
| IO.Boolean.Input("quad", default=False, optional=True, advanced=True), | |
| IO.Combo.Input("geometry_quality", default="standard", options=["standard", "detailed"], optional=True, advanced=True), | |
| ], | |
| outputs=[ | |
| IO.String.Output(display_name="model_file"), # for backward compatibility only | |
| IO.Custom("MODEL_TASK_ID").Output(display_name="model task_id"), | |
| IO.File3DGLB.Output(display_name="GLB"), | |
| ], | |
| hidden=[ | |
| IO.Hidden.auth_token_comfy_org, | |
| IO.Hidden.api_key_comfy_org, | |
| IO.Hidden.unique_id, | |
| ], | |
| is_api_node=True, | |
| is_output_node=True, | |
| price_badge=IO.PriceBadge( | |
| depends_on=IO.PriceBadgeDepends( | |
| widgets=[ | |
| "model_version", | |
| "style", | |
| "texture", | |
| "pbr", | |
| "quad", | |
| "texture_quality", | |
| "geometry_quality", | |
| ], | |
| ), | |
| expr=""" | |
| ( | |
| $isV14 := $contains(widgets.model_version,"v1.4"); | |
| $style := widgets.style; | |
| $hasStyle := ($style != "" and $style != "none"); | |
| $withTexture := widgets.texture or widgets.pbr; | |
| $isHdTexture := (widgets.texture_quality = "detailed"); | |
| $isDetailedGeometry := (widgets.geometry_quality = "detailed"); | |
| $baseCredits := | |
| $isV14 ? 20 : ($withTexture ? 20 : 10); | |
| $credits := | |
| $baseCredits | |
| + ($hasStyle ? 5 : 0) | |
| + (widgets.quad ? 5 : 0) | |
| + ($isHdTexture ? 10 : 0) | |
| + ($isDetailedGeometry ? 20 : 0); | |
| {"type":"usd","usd": $round($credits * 0.01, 2)} | |
| ) | |
| """, | |
| ), | |
| ) | |
| async def execute( | |
| cls, | |
| prompt: str, | |
| negative_prompt: str | None = None, | |
| model_version=None, | |
| style: str | None = None, | |
| texture: bool | None = None, | |
| pbr: bool | None = None, | |
| image_seed: int | None = None, | |
| model_seed: int | None = None, | |
| texture_seed: int | None = None, | |
| texture_quality: str | None = None, | |
| geometry_quality: str | None = None, | |
| face_limit: int | None = None, | |
| quad: bool | None = None, | |
| ) -> IO.NodeOutput: | |
| style_enum = None if style == "None" else style | |
| if not prompt: | |
| raise RuntimeError("Prompt is required") | |
| response = await sync_op( | |
| cls, | |
| endpoint=ApiEndpoint(path="/proxy/tripo/v2/openapi/task", method="POST"), | |
| response_model=TripoTaskResponse, | |
| data=TripoTextToModelRequest( | |
| type=TripoTaskType.TEXT_TO_MODEL, | |
| prompt=prompt, | |
| negative_prompt=negative_prompt if negative_prompt else None, | |
| model_version=model_version, | |
| style=style_enum, | |
| texture=texture, | |
| pbr=pbr, | |
| image_seed=image_seed, | |
| model_seed=model_seed, | |
| texture_seed=texture_seed, | |
| texture_quality=texture_quality, | |
| face_limit=face_limit if face_limit != -1 else None, | |
| geometry_quality=geometry_quality, | |
| auto_size=True, | |
| quad=quad, | |
| ), | |
| ) | |
| return await poll_until_finished(cls, response, average_duration=80) | |
| class TripoImageToModelNode(IO.ComfyNode): | |
| """ | |
| Generates 3D models synchronously based on a single image using Tripo's API. | |
| """ | |
| def define_schema(cls): | |
| return IO.Schema( | |
| node_id="TripoImageToModelNode", | |
| display_name="Tripo: Image to Model", | |
| category="api node/3d/Tripo", | |
| inputs=[ | |
| IO.Image.Input("image"), | |
| IO.Combo.Input( | |
| "model_version", | |
| options=TripoModelVersion, | |
| tooltip="The model version to use for generation", | |
| optional=True, | |
| ), | |
| IO.Combo.Input("style", options=TripoStyle, default="None", optional=True), | |
| IO.Boolean.Input("texture", default=True, optional=True), | |
| IO.Boolean.Input("pbr", default=True, optional=True), | |
| IO.Int.Input("model_seed", default=42, optional=True, advanced=True), | |
| IO.Combo.Input( | |
| "orientation", options=TripoOrientation, default=TripoOrientation.DEFAULT, optional=True, advanced=True | |
| ), | |
| IO.Int.Input("texture_seed", default=42, optional=True, advanced=True), | |
| IO.Combo.Input("texture_quality", default="standard", options=["standard", "detailed"], optional=True, advanced=True), | |
| IO.Combo.Input( | |
| "texture_alignment", default="original_image", options=["original_image", "geometry"], optional=True, advanced=True | |
| ), | |
| IO.Int.Input("face_limit", default=-1, min=-1, max=500000, optional=True, advanced=True), | |
| IO.Boolean.Input("quad", default=False, optional=True, advanced=True), | |
| IO.Combo.Input("geometry_quality", default="standard", options=["standard", "detailed"], optional=True, advanced=True), | |
| ], | |
| outputs=[ | |
| IO.String.Output(display_name="model_file"), # for backward compatibility only | |
| IO.Custom("MODEL_TASK_ID").Output(display_name="model task_id"), | |
| IO.File3DGLB.Output(display_name="GLB"), | |
| ], | |
| hidden=[ | |
| IO.Hidden.auth_token_comfy_org, | |
| IO.Hidden.api_key_comfy_org, | |
| IO.Hidden.unique_id, | |
| ], | |
| is_api_node=True, | |
| is_output_node=True, | |
| price_badge=IO.PriceBadge( | |
| depends_on=IO.PriceBadgeDepends( | |
| widgets=[ | |
| "model_version", | |
| "style", | |
| "texture", | |
| "pbr", | |
| "quad", | |
| "texture_quality", | |
| "geometry_quality", | |
| ], | |
| ), | |
| expr=""" | |
| ( | |
| $isV14 := $contains(widgets.model_version,"v1.4"); | |
| $style := widgets.style; | |
| $hasStyle := ($style != "" and $style != "none"); | |
| $withTexture := widgets.texture or widgets.pbr; | |
| $isHdTexture := (widgets.texture_quality = "detailed"); | |
| $isDetailedGeometry := (widgets.geometry_quality = "detailed"); | |
| $baseCredits := | |
| $isV14 ? 30 : ($withTexture ? 30 : 20); | |
| $credits := | |
| $baseCredits | |
| + ($hasStyle ? 5 : 0) | |
| + (widgets.quad ? 5 : 0) | |
| + ($isHdTexture ? 10 : 0) | |
| + ($isDetailedGeometry ? 20 : 0); | |
| {"type":"usd","usd": $round($credits * 0.01, 2)} | |
| ) | |
| """, | |
| ), | |
| ) | |
| async def execute( | |
| cls, | |
| image: Input.Image, | |
| model_version: str | None = None, | |
| style: str | None = None, | |
| texture: bool | None = None, | |
| pbr: bool | None = None, | |
| model_seed: int | None = None, | |
| orientation=None, | |
| texture_seed: int | None = None, | |
| texture_quality: str | None = None, | |
| geometry_quality: str | None = None, | |
| texture_alignment: str | None = None, | |
| face_limit: int | None = None, | |
| quad: bool | None = None, | |
| ) -> IO.NodeOutput: | |
| style_enum = None if style == "None" else style | |
| if image is None: | |
| raise RuntimeError("Image is required") | |
| tripo_file = TripoFileReference( | |
| root=TripoUrlReference( | |
| url=(await upload_images_to_comfyapi(cls, image, max_images=1))[0], | |
| type="jpeg", | |
| ) | |
| ) | |
| response = await sync_op( | |
| cls, | |
| endpoint=ApiEndpoint(path="/proxy/tripo/v2/openapi/task", method="POST"), | |
| response_model=TripoTaskResponse, | |
| data=TripoImageToModelRequest( | |
| type=TripoTaskType.IMAGE_TO_MODEL, | |
| file=tripo_file, | |
| model_version=model_version, | |
| style=style_enum, | |
| texture=texture, | |
| pbr=pbr, | |
| model_seed=model_seed, | |
| orientation=orientation, | |
| geometry_quality=geometry_quality, | |
| texture_alignment=texture_alignment, | |
| texture_seed=texture_seed, | |
| texture_quality=texture_quality, | |
| face_limit=face_limit if face_limit != -1 else None, | |
| auto_size=True, | |
| quad=quad, | |
| ), | |
| ) | |
| return await poll_until_finished(cls, response, average_duration=80) | |
| class TripoMultiviewToModelNode(IO.ComfyNode): | |
| """ | |
| Generates 3D models synchronously based on up to four images (front, left, back, right) using Tripo's API. | |
| """ | |
| def define_schema(cls): | |
| return IO.Schema( | |
| node_id="TripoMultiviewToModelNode", | |
| display_name="Tripo: Multiview to Model", | |
| category="api node/3d/Tripo", | |
| inputs=[ | |
| IO.Image.Input("image"), | |
| IO.Image.Input("image_left", optional=True), | |
| IO.Image.Input("image_back", optional=True), | |
| IO.Image.Input("image_right", optional=True), | |
| IO.Combo.Input( | |
| "model_version", | |
| options=TripoModelVersion, | |
| optional=True, | |
| tooltip="The model version to use for generation", | |
| ), | |
| IO.Combo.Input( | |
| "orientation", | |
| options=TripoOrientation, | |
| default=TripoOrientation.DEFAULT, | |
| optional=True, | |
| advanced=True, | |
| ), | |
| IO.Boolean.Input("texture", default=True, optional=True), | |
| IO.Boolean.Input("pbr", default=True, optional=True), | |
| IO.Int.Input("model_seed", default=42, optional=True, advanced=True), | |
| IO.Int.Input("texture_seed", default=42, optional=True, advanced=True), | |
| IO.Combo.Input("texture_quality", default="standard", options=["standard", "detailed"], optional=True, advanced=True), | |
| IO.Combo.Input( | |
| "texture_alignment", default="original_image", options=["original_image", "geometry"], optional=True, advanced=True | |
| ), | |
| IO.Int.Input("face_limit", default=-1, min=-1, max=500000, optional=True, advanced=True), | |
| IO.Boolean.Input("quad", default=False, optional=True, advanced=True), | |
| IO.Combo.Input("geometry_quality", default="standard", options=["standard", "detailed"], optional=True, advanced=True), | |
| ], | |
| outputs=[ | |
| IO.String.Output(display_name="model_file"), # for backward compatibility only | |
| IO.Custom("MODEL_TASK_ID").Output(display_name="model task_id"), | |
| IO.File3DGLB.Output(display_name="GLB"), | |
| ], | |
| hidden=[ | |
| IO.Hidden.auth_token_comfy_org, | |
| IO.Hidden.api_key_comfy_org, | |
| IO.Hidden.unique_id, | |
| ], | |
| is_api_node=True, | |
| is_output_node=True, | |
| price_badge=IO.PriceBadge( | |
| depends_on=IO.PriceBadgeDepends( | |
| widgets=[ | |
| "model_version", | |
| "texture", | |
| "pbr", | |
| "quad", | |
| "texture_quality", | |
| "geometry_quality", | |
| ], | |
| ), | |
| expr=""" | |
| ( | |
| $isV14 := $contains(widgets.model_version,"v1.4"); | |
| $withTexture := widgets.texture or widgets.pbr; | |
| $isHdTexture := (widgets.texture_quality = "detailed"); | |
| $isDetailedGeometry := (widgets.geometry_quality = "detailed"); | |
| $baseCredits := | |
| $isV14 ? 30 : ($withTexture ? 30 : 20); | |
| $credits := | |
| $baseCredits | |
| + (widgets.quad ? 5 : 0) | |
| + ($isHdTexture ? 10 : 0) | |
| + ($isDetailedGeometry ? 20 : 0); | |
| {"type":"usd","usd": $round($credits * 0.01, 2)} | |
| ) | |
| """, | |
| ), | |
| ) | |
| async def execute( | |
| cls, | |
| image: Input.Image, | |
| image_left: Input.Image | None = None, | |
| image_back: Input.Image | None = None, | |
| image_right: Input.Image | None = None, | |
| model_version: str | None = None, | |
| orientation: str | None = None, | |
| texture: bool | None = None, | |
| pbr: bool | None = None, | |
| model_seed: int | None = None, | |
| texture_seed: int | None = None, | |
| texture_quality: str | None = None, | |
| geometry_quality: str | None = None, | |
| texture_alignment: str | None = None, | |
| face_limit: int | None = None, | |
| quad: bool | None = None, | |
| ) -> IO.NodeOutput: | |
| if image is None: | |
| raise RuntimeError("front image for multiview is required") | |
| images = [] | |
| image_dict = {"image": image, "image_left": image_left, "image_back": image_back, "image_right": image_right} | |
| if image_left is None and image_back is None and image_right is None: | |
| raise RuntimeError("At least one of left, back, or right image must be provided for multiview") | |
| for image_name in ["image", "image_left", "image_back", "image_right"]: | |
| image_ = image_dict[image_name] | |
| if image_ is not None: | |
| images.append( | |
| TripoFileReference( | |
| root=TripoUrlReference( | |
| url=(await upload_images_to_comfyapi(cls, image_, max_images=1))[0], type="jpeg" | |
| ) | |
| ) | |
| ) | |
| else: | |
| images.append(TripoFileEmptyReference()) | |
| response = await sync_op( | |
| cls, | |
| ApiEndpoint(path="/proxy/tripo/v2/openapi/task", method="POST"), | |
| response_model=TripoTaskResponse, | |
| data=TripoMultiviewToModelRequest( | |
| type=TripoTaskType.MULTIVIEW_TO_MODEL, | |
| files=images, | |
| model_version=model_version, | |
| orientation=orientation, | |
| texture=texture, | |
| pbr=pbr, | |
| model_seed=model_seed, | |
| texture_seed=texture_seed, | |
| texture_quality=texture_quality, | |
| geometry_quality=geometry_quality, | |
| texture_alignment=texture_alignment, | |
| face_limit=face_limit if face_limit != -1 else None, | |
| quad=quad, | |
| ), | |
| ) | |
| return await poll_until_finished(cls, response, average_duration=80) | |
| class TripoTextureNode(IO.ComfyNode): | |
| def define_schema(cls): | |
| return IO.Schema( | |
| node_id="TripoTextureNode", | |
| display_name="Tripo: Texture model", | |
| category="api node/3d/Tripo", | |
| inputs=[ | |
| IO.Custom("MODEL_TASK_ID").Input("model_task_id"), | |
| IO.Boolean.Input("texture", default=True, optional=True), | |
| IO.Boolean.Input("pbr", default=True, optional=True), | |
| IO.Int.Input("texture_seed", default=42, optional=True, advanced=True), | |
| IO.Combo.Input("texture_quality", default="standard", options=["standard", "detailed"], optional=True, advanced=True), | |
| IO.Combo.Input( | |
| "texture_alignment", default="original_image", options=["original_image", "geometry"], optional=True, advanced=True | |
| ), | |
| ], | |
| outputs=[ | |
| IO.String.Output(display_name="model_file"), # for backward compatibility only | |
| IO.Custom("MODEL_TASK_ID").Output(display_name="model task_id"), | |
| IO.File3DGLB.Output(display_name="GLB"), | |
| ], | |
| hidden=[ | |
| IO.Hidden.auth_token_comfy_org, | |
| IO.Hidden.api_key_comfy_org, | |
| IO.Hidden.unique_id, | |
| ], | |
| is_api_node=True, | |
| is_output_node=True, | |
| price_badge=IO.PriceBadge( | |
| depends_on=IO.PriceBadgeDepends(widgets=["texture_quality"]), | |
| expr=""" | |
| ( | |
| $tq := widgets.texture_quality; | |
| {"type":"usd","usd": ($contains($tq,"detailed") ? 0.2 : 0.1)} | |
| ) | |
| """, | |
| ), | |
| ) | |
| async def execute( | |
| cls, | |
| model_task_id, | |
| texture: bool | None = None, | |
| pbr: bool | None = None, | |
| texture_seed: int | None = None, | |
| texture_quality: str | None = None, | |
| texture_alignment: str | None = None, | |
| ) -> IO.NodeOutput: | |
| response = await sync_op( | |
| cls, | |
| endpoint=ApiEndpoint(path="/proxy/tripo/v2/openapi/task", method="POST"), | |
| response_model=TripoTaskResponse, | |
| data=TripoTextureModelRequest( | |
| original_model_task_id=model_task_id, | |
| texture=texture, | |
| pbr=pbr, | |
| texture_seed=texture_seed, | |
| texture_quality=texture_quality, | |
| texture_alignment=texture_alignment, | |
| ), | |
| ) | |
| return await poll_until_finished(cls, response, average_duration=80) | |
| class TripoRefineNode(IO.ComfyNode): | |
| def define_schema(cls): | |
| return IO.Schema( | |
| node_id="TripoRefineNode", | |
| display_name="Tripo: Refine Draft model", | |
| category="api node/3d/Tripo", | |
| description="Refine a draft model created by v1.4 Tripo models only.", | |
| inputs=[ | |
| IO.Custom("MODEL_TASK_ID").Input("model_task_id", tooltip="Must be a v1.4 Tripo model"), | |
| ], | |
| outputs=[ | |
| IO.String.Output(display_name="model_file"), # for backward compatibility only | |
| IO.Custom("MODEL_TASK_ID").Output(display_name="model task_id"), | |
| IO.File3DGLB.Output(display_name="GLB"), | |
| ], | |
| hidden=[ | |
| IO.Hidden.auth_token_comfy_org, | |
| IO.Hidden.api_key_comfy_org, | |
| IO.Hidden.unique_id, | |
| ], | |
| is_api_node=True, | |
| is_output_node=True, | |
| price_badge=IO.PriceBadge( | |
| expr="""{"type":"usd","usd":0.3}""", | |
| ), | |
| ) | |
| async def execute(cls, model_task_id) -> IO.NodeOutput: | |
| response = await sync_op( | |
| cls, | |
| endpoint=ApiEndpoint(path="/proxy/tripo/v2/openapi/task", method="POST"), | |
| response_model=TripoTaskResponse, | |
| data=TripoRefineModelRequest(draft_model_task_id=model_task_id), | |
| ) | |
| return await poll_until_finished(cls, response, average_duration=240) | |
| class TripoRigNode(IO.ComfyNode): | |
| def define_schema(cls): | |
| return IO.Schema( | |
| node_id="TripoRigNode", | |
| display_name="Tripo: Rig model", | |
| category="api node/3d/Tripo", | |
| inputs=[IO.Custom("MODEL_TASK_ID").Input("original_model_task_id")], | |
| outputs=[ | |
| IO.String.Output(display_name="model_file"), # for backward compatibility only | |
| IO.Custom("RIG_TASK_ID").Output(display_name="rig task_id"), | |
| IO.File3DGLB.Output(display_name="GLB"), | |
| ], | |
| hidden=[ | |
| IO.Hidden.auth_token_comfy_org, | |
| IO.Hidden.api_key_comfy_org, | |
| IO.Hidden.unique_id, | |
| ], | |
| is_api_node=True, | |
| is_output_node=True, | |
| price_badge=IO.PriceBadge( | |
| expr="""{"type":"usd","usd":0.25}""", | |
| ), | |
| ) | |
| async def execute(cls, original_model_task_id) -> IO.NodeOutput: | |
| response = await sync_op( | |
| cls, | |
| endpoint=ApiEndpoint(path="/proxy/tripo/v2/openapi/task", method="POST"), | |
| response_model=TripoTaskResponse, | |
| data=TripoAnimateRigRequest(original_model_task_id=original_model_task_id, out_format="glb", spec="tripo"), | |
| ) | |
| return await poll_until_finished(cls, response, average_duration=180) | |
| class TripoRetargetNode(IO.ComfyNode): | |
| def define_schema(cls): | |
| return IO.Schema( | |
| node_id="TripoRetargetNode", | |
| display_name="Tripo: Retarget rigged model", | |
| category="api node/3d/Tripo", | |
| inputs=[ | |
| IO.Custom("RIG_TASK_ID").Input("original_model_task_id"), | |
| IO.Combo.Input( | |
| "animation", | |
| options=[ | |
| "preset:idle", | |
| "preset:walk", | |
| "preset:run", | |
| "preset:dive", | |
| "preset:climb", | |
| "preset:jump", | |
| "preset:slash", | |
| "preset:shoot", | |
| "preset:hurt", | |
| "preset:fall", | |
| "preset:turn", | |
| "preset:quadruped:walk", | |
| "preset:hexapod:walk", | |
| "preset:octopod:walk", | |
| "preset:serpentine:march", | |
| "preset:aquatic:march" | |
| ], | |
| ), | |
| ], | |
| outputs=[ | |
| IO.String.Output(display_name="model_file"), # for backward compatibility only | |
| IO.Custom("RETARGET_TASK_ID").Output(display_name="retarget task_id"), | |
| IO.File3DGLB.Output(display_name="GLB"), | |
| ], | |
| hidden=[ | |
| IO.Hidden.auth_token_comfy_org, | |
| IO.Hidden.api_key_comfy_org, | |
| IO.Hidden.unique_id, | |
| ], | |
| is_api_node=True, | |
| is_output_node=True, | |
| price_badge=IO.PriceBadge( | |
| expr="""{"type":"usd","usd":0.1}""", | |
| ), | |
| ) | |
| async def execute(cls, original_model_task_id, animation: str) -> IO.NodeOutput: | |
| response = await sync_op( | |
| cls, | |
| endpoint=ApiEndpoint(path="/proxy/tripo/v2/openapi/task", method="POST"), | |
| response_model=TripoTaskResponse, | |
| data=TripoAnimateRetargetRequest( | |
| original_model_task_id=original_model_task_id, | |
| animation=animation, | |
| out_format="glb", | |
| bake_animation=True, | |
| ), | |
| ) | |
| return await poll_until_finished(cls, response, average_duration=30) | |
| class TripoConversionNode(IO.ComfyNode): | |
| def define_schema(cls): | |
| return IO.Schema( | |
| node_id="TripoConversionNode", | |
| display_name="Tripo: Convert model", | |
| category="api node/3d/Tripo", | |
| inputs=[ | |
| IO.Custom("MODEL_TASK_ID,RIG_TASK_ID,RETARGET_TASK_ID").Input("original_model_task_id"), | |
| IO.Combo.Input("format", options=["GLTF", "USDZ", "FBX", "OBJ", "STL", "3MF"]), | |
| IO.Boolean.Input("quad", default=False, optional=True, advanced=True), | |
| IO.Int.Input( | |
| "face_limit", | |
| default=-1, | |
| min=-1, | |
| max=2000000, | |
| optional=True, | |
| advanced=True, | |
| ), | |
| IO.Int.Input( | |
| "texture_size", | |
| default=4096, | |
| min=128, | |
| max=4096, | |
| optional=True, | |
| advanced=True, | |
| ), | |
| IO.Combo.Input( | |
| "texture_format", | |
| options=["BMP", "DPX", "HDR", "JPEG", "OPEN_EXR", "PNG", "TARGA", "TIFF", "WEBP"], | |
| default="JPEG", | |
| optional=True, | |
| advanced=True, | |
| ), | |
| IO.Boolean.Input("force_symmetry", default=False, optional=True, advanced=True), | |
| IO.Boolean.Input("flatten_bottom", default=False, optional=True, advanced=True), | |
| IO.Float.Input( | |
| "flatten_bottom_threshold", | |
| default=0.0, | |
| min=0.0, | |
| max=1.0, | |
| optional=True, | |
| advanced=True, | |
| ), | |
| IO.Boolean.Input("pivot_to_center_bottom", default=False, optional=True, advanced=True), | |
| IO.Float.Input( | |
| "scale_factor", | |
| default=1.0, | |
| min=0.0, | |
| optional=True, | |
| advanced=True, | |
| ), | |
| IO.Boolean.Input("with_animation", default=False, optional=True, advanced=True), | |
| IO.Boolean.Input("pack_uv", default=False, optional=True, advanced=True), | |
| IO.Boolean.Input("bake", default=False, optional=True, advanced=True), | |
| IO.String.Input("part_names", default="", optional=True, advanced=True), # comma-separated list | |
| IO.Combo.Input( | |
| "fbx_preset", | |
| options=["blender", "mixamo", "3dsmax"], | |
| default="blender", | |
| optional=True, | |
| advanced=True, | |
| ), | |
| IO.Boolean.Input("export_vertex_colors", default=False, optional=True, advanced=True), | |
| IO.Combo.Input( | |
| "export_orientation", | |
| options=["align_image", "default"], | |
| default="default", | |
| optional=True, | |
| advanced=True, | |
| ), | |
| IO.Boolean.Input("animate_in_place", default=False, optional=True, advanced=True), | |
| ], | |
| outputs=[], | |
| hidden=[ | |
| IO.Hidden.auth_token_comfy_org, | |
| IO.Hidden.api_key_comfy_org, | |
| IO.Hidden.unique_id, | |
| ], | |
| is_api_node=True, | |
| is_output_node=True, | |
| price_badge=IO.PriceBadge( | |
| depends_on=IO.PriceBadgeDepends( | |
| widgets=[ | |
| "quad", | |
| "face_limit", | |
| "texture_size", | |
| "texture_format", | |
| "force_symmetry", | |
| "flatten_bottom", | |
| "flatten_bottom_threshold", | |
| "pivot_to_center_bottom", | |
| "scale_factor", | |
| "with_animation", | |
| "pack_uv", | |
| "bake", | |
| "part_names", | |
| "fbx_preset", | |
| "export_vertex_colors", | |
| "export_orientation", | |
| "animate_in_place", | |
| ], | |
| ), | |
| expr=""" | |
| ( | |
| $face := (widgets.face_limit != null) ? widgets.face_limit : -1; | |
| $texSize := (widgets.texture_size != null) ? widgets.texture_size : 4096; | |
| $flatThresh := (widgets.flatten_bottom_threshold != null) ? widgets.flatten_bottom_threshold : 0; | |
| $scale := (widgets.scale_factor != null) ? widgets.scale_factor : 1; | |
| $texFmt := (widgets.texture_format != "" ? widgets.texture_format : "jpeg"); | |
| $part := widgets.part_names; | |
| $fbx := (widgets.fbx_preset != "" ? widgets.fbx_preset : "blender"); | |
| $orient := (widgets.export_orientation != "" ? widgets.export_orientation : "default"); | |
| $advanced := | |
| widgets.quad or | |
| widgets.force_symmetry or | |
| widgets.flatten_bottom or | |
| widgets.pivot_to_center_bottom or | |
| widgets.with_animation or | |
| widgets.pack_uv or | |
| widgets.bake or | |
| widgets.export_vertex_colors or | |
| widgets.animate_in_place or | |
| ($face != -1) or | |
| ($texSize != 4096) or | |
| ($flatThresh != 0) or | |
| ($scale != 1) or | |
| ($texFmt != "jpeg") or | |
| ($part != "") or | |
| ($fbx != "blender") or | |
| ($orient != "default"); | |
| {"type":"usd","usd": ($advanced ? 0.1 : 0.05)} | |
| ) | |
| """, | |
| ), | |
| ) | |
| def validate_inputs(cls, input_types): | |
| # The min and max of input1 and input2 are still validated because | |
| # we didn't take `input1` or `input2` as arguments | |
| if input_types["original_model_task_id"] not in ("MODEL_TASK_ID", "RIG_TASK_ID", "RETARGET_TASK_ID"): | |
| return "original_model_task_id must be MODEL_TASK_ID, RIG_TASK_ID or RETARGET_TASK_ID type" | |
| return True | |
| async def execute( | |
| cls, | |
| original_model_task_id, | |
| format: str, | |
| quad: bool, | |
| force_symmetry: bool, | |
| face_limit: int, | |
| flatten_bottom: bool, | |
| flatten_bottom_threshold: float, | |
| texture_size: int, | |
| texture_format: str, | |
| pivot_to_center_bottom: bool, | |
| scale_factor: float, | |
| with_animation: bool, | |
| pack_uv: bool, | |
| bake: bool, | |
| part_names: str, | |
| fbx_preset: str, | |
| export_vertex_colors: bool, | |
| export_orientation: str, | |
| animate_in_place: bool, | |
| ) -> IO.NodeOutput: | |
| if not original_model_task_id: | |
| raise RuntimeError("original_model_task_id is required") | |
| # Parse part_names from comma-separated string to list | |
| part_names_list = None | |
| if part_names and part_names.strip(): | |
| part_names_list = [name.strip() for name in part_names.split(',') if name.strip()] | |
| response = await sync_op( | |
| cls, | |
| endpoint=ApiEndpoint(path="/proxy/tripo/v2/openapi/task", method="POST"), | |
| response_model=TripoTaskResponse, | |
| data=TripoConvertModelRequest( | |
| original_model_task_id=original_model_task_id, | |
| format=format, | |
| quad=quad if quad else None, | |
| force_symmetry=force_symmetry if force_symmetry else None, | |
| face_limit=face_limit if face_limit != -1 else None, | |
| flatten_bottom=flatten_bottom if flatten_bottom else None, | |
| flatten_bottom_threshold=flatten_bottom_threshold if flatten_bottom_threshold != 0.0 else None, | |
| texture_size=texture_size if texture_size != 4096 else None, | |
| texture_format=texture_format if texture_format != "JPEG" else None, | |
| pivot_to_center_bottom=pivot_to_center_bottom if pivot_to_center_bottom else None, | |
| scale_factor=scale_factor if scale_factor != 1.0 else None, | |
| with_animation=with_animation if with_animation else None, | |
| pack_uv=pack_uv if pack_uv else None, | |
| bake=bake if bake else None, | |
| part_names=part_names_list, | |
| fbx_preset=fbx_preset if fbx_preset != "blender" else None, | |
| export_vertex_colors=export_vertex_colors if export_vertex_colors else None, | |
| export_orientation=export_orientation if export_orientation != "default" else None, | |
| animate_in_place=animate_in_place if animate_in_place else None, | |
| ), | |
| ) | |
| return await poll_until_finished(cls, response, average_duration=30) | |
| class TripoExtension(ComfyExtension): | |
| async def get_node_list(self) -> list[type[IO.ComfyNode]]: | |
| return [ | |
| TripoTextToModelNode, | |
| TripoImageToModelNode, | |
| TripoMultiviewToModelNode, | |
| TripoTextureNode, | |
| TripoRefineNode, | |
| TripoRigNode, | |
| TripoRetargetNode, | |
| TripoConversionNode, | |
| ] | |
| async def comfy_entrypoint() -> TripoExtension: | |
| return TripoExtension() | |