Skip to content

Commit 84f0ffc

Browse files
committed
Update install and animation docs
1 parent bec1d25 commit 84f0ffc

11 files changed

+130
-185
lines changed

docs/animation_settings.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,29 @@
22

33
When importing GLTF/GLB files, you can configure animation settings to control how animations are processed and displayed.
44

5-
## Import Animations
6-
7-
Controls whether animations are imported from the GLTF/GLB file:
8-
9-
- When enabled (default), creates Maya keyframes for translation, rotation, and scale animations
10-
11-
- Imports all animation data from the file, including bone animations, object transformations, and camera animations
5+
> **Note:** Before previewing imported animation, set Maya's Time Slider playback speed to **Real-time** (`Playback Speed > Real-time`). The other options—**Play Every Frame, Free** and **Play Every Frame, Max Real-time**—ignore the FPS chosen below and can make animation appear too fast or too slow.
126
13-
- When disabled, animation data is ignored and only static geometry is imported
7+
## Animation FPS
148

15-
- Useful when you only need the static model without animation data
9+
- Choose the playback rate for imported animations from the dropdown
10+
- Default is **30 fps (NTSC)**, but presets such as 15 fps (Game), 24 fps (Film), 25 fps (PAL), 48 fps (Show), 50 fps (PAL Field), and 60 fps (NTSC Field) are available
11+
- **24 fps** and **30 fps** cover most use cases
12+
- Use this setting to match the project frame rate before importing
1613

17-
## Open Time Editor Window
14+
## Import Animations
1815

19-
Controls whether the Time Editor window opens automatically after import:
16+
- When enabled (default), brings in all animation data, including skeletal motion, object transforms, and camera animation, creating the corresponding Maya keyframes
17+
- Disable if you only need static meshes and want to avoid adding keys to the scene
18+
- Helpful to leave off when you plan to author new animation in Maya and only use the imported geometry
2019

21-
- When enabled, the Maya Time Editor window automatically opens when importing animated GLTF/GLB files
20+
## Import Blendshape Animations
2221

23-
- Provides immediate access to view and edit the imported animation clips
22+
- When enabled (default), imports blendshape weight keyframes from the GLTF/GLB file
23+
- Required for facial animation or any deformation driven by blendshape curves
24+
- Disable if you only need static blendshape targets without animation to reduce scene keyframe data
2425

25-
- Useful for quickly reviewing and editing imported animations
26+
## Open Time Editor Window
2627

27-
- When disabled (default), animations are imported but the Time Editor window does not open automatically
28+
- When enabled, launches the Maya Time Editor immediately after import so you can inspect and tweak the new animation clips
29+
- Helpful when you expect to edit or retime the imported animation right away
30+
- Disabled by default to avoid interrupting the workflow if you only need the animation loaded into the scene

docs/dependencies_installation.md

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

99
| Requirement | Details |
1010
|-------------|---------|
11-
| **Maya Version** | Maya 2024 or later|
11+
| **Maya Version** | Maya 2022 or later|
1212
| **Operating System** | Windows, macOS, or Linux |
1313
| **Python** | Python 3.7+ (automatically included with Maya 2022+) |
1414

@@ -18,7 +18,7 @@ This guide will help you install the required dependencies for the glTF/GLB impo
1818

1919
The plugin requires the following Python packages:
2020

