Skip to content

Commit 8b40aa0

Browse files
committed
Update documentation: sync material settings terminology and other improvements
1 parent 746419b commit 8b40aa0

13 files changed

+86
-60
lines changed

docs/compatibility_and_workarounds.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This document covers assets that work well with the glTF/GLB Importer for Maya a
66

77
---
88

9-
## What Works Well
9+
## What Works Well
1010

1111
- **Khronos Sample Assets**: Most sample assets from the official [Khronos glTF Sample Assets repository](https://github.com/KhronosGroup/glTF-Sample-Assets) import properly without any issues when testing the plugin
1212
- **Standard glTF 2.0 Assets**: Files exported using proper glTF exporters that follow Khronos specifications
@@ -19,7 +19,7 @@ This document covers assets that work well with the glTF/GLB Importer for Maya a
1919

2020
---
2121

22-
## 💡 Recommended Workarounds
22+
## Recommended Workarounds
2323

2424
### For Sketchfab Assets with Rigged Animations
2525
To properly import Sketchfab assets with rigged animations, use this Blender preprocessing workflow:
@@ -55,7 +55,7 @@ To properly import Sketchfab assets with rigged animations, use this Blender pre
5555

5656
---
5757

58-
## 🔄 Round-trip Workflow: Re-exporting Imported Assets
58+
## Round-trip Workflow: Re-exporting Imported Assets
5959

6060
When importing glTF/GLB files and then wanting to export them again using the Babylon exporter, several compatibility issues arise:
6161

@@ -103,7 +103,7 @@ If your asset has animation clips and you need to re-export, follow these steps:
103103
104104
---
105105

106-
## 🔧 Troubleshooting Tips
106+
## Troubleshooting Tips
107107

108108
### Asset Source Recommendations
109109
- **Recommended**: Use assets from the [Khronos Sample Assets repository](https://github.com/KhronosGroup/glTF-Sample-Assets) for testing
@@ -119,7 +119,7 @@ If your asset has animation clips and you need to re-export, follow these steps:
119119

120120
---
121121

122-
## 📚 Additional Resources
122+
## Additional Resources
123123

124124
- [Khronos glTF Sample Assets](https://github.com/KhronosGroup/glTF-Sample-Assets) - Official test assets
125125
- [glTF Validator](https://github.khronos.org/glTF-Validator/) - Online validation tool

docs/dependencies_installation.md

Lines changed: 43 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This guide will help you install the required dependencies for the glTF/GLB impo
44

55
---
66

7-
## 📋 System Requirements
7+
## System Requirements
88

99
| Requirement | Details |
1010
|-------------|---------|
@@ -14,26 +14,27 @@ This guide will help you install the required dependencies for the glTF/GLB impo
1414

1515
---
1616

17-
## 📦 Required Dependencies
17+
## Required Dependencies
1818

1919
The plugin requires the following Python packages:
2020

2121
- **[pygltflib](https://pypi.org/project/pygltflib/)** - Core library for glTF/GLB file handling
22+
- **[DracoPy](https://pypi.org/project/DracoPy/)** - Required for Draco mesh compression support
2223
- **[numpy](https://pypi.org/project/numpy/)** - Required for Maya 2024 and earlier versions only
2324

24-
> **Note:** Maya 2025+ includes numpy by default, so you only need to install pygltflib.
25+
> **Note:** Maya 2025+ includes numpy by default, so you only need to install pygltflib and DracoPy.
2526
2627
---
2728

28-
## 🚀 Installation Instructions
29+
## Installation Instructions
2930

3031
### Before You Start
3132

32-
⚠️ **Important:** Close all instances of Maya before proceeding with the installation.
33+
**Important:** Close all instances of Maya before proceeding with the installation.
3334

3435
---
3536

36-
### 🪟 Windows Installation
37+
### Windows Installation
3738

3839
1. **Open Command Prompt as Administrator**
3940
- Press `Win + X` and select "Command Prompt (Admin)" or "Windows PowerShell (Admin)"
@@ -53,14 +54,19 @@ The plugin requires the following Python packages:
5354
mayapy -m pip install pygltflib
5455
```
5556

56-
4. **Install numpy (Maya 2024 and earlier only)**
57+
4. **Install DracoPy**
58+
```
59+
mayapy -m pip install DracoPy
60+
```
61+
62+
5. **Install numpy (Maya 2024 and earlier only)**
5763
```
5864
mayapy -m pip install numpy
5965
```
6066

6167
---
6268

63-
### 🍎 macOS Installation
69+
### macOS Installation
6470

6571
1. **Open Terminal**
6672
- Press `Cmd + Space`, type "Terminal", and press Enter
@@ -80,14 +86,19 @@ The plugin requires the following Python packages:
8086
./mayapy -m pip install pygltflib
8187
```
8288

83-
4. **Install numpy (Maya 2024 and earlier only)**
89+
4. **Install DracoPy**
90+
```
91+
./mayapy -m pip install DracoPy
92+
```
93+
94+
5. **Install numpy (Maya 2024 and earlier only)**
8495
```
8596
./mayapy -m pip install numpy
8697
```
8798

8899
---
89100

90-
### 🐧 Linux Installation
101+
### Linux Installation
91102

92103
1. **Open Terminal**
93104
- Use your preferred method to open a terminal
@@ -107,14 +118,19 @@ The plugin requires the following Python packages:
107118
sudo ./mayapy -m pip install pygltflib
108119
```
109120

110-
4. **Install numpy (Maya 2024 and earlier only)**
121+
4. **Install DracoPy (may require sudo)**
122+
```
123+
sudo ./mayapy -m pip install DracoPy
124+
```
125+
126+
5. **Install numpy (Maya 2024 and earlier only)**
111127
```
112128
sudo ./mayapy -m pip install numpy
113129
```
114130

115131
---
116132

117-
## Verifying Installation
133+
## Verifying Installation
118134

119135
After installation, you can verify that the dependencies are properly installed:
120136

@@ -124,26 +140,33 @@ After installation, you can verify that the dependencies are properly installed:
124140
```python
125141
try:
126142
import pygltflib
127-
print("✅ pygltflib successfully imported")
143+
print("[SUCCESS] pygltflib successfully imported")
144+
except ImportError:
145+
print("[ERROR] pygltflib not found")
146+
147+
try:
148+
import DracoPy
149+
print("[SUCCESS] DracoPy successfully imported")
128150
except ImportError:
129-
print("❌ pygltflib not found")
151+
print("[ERROR] DracoPy not found")
130152

131153
try:
132154
import numpy
133-
print(" numpy successfully imported")
155+
print("[SUCCESS] numpy successfully imported")
134156
except ImportError:
135-
print(" numpy not found")
157+
print("[ERROR] numpy not found")
136158
```
137-
You should see the following two lines in the script editor's output:
159+
You should see the following three lines in the script editor's output:
138160
```
139-
✅ pygltflib successfully imported
140-
✅ numpy successfully imported
161+
[SUCCESS] pygltflib successfully imported
162+
[SUCCESS] DracoPy successfully imported
163+
[SUCCESS] numpy successfully imported
141164
```
142165

143166
---
144167

145168

146-
## 🔧 Troubleshooting
169+
## Troubleshooting
147170

148171
### Common Issues
149172

docs/file_type_specific_options.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@ The right side of the import dialog contains various import settings organized i
66

77
## File Type Specific Options
88

9-
### 🎨 Material Settings
9+
### Material Settings
1010

1111
- **Shader Type**: Set to **"Standard Surface"** (default)
1212
- **Shading Option**: Set to **"Use Normal Data"** (default)
1313

1414
---
1515

16-
### 📐 Geometry Options
16+
### Geometry Options
1717

1818
- **No merging**: Keeps geometry separate (default option)
1919
- **Merge Vertices**: Combines duplicate vertices
2020

2121
---
2222

23-
### 🖼️ Image Extraction
23+
### Image Extraction
2424

2525
- **Use Relative Path**: Extracts images using relative path
2626
- **Default Location**: Images will be extracted to the project directory/source images by default
@@ -31,31 +31,31 @@ The right side of the import dialog contains various import settings organized i
3131

3232
---
3333

34-
### 🎬 Animation Settings
34+
### Animation Settings
3535

3636
- **Open Time Editor Window**: Opens the Time Editor for animation playback and editing when enabled
3737

3838
---
3939

4040
## Common to All File Types
4141

42-
### ⚙️ General Options
42+
### General Options
4343

4444
- **Group**: Groups imported objects together
4545
- **Remove duplicate shading networks**: Removes redundant material connections
4646
- **Merge Base Animation Layers**: Combines animation layers during import
4747

4848
---
4949

50-
### 🔗 Referencing Options
50+
### Referencing Options
5151

5252
- **Preserve references**: Maintains reference relationships
5353
- **Load Settings**: Choose how to handle saved reference load states
5454
- **Reserve unloaded namespaces**: Keeps namespace reservations
5555

5656
---
5757

58-
### ▶️ Playback Options
58+
### Playback Options
5959

6060
- **Always Override if Scene is Empty**: Automatically overrides playback settings in empty scenes
6161
- **Framerate Import**: Options for handling frame rate differences

docs/img/gltf_maya_icon.png

2.9 KB
Loading

docs/img/image_home.png

1.69 KB
Loading

docs/importing_gltf_glb_file.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The Import dialog will open, providing you with several options and settings for
3737

3838
---
3939

40-
## 💡 Tips & Best Practices
40+
## Tips & Best Practices
4141

4242
- **File Format Support**: The importer supports both `.gltf` and `.glb` file formats
4343
- **Default Settings**: Most default settings work well for standard imports, but you can customize them based on your specific workflow requirements

docs/index.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@ This plugin unlocks access to the vast ecosystem of optimized 3D content from we
1010

1111
---
1212

13-
## Key Features
13+
## Key Features
1414

15-
- **📁 File Format Support**: Import both `.gltf` and `.glb` file formats
16-
- **🎯 Asset Import**: Support for meshes, materials, textures, animations, and more
17-
- **🎨 Material System**: PBR material conversion to Maya's native material system
18-
- **🎬 Animation Support**: Import skeletal animations and morph targets
19-
- **🔧 Extension Compatibility**: Support for common Khronos extensions and selected vendor extensions
15+
- **File Format Support**: Import both `.gltf` and `.glb` file formats
16+
- **Asset Import**: Support for meshes, materials, textures, animations, and more
17+
- **Material System**: PBR material conversion to Maya's native material system
18+
- **Animation Support**: Import skeletal animations and morph targets
19+
- **Extension Compatibility**: Support for common Khronos extensions and selected vendor extensions
2020

2121
---
2222

23-
## 🚀 Quick Start Guide
23+
## Quick Start Guide
2424

2525
1. **[Install Dependencies](dependencies_installation.md)** - Set up required Python packages
2626
2. **[Install Plugin](plugin_installation.md)** - Add the plugin to your Maya installation
@@ -29,12 +29,6 @@ This plugin unlocks access to the vast ecosystem of optimized 3D content from we
2929

3030
---
3131

32-
## 💡 Why Choose This Plugin?
33-
34-
Transform your Maya workflow with industry-standard 3D content import capabilities. Whether you're working with web-based 3D assets, game engine exports, or modern creation tool outputs, this plugin ensures seamless integration into your Maya projects.
35-
36-
---
37-
3832
## Trademarks
3933

4034
- **Maya** is a registered trademark of Autodesk, Inc.

docs/limitations.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44

55
While the glTF/GLB Importer for Maya successfully handles most files that adhere to the [Khronos glTF 2.0 specifications](https://www.khronos.org/gltf/), there are several known limitations and specific issues that users should be aware of.
66

7-
> 💡 **For information about compatible assets and workarounds, see the [Asset Compatibility and Workarounds](compatibility_and_workarounds.md) guide.**
7+
> **Note:** For information about compatible assets and workarounds, see the [Asset Compatibility and Workarounds](compatibility_and_workarounds.md) guide.
88
99
---
1010

11-
## ⚠️ Sketchfab Asset Import Issues
11+
## Sketchfab Asset Import Issues
1212

1313
Sketchfab assets, particularly those that are **automatically generated**, present specific challenges:
1414

@@ -29,7 +29,7 @@ Sketchfab assets, particularly those that are **automatically generated**, prese
2929

3030
---
3131

32-
## 🔧 General Plugin Limitations
32+
## General Plugin Limitations
3333

3434
### File Format Constraints
3535
- **glTF Extensions**: Not all Khronos extensions are fully supported
@@ -52,7 +52,7 @@ Sketchfab assets, particularly those that are **automatically generated**, prese
5252

5353
---
5454

55-
## 📋 Reporting Issues
55+
## Reporting Issues
5656

5757
If you encounter limitations not listed here, please provide:
5858

docs/material_settings.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,15 @@ Controls how normals and shading are handled during import:
5252

5353
- Maintains the intended shading as authored in the original model
5454

55-
**Harden edges**
55+
**Hard edge**
5656

5757
- Converts to Maya's hard edge shading
5858

5959
- Creates sharp edges between faces
6060

6161
- Useful for mechanical or architectural models
6262

63-
**Soften edges**
63+
**Soften edge**
6464

6565
- Applies Maya's soft edge shading
6666

docs/show_material_variants.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@ Material variants enable artists and designers to quickly experiment with differ
2323

2424
## Important Note
2525

26-
⚠️ **Warning**: Avoid using "Delete Unused Nodes" from the Hypershade's Edit dropdown menu when working with material variants. This operation will delete materials that are not currently assigned to geometry, which includes the alternative materials used by other variants. If unused materials are deleted, switching between material variants will not work properly as the required materials will no longer be available in the scene.
26+
**Warning**: Avoid using "Delete Unused Nodes" from the Hypershade's Edit dropdown menu when working with material variants. This operation will delete materials that are not currently assigned to geometry, which includes the alternative materials used by other variants. If unused materials are deleted, switching between material variants will not work properly as the required materials will no longer be available in the scene.

0 commit comments

Comments
 (0)