net.yutopp.vgltf.unity

VGltf 🗿

VGltf is a library importing/exporting glTF 2.0 assets aiming for extensibility, readability, and stability.

Supported .NET versions are .NET Standard 2.0 or higher.

The following glTF extensions are also supported as independent libraries.

• VRM 0.x

Description for Unity users

Supported Unity versions are Unity 2019.4 or higher.

As for importing and exporting resources, you can use it in the following situations.

• [x] Runtime import
• [x] Runtime export
• [ ] Editor import
• [x] Editor export

We have checked that VGltf runs on these platforms.

• Windows (Mono, IL2CPP)
• Linux (Mono, IL2CPP)
• MacOS (Intel and ARM) (Mono, IL2CPP)
• iOS
• Android
• WebGL
  • (this is a sample project for WebGL with Unity 2022.1)

Installation

For standard C# projects

You can use Nuget/VGltf.

dotnet add package VGltf

For Unity projects

By using git

Add a url for VGltf git repository to your Packages/manifest.json like below.

{
  "dependencies": {
    "net.yutopp.vgltf": "https://github.com/yutopp/VGltf.git?path=Packages/net.yutopp.vgltf",
    "net.yutopp.vgltf.unity": "https://github.com/yutopp/VGltf.git?path=Packages/net.yutopp.vgltf.unity"
  }
}

We recommend to use the stable version by specifying the tag.

By using npm repository

Add scoped registry information shown below to your Packages/manifest.json if not exists.

{
  "scopedRegistries": [
    {
      "name": "yutopp.net",
      "url": "https://registry.npmjs.com",
      "scopes": [
        "net.yutopp"
      ]
    }
  ]
}

And add net.yutopp.vgltf.* to your Packages/manifest.json like below.

{
  "dependencies": {
    "net.yutopp.vgltf": "*",
    "net.yutopp.vgltf.unity": "*"
  }
}

Dependencies

• yutopp/VJson

Usage examples

See Assets/VGltfExamples.

TODO

• [ ] Performance tuning

License

Boost Software License - Version 1.0

References

• glTF 2.0 Specification

Author

• @yutopp