{"id":26591597,"url":"https://github.com/prismpipeline/quiltix","last_synced_at":"2025-04-06T16:10:20.888Z","repository":{"id":185615902,"uuid":"672514193","full_name":"PrismPipeline/QuiltiX","owner":"PrismPipeline","description":"QuiltiX is a graphical node editor to edit, and author MaterialX based materials of 3D assets","archived":false,"fork":false,"pushed_at":"2024-04-20T17:04:26.000Z","size":34588,"stargazers_count":235,"open_issues_count":19,"forks_count":25,"subscribers_count":9,"default_branch":"main","last_synced_at":"2024-05-21T00:55:04.281Z","etag":null,"topics":["3d","3d-graphics","materialx","nodegraph","openusd","pyside","python","qt","real-time-rendering","rendering","rendering-3d-graphics","universal-scene-description","usd","vfx"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/QuiltiX","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PrismPipeline.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-30T10:51:08.000Z","updated_at":"2024-05-28T20:41:26.119Z","dependencies_parsed_at":"2024-04-20T17:48:42.999Z","dependency_job_id":null,"html_url":"https://github.com/PrismPipeline/QuiltiX","commit_stats":null,"previous_names":["prismpipeline/quiltix"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrismPipeline%2FQuiltiX","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrismPipeline%2FQuiltiX/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrismPipeline%2FQuiltiX/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrismPipeline%2FQuiltiX/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PrismPipeline","download_url":"https://codeload.github.com/PrismPipeline/QuiltiX/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247509221,"owners_count":20950232,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["3d","3d-graphics","materialx","nodegraph","openusd","pyside","python","qt","real-time-rendering","rendering","rendering-3d-graphics","universal-scene-description","usd","vfx"],"created_at":"2025-03-23T14:18:41.861Z","updated_at":"2025-04-06T16:10:20.863Z","avatar_url":"https://github.com/PrismPipeline.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/PrismPipeline/QuiltiX/main/media/quiltix-logo-full.svg\" height=\"170\"\u003e\n  \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/PrismPipeline/QuiltiX/main/media/quiltix-logo-full-light-mode.svg\" height=\"200\"\u003e\n  \u003cimg alt=\"QuiltiX\" src=\"https://raw.githubusercontent.com/PrismPipeline/QuiltiX/main/media/quiltix-logo-full-light-mode.svg\"\u003e\n\u003c/picture\u003e\u003c/p\u003e\n\n----  \n\n\u003cdiv align=\"center\"\u003e\n\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/PrismPipeline/QuiltiX/LICENSE)\n[![Version](https://img.shields.io/github/v/release/PrismPipeline/QuiltiX)](https://github.com/PrismPipeline/QuiltiX/releases/latest)\n\u003c/div\u003e\n\nQuiltiX is a graphical node editor to edit, and author [MaterialX](https://materialx.org/) based materials of 3D assets. It includes a viewport based on [OpenUSD](https://www.openusd.org/release/index.html)'s [Hydra](https://openusd.org/release/glossary.html#hydra), which enables viewing your assets in any renderer supporting both Hydra \u0026 MaterialX.\n\n\u003cimg align=\"center\" padding=5 src=\"https://raw.githubusercontent.com/PrismPipeline/QuiltiX/main/media/QuiltiX.png\"\u003e \n\n## Table of Contents  \u003c!-- omit from toc --\u003e\n\n- [Requirements](#requirements)\n- [Installation](#installation)\n  - [From PyPi](#from-pypi)\n  - [From Zip](#from-zip)\n  - [From Source](#from-source)\n- [Running QuiltiX](#running-quiltix)\n  - [Running QuiltiX using hython](#running-quiltix-using-hython)\n- [QuiltiX Plugins](#quiltix-plugins)\n  - [Creating a QuiltiX plugin](#creating-a-quiltix-plugin)\n  - [QuiltiX Plugin hooks](#quiltix-plugin-hooks)\n- [Integrating with your environment](#integrating-with-your-environment)\n  - [Using your own compiled OpenUSD](#using-your-own-compiled-openusd)\n  - [Adding Hydra delegates](#adding-hydra-delegates)\n    - [Arnold](#arnold)\n    - [Karma](#karma)\n  - [Adding custom MaterialX Node definitions](#adding-custom-materialx-node-definitions)\n- [Platform support](#platform-support)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Requirements\nQuiltiX requires Python 3.11+ as well as compiled versions of USD and MaterialX.\n\n## Installation\n### From PyPi\n\n```shell\npip install QuiltiX\n```\n\nIf you additionally require pre-built binaries for MaterialX \u0026 USD we currently provide these for Windows.\nOn Linux/Mac you need to provide your own binaries for now. Here are linked instructions for [MaterialX](https://github.com/AcademySoftwareFoundation/MaterialX/tree/main#quick-start-for-developers) \u0026 [OpenUSD](https://github.com/PixarAnimationStudios/OpenUSD/blob/release/BUILDING.md)\n```shell\npip install QuiltiX\npip install git+https://github.com/PrismPipeline/OpenUSD_build.git@24.03-win-mtlx-1.38.9\n```\n\n### From Zip\nFor Windows a zip containing QuiltiX and all required dependencies can be downloaded from [here](https://prism-pipeline.com/quiltix/).  \nJust extract and execute the `QuiltiX.bat`\n\n### From Source\n1) Clone the repository\n\n```\ngit clone https://github.com/PrismPipeline/QuiltiX.git\ncd QuiltiX\n```\n\n2) Install the dependencies\n\nThis will install the base python dependencies, excluding any development dependencies, MaterialX \u0026 USD\n\n```\npip install . \n```\n\n\u003cdetails\u003e\n  \u003csummary\u003eAdditional install options\u003c/summary\u003e\n\nIf you want want to contribute it is recommended to install QuiltiX in [development/editable mode](https://setuptools.pypa.io/en/latest/userguide/development_mode.html).  \nIt is also recommended to also install QuiltiX's dev dependencies.\n```\npip install -e .[dev]\n```\n\nFor more information see [pyproject.toml](pyproject.toml)\n\u003c/details\u003e\n\n\n## Running QuiltiX\n\n```\npython -m QuiltiX\n```\n\nOr if you installed QuiltiX via zip you can execute the `QuiltiX.bat` after extracting.\n\n### Running QuiltiX using hython\n\nQuiltiX can be run from `hython`, which is Houdini's python executable. This way you can use Houdini's built USD and MaterialX and don't have to worry about providing your own.  \nYou will also be able to use Render delegates for Houdini like Karma. Read more in the [Karma](#karma) section.\n\n\u003cdetails\u003e\n  \u003csummary\u003eHython instructions\u003c/summary\u003e\n\nYou will still need some additional libraries required by QuiltiX, so it is still necessary to install the dependencies mentioned in [Installation](#installation).  \nYou can then execute QuiltiX while making sure that both QuiltiX and its python dependencies are in the `PYTHONPATH` environmenv variable:\n```shell\ncd QuiltiX_root\nset PYTHONPATH=%PYTHONPATH%;./src;/path/to/python/dependencies\n/path/to/hython.exe -c \"from QuiltiX import quiltix;quiltix.launch()\"\n```\n\nOr if you have a virtual environment\n```shell\ncd QuiltiX_root\n/path/to/venv/Scripts/activate\nset PYTHONPATH=%PYTHONPATH%;%VIRTUAL_ENV%/Lib/site-packages;./src\n/path/to/hython.exe -c \"from QuiltiX import quiltix;quiltix.launch()\"\n```\n\u003e Note that currently both the Storm as well as HoudiniGL render delegates do not seem to work in QuiltiX when being launched from hython.\n\u003c/details\u003e\n\n## QuiltiX Plugins\n\nQuiltiX supports adding Plugins via the environment variable `QUILTIX_PLUGIN_PATHS`. We are using [pluggy](https://pluggy.readthedocs.io/en/stable/) in the backend to load them.\n\n### Creating a QuiltiX plugin\nTo create a QuiltiX plugin you need to create a `plugin.py` file. In this file you need implement one or multiple `hooks` that QuiltiX provides. Example:\n\n```python\n@qx_plugin.hookimpl\ndef after_ui_init(editor: \"quiltix.QuiltiXWindow\"):\n    # I am printing the QuiltiXWindow\n    print(editor)\n```\n\nYou also need to implement a `plugin_name` function returning the name of your plugin. Example:\n```python\ndef plugin_name() -\u003e str:\n    return \"QuiltiXWindow printer\"\n```\n\nIf your plugin has the possibility to not be valid (due to missing dependencies or similar) you can implement a `is_valid` function returning `False` to avoid it loading entirely. Example:\n```python\ndef is_valid() -\u003e bool:\n    if 1==1:\n      return False\n    else:\n      return True\n  ```\n\nFor further reference please take a look at the `sample_plugins` dir and the tests in `tests/test_plugins.py`\n\n### QuiltiX Plugin hooks\nThese are the hooks that are currently supported, but there is no harm in adding more. If you would like to add hooks in other parts of QuiltiX to support your features, please open an Issue/PR. \nThe hook specifications live in `src/QuiltiX/qx_plugin.py`\n| hook | Purpose |\n|-|-|\n| before_ui_init | Building UI funcionality on top of the QuiltiX UI |\n| after_ui_init | Adjusting parts of the internals before the QuiltiX UI startup |\n| before_mx_import | Adjusting things like environment variables before MaterialX gets initialized |\n| after_mx_import | Adjusting MaterialX specific functionality right after it gets imported |\n| before_pxr_import | Adjusting things like environment variables before pxr (OpenUSD) gets initialized |\n| after_pxr_import | Adjusting pxr (OpenUSD) specific functionality right after it gets imported |\n\n\n## Integrating with your environment\nQuiltiX tries to rely as much as possible on pre-existing environment variables from MaterialX/USD to extend its systems.\n\nOverview over the most important Environment Variables:\n| Environment Variable | Purpose | Variable Type | Example |\n|-|-|-|-|\n| PXR_PLUGINPATH_NAME | Paths to Hydra delegate plugins | Paths | |\n| PXR_MTLX_STDLIB_SEARCH_PATHS | Paths to standard MaterialX node definition locations | Paths | |\n| PXR_MTLX_PLUGIN_SEARCH_PATHS | Paths to custom MaterialX node definition locations | Paths | |\n| HD_DEFAULT_RENDERER | Name of the default Hydra delegate for the viewport | String | GL |\n\n### Using your own compiled OpenUSD\n\nTo be able to use your own version of OpenUSD for QuiltiX instead of relying on our [provided version](https://github.com/PrismPipeline/OpenUSD_build), you will need to provide some environment variables. Make sure that you append to them!  \nEssentially you need to add all `.dll`s to `PATH` and the `pxr` python library to `PYTHONPATH`.\n\n| Environment Variable | Path relative to compiled ${USD_ROOT} |\n|-|-|\n| PATH | ${USD_ROOT}/bin | \n| PATH | ${USD_ROOT}/lib | \n| PYTHONPATH | ${USD_ROOT}/lib/python |\n\n\n### Adding [Hydra delegates](https://openusd.org/release/glossary.html#hydra)\n\u003e **_NOTE_**  \n\u003e The Hydra renderer needs to support MaterialX for it to work in QuiltiX.  \n\n\n**_What is a Hdyra Delegate?_**  \n\"Hydra Render Delegates are bridges between the Hydra viewport and a renderer. [...] The Hydra Render Delegate system allows the ability to switch out the backend renderer for the viewport data in Hydra. [...]\"\u003csup\u003e[[src]](https://learn.foundry.com/katana/dev-guide/Plugins/HydraRenderDelegates/Introduction.html#what-is-a-hydra-render-delegate)\u003c/sup\u003e\n\nThe [Storm Hydra Delegate](https://openusd.org/dev/api/hd_storm_page_front.html) by Pixar is both shipped with USD and enabled per default in QuiltiX. \n\n\u003e Adding additional Hydra delegates can, depending on the renderer, be a non-trivial task due to the need of matching USD (and potentially MaterialX) versions for the compiled binaries. Some renderers also need additional configuration for additional features like renderer specific procedurals or shaders.\n\nTo register a Hydra renderer plugin the Hydra plugin directory of the renderer needs to be added to the `PXR_PLUGINPATH_NAME` environment variable. Generally renderers also need their binaries added to the `PATH` environment variable, but there might be additional variables for licensing or additional features.  \n\nBelow is a non-exhaustive list of install instructions for Hydra renderers.\n\n#### Arnold\n\nTo use Arnold in QuiltiX you need the following:\n* Arnold SDK\n* A compiled version of [arnold-usd](https://github.com/Autodesk/arnold-usd)\n\n\n\u003cdetails\u003e\n  \u003csummary\u003eFull Arnold install instructions\u003c/summary\u003e\n\nArnold SDK download instructions can be found [here](https://help.autodesk.com/view/ARNOL/ENU/?guid=arnold_user_guide_ac_download_arnold_html#download-arnold-sdk).\nTo install arnold-usd one can build from source [here](https://github.com/Autodesk/arnold-usd).\n\nFor Windows you can find a compiled version of `hdArnold` and the Arnold SDK [here](https://github.com/PrismPipeline/arnold-usd/releases/tag/v7.2.5.2) with [install instructions](https://github.com/PrismPipeline/arnold-usd/blob/0d97fa0af15600217036e32985ee0b7fe7a34051/README.md).  \n\u003e This plugin can be used in USD applications, like QuiltiX, to add the Arnold Hydra delegate.\n\u003e \n\u003e Download and extract the archive and then add the following paths to the environment:  \n\u003e `Arnold/hdArnold/plugin` to `PXR_PLUGINPATH_NAME`  \n\u003e `Arnold/Arnold-7.2.5.2-windows/bin` to `PATH`  \n\n\u003c/details\u003e\n\n#### Karma\nTo run Karma you need to execute QuiltiX from hython. See [here](#running-quiltix-using-hython) for more information.\n\nIt is possible to use additional Hydra delegates, which are available in the Houdini environment.\n\n#### Changing the active Hydra delegate \u003c!-- omit from toc --\u003e\nThe default Hydra delegate can be changed by setting the `HD_DEFAULT_RENDERER` environment variable to the preferred renderer.\n\n```shell\nset HD_DEFAULT_RENDERER=\"GL\"\n```\n\nAfter opening QuiltiX the active Hydra delegate can be changed in the \"View\" -\u003e \"Set Renderer\" menu.\n\n\n\n### Adding custom MaterialX Node definitions\n\nTo add custom MaterialX node defintions they can be added by adding the location of the node definition files to the `PXR_MTLX_PLUGIN_SEARCH_PATHS` environment variable.\n\n## Platform support\nQuiltiX has been developed with all platforms in mind, but has been developed on Windows. If you see any issues on another platform please open up an issue.\n\n## Contributing\n\nWe welcome contributions to the QuiltiX! If you'd like to contribute, please follow these steps:\n\n1. Fork the repository.\n2. Create a feature branch.\n3. Commit your changes.\n4. Submit a pull request.\n\n## License\n\nQuiltiX is licensed under the Apache License. See [LICENSE](LICENSE) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprismpipeline%2Fquiltix","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprismpipeline%2Fquiltix","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprismpipeline%2Fquiltix/lists"}