https://github.com/atteneder/gltfast
Efficient glTF 3D import / export package for Unity
https://github.com/atteneder/gltfast
3d android draco gltf graphics ios ktx linux macos mesh unity unity3d upm webgl windows
Last synced: 13 days ago
JSON representation
Efficient glTF 3D import / export package for Unity
- Host: GitHub
- URL: https://github.com/atteneder/gltfast
- Owner: atteneder
- License: other
- Created: 2018-05-11T21:09:58.000Z (almost 7 years ago)
- Default Branch: openupm
- Last Pushed: 2025-01-30T12:02:20.000Z (3 months ago)
- Last Synced: 2025-04-04T08:49:54.167Z (20 days ago)
- Topics: 3d, android, draco, gltf, graphics, ios, ktx, linux, macos, mesh, unity, unity3d, upm, webgl, windows
- Language: C#
- Homepage:
- Size: 3.91 MB
- Stars: 1,294
- Watchers: 31
- Forks: 258
- Open Issues: 97
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# glTFast
[](https://openupm.com/packages/com.atteneder.gltfast/)
Use *glTFast* to import and export [glTF™][gltf] 3D files efficiently at runtime or in the Editor.
## Installing
*Unity glTFast* is a [Package][UnityPackage] and is installed via the name `com.unity.cloud.gltfast` in the Package Manager window in Unity®. See [installation](Documentation~/installation.md) for detailed instructions.
> **NOTE:** This package originally had the identifier `com.atteneder.gltfast`. Consult the [upgrade guide](./Documentation~/UpgradeGuides.md#unity-fork) to learn how to switch to the Unity version (`com.unity.cloud.gltfast`) or [install the original package](./Documentation~/Original.md).
## Features
Speed, memory efficiency and a small build footprint are focus points of *Unity glTFast*.
The [glTF 2.0 specification][gltf-spec] and a large and growing number of [glTF extensions][gltf-ext] are supported.
All platforms as well as Universal, High Definition and Built-In Render Pipelines are supported.
Advanced users can customize or extend *glTFast* in various ways.
See the [comprehensive list of supported features and extensions](./Documentation~/features.md).
### Workflows
There are four use-cases for glTF within Unity
- Import
- [Runtime Import/Loading](./Documentation~/ImportRuntime.md) in games/applications
- [Editor Import](./Documentation~/ImportEditor.md) (i.e. import assets at design-time)
- Export
- [Runtime Export](./Documentation~/ExportRuntime.md) (save and share dynamic, user-generated 3D content)
- [Editor Export](./Documentation~/ExportEditor.md) (Unity as glTF authoring tool)
[][workflows]
Read more about the workflows in the [documentation][workflows].
## Usage
You can load a glTF asset from an URL or a file path.
### Runtime Loading via Component
Add a `GltfAsset` component to a GameObject.
![GltfAsset component][gltfasset_component]
### Runtime Loading via Script
```C#
var gltf = gameObject.AddComponent();
gltf.url = "https://raw.githubusercontent.com/KhronosGroup/glTF-Sample-Models/master/2.0/Duck/glTF/Duck.gltf";
```
See [Runtime Loading via Script](./Documentation~/ImportRuntime.md#runtime-loading-via-script) in the documentation for more details and instructions how to [customize the loading behavior](./Documentation~/ImportRuntime.md#customize-loading-behavior) via script.
### Editor Import
Move or copy glTF files into your project's *Assets* folder, similar to other 3D formats:
![Editor Import][import-gif]
*Unity glTFast* will import them to native Unity prefabs and add them to the asset database.
See [Editor Import](./Documentation~/ImportEditor.md) in the documentation for details.
### Editor Export
The main menu has a couple of [entries for glTF export](./Documentation~/ExportEditor.md#export-from-the-main-menu) under `File > Export` and glTFs can also be
created [via script](./Documentation~/ExportEditor.md#export-via-script).
## Project Setup
### Materials and Shader Variants
❗ IMPORTANT ❗
*Unity glTFast* uses custom shader graphs that you **have** to include in builds in order to make materials work. If materials are fine in the Unity Editor but not in builds, chances are some shaders (or variants) are missing.
Read the section *Materials and Shader Variants* in the [Documentation](./Documentation~/ProjectSetup.md#materials-and-shader-variants) for details.
## Contribution
See [CONTRIBUTING.md](CONTRIBUTING.md).
## License
Copyright 2023 Unity Technologies and the Unity glTFast authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use files in this repository except in compliance with the License.
You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
## Trademarks
*Unity®* is a registered trademark of [Unity Technologies][unity].
*Khronos®* is a registered trademark and [glTF™][gltf] is a trademark of [The Khronos Group Inc][khronos].
[gltf]: https://www.khronos.org/gltf
[gltf-spec]: https://www.khronos.org/registry/glTF/specs/2.0/glTF-2.0.html
[gltf-ext]: https://registry.khronos.org/glTF/specs/2.0/glTF-2.0.html#specifying-extensions
[gltfasset_component]: ./Documentation~/Images/gltfasset_component.png "Inspector showing a GltfAsset component added to a GameObject"
[import-gif]: ./Documentation~/Images/import.gif "Video showing glTF files being copied into the Assets folder and imported"
[khronos]: https://www.khronos.org
[unity]: https://unity.com
[UnityPackage]: https://docs.unity3d.com/Manual/PackagesList.html
[workflows]: ./Documentation~/index.md#workflows