21-
- **[numpy](https://pypi.org/project/numpy/)** - Required for Maya 2024
21+
- **[numpy](https://pypi.org/project/numpy/)** - Required for Maya 2024 and below
2222

2323
> **Note:** Maya 2025+ includes numpy by default.
2424

docs/faq.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
**For Maya 2024**: Yes, you need to install numpy. **For Maya 2025+**: No additional dependencies are required as numpy is included by default. Please follow the complete guide in [Dependencies Installation](dependencies_installation.md) for installation instructions.
2323

2424
??? question "Where should I install the plugin files?"
25-
The plugin should be installed in ApplicationPlugins directory. Detailed installation paths and instructions are provided in the [Plugin Installation](plugin_installation.md) guide.
25+
Extract the downloaded zip and copy the contents of the `scripts` folder to your user-specific Maya `.../scripts` directory, and the contents of the `plug-ins` folder to the matching `.../plug-ins` directory (create it if it does not exist). Refer to the platform-specific steps in [Plugin Installation](plugin_installation.md) for exact paths on Windows, macOS, and Linux.
2626

2727
## Import Questions
2828

@@ -125,11 +125,13 @@
125125
??? question "My animations aren't playing correctly"
126126
Animation issues can often be resolved by:
127127

128-
1. Checking [Animation Settings](animation_settings.md) configuration - Ensure "Import Animations" is enabled
129-
2. Enabling "Open Time Editor Window" in [Animation Settings](animation_settings.md) to automatically open the Time Editor after import for easier access to animation clips
130-
3. Using [Show Animation Clips](show_animation_clips.md) to manage multiple animations - All clips are organized in Maya's Time Editor
131-
4. Verifying timeline settings in Maya
132-
5. Note: Transform-based animations work better than joint-based animations - Sketchfab assets with rigged animations may require preprocessing (see [Asset Compatibility and Workarounds](compatibility_and_workarounds.md))
128+
1. Checking [Animation Settings](animation_settings.md) configuration — ensure "Import Animations" (and "Import Blendshape Animations" if needed) is enabled
129+
2. Setting Maya's playback speed to **Real-time** in the Time Slider options so imported FPS is respected
130+
3. Enabling "Open Time Editor Window" in [Animation Settings](animation_settings.md) to automatically open the Time Editor after import for easier access to animation clips
131+
4. Using [Show Animation Clips](show_animation_clips.md) to manage multiple animations — all clips are organized in Maya's Time Editor
132+
5. If you're on Maya 2023 or earlier and blendshape animations don't play, bake the clips via the Time Editor's **Bake** menu as described in the [Asset Compatibility and Workarounds](compatibility_and_workarounds.md#for-assets-with-animation-clips) guide
133+
6. Verifying timeline settings in Maya
134+
7. Note: Sketchfab assets with rigged animations may require preprocessing (see [Asset Compatibility and Workarounds](compatibility_and_workarounds.md))
133135

134136
## Advanced Usage
135137

@@ -166,7 +168,15 @@
166168
Detailed technical information is available in the [Technical Details](technical_details.md) section, including programmatic import using MEL and Python commands with all available import options.
167169

168170
??? question "How do I report bugs or request features?"
169-
Please refer to the project repository for information on reporting issues and requesting new features.
171+
You can report bugs or request features through the [GitHub Issues page](https://github.com/parashivbrl/gltf-glb-importer-for-maya-docs/issues). When reporting issues, please include:
172+
173+
1. Maya version and operating system
174+
2. Asset source (Sketchfab, custom export, etc.)
175+
3. File size and complexity details
176+
4. Specific error messages or unexpected behavior
177+
5. Sample files (when possible and appropriate)
178+
6. Output logs from the Maya Script Editor
179+
7. Steps to reproduce the issue
170180

171181
??? question "Are there example files I can use for testing?"
172182
The [Khronos glTF Sample Assets repository](https://github.com/KhronosGroup/glTF-Sample-Assets) provides official test assets that work well with the plugin. These are recommended for testing your installation and understanding the import process. Assets exported from Maya using Babylon exporter or from Blender using the built-in glTF 2.0 addon also work reliably.

docs/file_type_specific_options.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,15 @@ The right side of the import dialog contains various import settings organized i
2020
- **No merging**: Discontinuous geometry along the UV boundary/seams (default option)
2121
- **Merge Vertices**: Combines duplicate vertices
2222
- **Import Skin Binding**: Imports skin binding data from the GLB/GLTF file (enabled by default)
23+
- **Import Blendshapes**: Imports blendshape targets from the GLB/GLTF file (enabled by default)
2324

2425
---
2526

2627
### Animation Settings
2728

28-
- **Animation FPS**: Set the frame rate for imported animations (default: **"24 fps (Film)"**)
29+
- **Animation FPS**: Set the frame rate for imported animations (default: **"30 fps (NTSC)"**)
2930
- **Import Animations**: Creates Maya keyframes for translation, rotation, and scale animations
31+
- **Import Blendshape Animations**: Imports keyframes for blendshape weights (enabled by default)
3032
- **Open Time Editor Window**: Opens Time Editor window for animation playback and editing
3133

3234
---
@@ -35,7 +37,6 @@ The right side of the import dialog contains various import settings organized i
3537

3638
- **Focus view on imported objects**: Automatically focuses the viewport camera on imported objects
3739
- **Animate framing**: Animates the camera framing to focus on imported objects
38-
- **Center view**: Centers the viewport view on imported objects
3940

4041
---
4142

docs/geometry_options.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ Controls how geometry vertices are processed during import:
99
**Merge Vertices**
1010

1111
- Uses an algorithm to merge vertices automatically
12-
1312
- Combines vertices that share the same position
14-
1513
- Suitable for most static geometry imports
1614

1715
**Import Skin Binding**
1816

19-
- When disabled, skin binding data is ignored and geometry is imported without skeleton/deformation setup
20-
21-
- Useful when you only need the static geometry without animation or deformation capabilities
17+
- When enabled (default), skin binding data is imported and applied to meshes that include skeleton/deformation data in the GLTF/GLB file
18+
- Required for animated, skinned, or deformable meshes to behave correctly in Maya
19+
- Disable if you only need static geometry without any skeleton-driven deformation, which can reduce scene complexity
2220

23-
- When enabled (default), skin binding is imported and applied to geometry that has skeleton/deformation data in the GLTF/GLB file
21+
**Import Blendshapes**
2422

25-
- Required for animated or skinned meshes to work correctly in Maya
23+
- When enabled (default), imports blendshape targets contained in the GLTF/GLB file
24+
- Needed for facial rigs or any deformation driven by blendshape weights
25+
- Disable if you only require static meshes or want to minimize scene data

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Easily bring .gltf and .glb assets into Maya, enabling you to work with modern 3
2222
## Quick Start Guide
2323

2424
1. **[Install Dependencies](dependencies_installation.md)** - Set up required Python packages
25-
2. **[Install Plugin](plugin_installation.md)** - Add the plugin to your **ApplicationPlugins** folder
25+
2. **[Install Plugin](plugin_installation.md)** - Copy the plugin files into your Maya documents plug-ins folder
2626
3. **[Import Files](importing_gltf_glb_file.md)** - Start importing glTF/glb content
2727
4. **[Configure Options](file_type_specific_options.md)** - Customize import settings
2828

docs/limitations.md

Lines changed: 22 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,53 +8,46 @@ While the glTF/GLB Importer for Maya successfully handles most files that adhere
88
99
---
1010

11-
## Sketchfab Asset Import Issues
12-
13-
Sketchfab assets, particularly those that are **automatically generated**, present specific challenges:
14-
15-
### Hierarchical Structure Problems
16-
- **Different Node Hierarchy**: Sketchfab's auto-generated files follow a different hierarchical structure than standard glTF exporters
17-
- **Rigged Asset Import Issues**: Due to the non-standard hierarchy, rigged characters and animated objects may not import properly
18-
- **Bone/Joint Mapping**: The bone structure may not translate correctly to Maya's joint system
19-
20-
### Orientation and Positioning Issues
21-
- **Incorrect Asset Orientation**: Even assets without animation data may be **incorrectly oriented** upon import
22-
- **Coordinate System Differences**: Sketchfab's coordinate system transformations may not align with Maya's expectations
23-
- **Scale Inconsistencies**: Assets may import at unexpected scales due to different unit interpretations
24-
25-
### Animation-Specific Problems
26-
- **Joint-based Animations**: Assets with animations applied directly to joints often encounter import issues
27-
- **Skinning Data**: Vertex skinning information may not transfer correctly from Sketchfab's format
28-
- **Animation Curves**: Complex animation curves may be simplified or corrupted during the conversion process
29-
30-
---
31-
3211
## General Plugin Limitations
3312

13+
### Geometry Processing
14+
- **Merge Vertices Side Effects**: When **Merge Vertices** is enabled during import, UVs can fail or distort because vertices that share the same position are de-duplicated, removing the seams needed to keep separate UV shells.
15+
### Blendshape Animations (Maya 2023 and below)
16+
- Blendshape targets and animation curves import, but in Maya 2023 and earlier they may not play back automatically.
17+
- Open the **Time Editor** and use the **Bake** menu options (e.g., *Bake to New Clip*, *Bake to Scene*, *Bake to Scene and Delete*, or *Flatten Layers*) to bake the clips back to standard curves so playback works.
18+
- Maya 2024+ plays the imported blendshape animation without baking.
19+
- For a detailed baking workflow, see **For Assets with Animation Clips** in the [Asset Compatibility and Workarounds guide](compatibility_and_workarounds.md#for-assets-with-animation-clips).
3420
### File Format Constraints
3521
- **glTF Extensions**: Not all Khronos extensions are fully supported
3622
- **Vendor Extensions**: Limited support for vendor-specific extensions
37-
- **Binary Embedded Data**: Large embedded textures in GLB files may cause memory issues
3823

3924
### Maya Integration Limitations
40-
- **Scene Scale**: Very large or very small assets may not import with appropriate scale
4125
- **Viewport Performance**: Complex scenes with many materials may impact Maya's viewport performance
4226

4327
### Material and Texture Limitations
4428
- **Texture Format Support**: Some texture formats such as .webp and Compressed BasisU images may not be supported
4529
- **Material Complexity**: Advanced PBR features may not have direct Maya equivalents
46-
- **UV Mapping**: Complex UV layouts may not preserve perfectly
4730

48-
### Animation and Rigging Constraints
49-
- **Morph Targets**: Blend shape/morph target support may be limited
50-
- **Complex Rigs**: Multi-layered rigging systems may not import completely
51-
- **Animation Sampling**: High-frequency animations may be resampled during import
31+
32+
---
33+
34+
## Sketchfab Asset Import Issues
35+
36+
Sketchfab assets, particularly those that are **automatically generated**, present specific challenges:
37+
38+
### Hierarchical Structure Problems
39+
- **Different Node Hierarchy**: Sketchfab's auto-generated files follow a different hierarchical structure than standard glTF exporters
40+
- **Rigged Asset Import Issues**: Due to the non-standard hierarchy, rigged characters and animated objects may not import properly
41+
42+
### Animation-Specific Problems
43+
- **Skinning Data**: Vertex skinning information may not transfer correctly from Sketchfab's format
44+
- **Animation Curves**: Complex animation curves may be simplified or corrupted during the conversion process
5245

5346
---
5447

5548
## Reporting Issues
5649

57-
If you encounter limitations not listed here, please provide:
50+
If you encounter limitations not listed here, please report them through the [GitHub Issues page](https://github.com/parashivbrl/gltf-glb-importer-for-maya-docs/issues) and provide:
5851

5952
- Maya version and operating system
6053

0 commit comments

Comments
 (0)