QuiltiX 开源项目使用手册

QuiltiX 开源项目使用手册

QuiltiXQuiltiX is a graphical node editor to edit, and author MaterialX based materials of 3D assets项目地址:https://gitcode.com/gh_mirrors/qu/QuiltiX

1. 项目目录结构及介绍

QuiltiX 是一个基于Python的图形节点编辑器，专为编辑和创建3D资产的MaterialX材质而设计。以下是一般性的目录结构概述及其关键组成部分：

QuiltiX/
├── src
│   ├── QuiltiX          # 核心应用代码，包括UI构建和核心逻辑。
│       └── qx_plugin.py # 插件钩子规范存放地，支持自定义功能扩展。
├── plugins             # 可选，用户或第三方插件目录，通过QUILTIX_PLUGIN_PATHS环境变量指定。
├── examples            # 示例文件或案例，帮助快速理解使用方法。
├── resources           # 静态资源或配置模板，可能包含图标、默认设置等。
├── tests               # 单元测试和集成测试文件。
├── README.md           # 项目简介和快速入门指南。
├── CONTRIBUTING.md     # 对外贡献指南，说明如何参与项目开发。
└── setup.py            # Python包安装脚本。

核心模块主要位于src/QuiltiX中，而qx_plugin.py是实现插件机制的关键，允许开发者在特定生命周期点添加自己的功能。

2. 项目启动文件介绍

QuiltiX 提供了多种启动方式，常规命令行启动可以通过Python直接调用：

python -m QuiltiX

若通过ZIP安装或希望在Houdini环境中运行（利用Hython），则需要确保QuiltiX及其依赖被正确添加到PYTHONPATH中，并执行特定的命令序列来初始化环境并启动应用：

cd QuiltiX_root
set PYTHONPATH=%PYTHONPATH%;/path/to/python/dependencies;/path/to/hython
hython.exe -c "from QuiltiX import quiltix; quiltix.launch()"

这种启动方式特别适用于需要与Houdini的USD和MaterialX集成的场景。

3. 项目的配置文件介绍

QuiltiX自身未明确提及一个固定的“配置文件”。然而，它的运行依赖于一些环境变量进行配置，这些可以视为动态的配置方式：

• PXR_MTLX_PLUGIN_SEARCH_PATHS: 添加节点定义文件的位置，用于扩展MaterialX的支持路径。
• QUILTIX_PLUGIN_PATHS: 指定插件搜索路径，使项目能够加载外部插件。

虽然没有传统的.config或.json等静态配置文件，但通过调整上述环境变量和潜在的.env文件（如果项目实践中采用）来间接配置QuiltiX的行为。为了适应个性化需求，开发者需要手动设置这些环境变量或遵循项目贡献指南中的指导来定制插件和环境配置。

QuiltiXQuiltiX is a graphical node editor to edit, and author MaterialX based materials of 3D assets项目地址:https://gitcode.com/gh_mirrors/qu/QuiltiX