CozyBlanket Network API
Discover how CozyBlanket's network of features work together to streamline your workflow.
CozyBlanket Network Features
CozyBlanket remote network features allow controlling CozyBlanket from desktop DCCs, servers and pipeline tools for integration with existing software.
Make sure you have Network Features enabled in CozyBlanket. Network Features are only available as part of the Standard license.
Download Network Scripts
cozyblanket_network_utils.zipPackage contains:
- ✓ Python Module with CLI
- ✓ Blender Addon (Windows, Mac, Linux)
- ✓ ZBrush Plugin (Windows) Experimental
Software Integration
Command Line Interface
The CLI provides a quick way to interact with CozyBlanket from your terminal or scripts.
python cli.py --help # List all supported commands
python -m cozyblanket.cli --help # If installed via pip Blender Addon
The Blender addon allows seamless integration with CozyBlanket for retopology workflows.
Requires Blender 3.0 or higher.
Installation
Install the addon by going to Edit > Preferences > Add-ons > Install and selecting the cozyblanket_remote_blender.zip file.
Features
- Push one or multiple target objects to CozyBlanket
- Push one or more target objects and an EditMesh to CozyBlanket
- Pull the current CozyBlanket EditMesh to the active object
- Realtime sync of EditMesh and CozyBlanket camera position to Blender
Addon operators are available in the N Panel.
ZBrush Plugin (Experimental)
The experimental ZBrush plugin enables integration with CozyBlanket for sculpting workflows.
Requires Maxon ZBrush 2022 running on Windows.
Installation
Copy the contents of the provided ZBrush folder into: C:/Program Files/Maxon/ZBrush2022/ZStartup/ZPlugs64.
Features
- Push the current SubTool to CozyBlanket
- Pull the CozyBlanket EditMesh to the current SubTool
The tools are available in the ZPlugins > CozyBlanket menu.
Python Module Integration
The included Python module provides a reference implementation of the CozyBlanket network API. It also contains utility functions for directly importing .obj files when building pipeline scripts.
Install the module using pip: pip install cozyblanket
Example Usage
from cozyblanket import CozyBlanketConnection
# Connect to a running instance
CB = CozyBlanketConnection() # Optional device_id argument
CB.connect()
# Close current document and clear scene
CB.document_close()
CB.scene_clear()
# Push new retopology target from OBJ
CB.target_push_obj("target.obj", "named_target")
CB.target_load("named_target")
# Save current mesh to OBJ
CB.editmesh_pull_obj("editmesh.obj")
# Add remote action button
CB.remote_actions_add(
"Example Button",
lambda: print("The user pressed the button!")
)
# Process remote actions
while True:
CB.remote_actions_process()
# Cleanup connection
CB.disconnect() Note: The remote_actions_process() method needs to be called periodically from your client application to handle incoming events.
CozyBlanket
Retopology, UV and Baking
*CozyBlanket requires an in-app purchase to activate. CozyBlanket is available in two editions. Check local pricing inside the CozyBlanket App.