44 lines
3.5 KiB
Markdown
44 lines
3.5 KiB
Markdown
# Asset Processing Utility
|
|
|
|
This tool is designed to streamline and automate the process of converting raw 3D asset source files, such as texture sets and models provided in archive formats (ZIP, RAR, 7z) or folders, into a standardized and organized library format. The primary goal is to reduce manual effort and ensure consistency when preparing assets for use in projects or asset management systems.
|
|
|
|
The core objectives of this tool are to:
|
|
|
|
* **Standardize Asset Output:** Convert diverse source file structures and naming conventions into a consistent, predictable output format.
|
|
* **Automate Repetitive Tasks:** Eliminate the need for manual steps like file classification, image manipulation (resizing, format conversion, channel packing), and metadata creation.
|
|
* **Improve Workflow Efficiency:** Provide multiple interfaces (GUI, CLI, automated monitor) to fit different user needs and integrate into various pipelines.
|
|
* **Facilitate Asset Management:** Generate structured output and metadata that simplifies the process of cataloging and using assets.
|
|
|
|
Key functionalities to achieve these goals include:
|
|
|
|
* **Preset-Driven Processing:** Utilize configurable JSON presets to define rules for handling assets from different sources.
|
|
* **Flexible Input Handling:** Process single files, multiple files within archives, or entire folders.
|
|
* **Automated File Operations:** Perform classification, resizing, format conversion, bit depth handling, and channel merging based on defined rules.
|
|
* **Metadata Generation:** Create a `metadata.json` file for each asset, capturing processing details and asset properties.
|
|
* **Configurable Output Structure:** Allow users to define the directory hierarchy and file naming conventions for the processed assets.
|
|
|
|
This tool offers several interfaces for operation:
|
|
|
|
* **Graphical User Interface (GUI):** An interactive environment for processing assets, managing presets, and configuring settings.
|
|
* **Command-Line Interface (CLI):** Enables batch processing and scripting with options for input, output, preset selection, and parallel execution.
|
|
* **Directory Monitor:** An automated script that watches a specified folder for new archive files and processes them automatically.
|
|
|
|
Additionally, the tool offers optional integration with Blender to automate the creation of PBR node groups and materials from processed assets.
|
|
|
|
Configuration is managed through a central settings file (`config/app_settings.json`) for core application parameters and JSON files in the `presets/` directory for source-specific processing rules.
|
|
|
|
## Documentation
|
|
|
|
For detailed information on installation, configuration, usage of the GUI, CLI, and Directory Monitor, Blender integration, and the structure of the output, please refer to the documentation located in the `Documentation/01_User_Guide/` directory.
|
|
|
|
Key documents include:
|
|
|
|
* [`Introduction`](Documentation/01_User_Guide/01_Introduction.md)
|
|
* [`Installation`](Documentation/01_User_Guide/03_Installation.md)
|
|
* [`Features`](Documentation/01_User_Guide/02_Features.md)
|
|
* [`Configuration and Presets`](Documentation/01_User_Guide/04_Configuration_and_Presets.md)
|
|
* [`Usage: GUI`](Documentation/01_User_Guide/05_Usage_GUI.md)
|
|
* [`Usage: CLI`](Documentation/01_User_Guide/06_Usage_CLI.md)
|
|
* [`Usage: Monitor`](Documentation/01_User_Guide/07_Usage_Monitor.md)
|
|
* [`Usage: Blender Integration`](Documentation/01_User_Guide/08_Usage_Blender.md)
|
|
* [`Output Structure`](Documentation/01_User_Guide/09_Output_Structure.md) |