{"id":13560930,"url":"https://github.com/KhronosGroup/glTF-Validator","last_synced_at":"2025-04-03T16:31:28.117Z","repository":{"id":38951321,"uuid":"63432604","full_name":"KhronosGroup/glTF-Validator","owner":"KhronosGroup","description":"Tool to validate glTF assets.","archived":false,"fork":false,"pushed_at":"2024-10-22T22:26:48.000Z","size":4716,"stargazers_count":389,"open_issues_count":52,"forks_count":65,"subscribers_count":32,"default_branch":"main","last_synced_at":"2025-03-30T21:03:32.419Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KhronosGroup.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-07-15T15:35:37.000Z","updated_at":"2025-03-27T00:14:19.000Z","dependencies_parsed_at":"2024-05-11T20:32:42.080Z","dependency_job_id":"b6948398-5c01-4610-b8b5-56530e6390b8","html_url":"https://github.com/KhronosGroup/glTF-Validator","commit_stats":{"total_commits":281,"total_committers":11,"mean_commits":"25.545454545454547","dds":"0.19217081850533813","last_synced_commit":"bcd52cc4ba5f333b2999a58f67cc05ddf28b4fb1"},"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KhronosGroup%2FglTF-Validator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KhronosGroup%2FglTF-Validator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KhronosGroup%2FglTF-Validator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KhronosGroup%2FglTF-Validator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KhronosGroup","download_url":"https://codeload.github.com/KhronosGroup/glTF-Validator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247037009,"owners_count":20873077,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T13:00:50.920Z","updated_at":"2025-04-03T16:31:25.232Z","avatar_url":"https://github.com/KhronosGroup.png","language":"Dart","funding_links":[],"categories":["Libraries \u0026 Tools"],"sub_categories":["Technical Explanation"],"readme":"# glTF-Validator\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"web/logos/glTF_RGB_June16.svg\" alt=\"\" height=\"125\"/\u003e\n\u003c/p\u003e\n\n[![Build Status](https://github.com/KhronosGroup/glTF-Validator/workflows/CI/badge.svg)](https://github.com/KhronosGroup/glTF-Validator/actions?query=workflow%3ACI)\n\nTool to validate [glTF](https://github.com/KhronosGroup/glTF) assets.\n\nValidation is performed against [glTF 2.0](https://www.khronos.org/registry/glTF/specs/2.0/glTF-2.0.html) specification.\n\nValidator writes a validation report (in JSON-format) with all found issues and asset stats.\n\nLive drag-n-drop tool: https://github.khronos.org/glTF-Validator\n\nNPM package: https://www.npmjs.com/package/gltf-validator\n\nNuGet package [Third-party contribution]: https://www.nuget.org/packages/GltfValidator/\n\n## Implemented features\n\n- JSON syntax check and [GLBv2](https://www.khronos.org/registry/glTF/specs/2.0/glTF-2.0.html#glb-file-format-specification) file format correctness.\n- Asset description validation\n  - All properties and their types from JSON-Schemas (including implicit limitations on valid values).\n  - Validity and compatibility of internal references.\n  - Correctness of Data URI encoding.\n- Binary buffers validation\n  - Forbidden or incorrect accessor values (e.g., `NaN`, invalid quaternions, indecomposable matrices, etc).\n  - `accessor.min` and `accessor.max` values.\n  - Sparse accessors encoding.\n  - Animation inputs and outputs.\n- Images validation\n  - Warning on non-power-of-two dimensions.\n  - Warning on unsupported image features (like animations or custom color spaces).\n- Extensions validation\n  - EXT_texture_webp\n  - KHR_animation_pointer (partial)\n  - KHR_lights_punctual\n  - KHR_materials_anisotropy\n  - KHR_materials_clearcoat\n  - KHR_materials_dispersion\n  - KHR_materials_emissive_strength\n  - KHR_materials_ior\n  - KHR_materials_iridescence\n  - KHR_materials_pbrSpecularGlossiness\n  - KHR_materials_sheen\n  - KHR_materials_specular\n  - KHR_materials_transmission\n  - KHR_materials_unlit\n  - KHR_materials_variants\n  - KHR_materials_volume\n  - KHR_mesh_quantization\n  - KHR_texture_transform\n- [Full list of detectable issues](ISSUES.md).\n\n## Usage\n\nYou can use hosted [web front-end tool](https://github.khronos.org/glTF-Validator). It works completely in the browser without any server-side processing.\n\n### Command Line Tool Usage\n\n```text\nUsage: gltf_validator [\u003coptions\u003e] \u003cinput\u003e\n\nValidation report will be written to `\u003casset_filename\u003e.report.json`.\nIf \u003cinput\u003e is a directory, validation reports will be recursively created for each *.gltf or *.glb asset.\n\nValidation log will be printed to stderr.\n\nShell return code will be non-zero if at least one error was found.\n-o, --[no-]stdout                Print JSON report to stdout instead of writing it to a file. This option cannot be used with directory input.\n-r, --[no-]validate-resources    Validate contents of embedded and/or referenced resources (buffers, images).\n                                 (defaults to on)\n-t, --[no-]write-timestamp       Write UTC timestamp to the validation report.\n-p, --[no-]absolute-path         Write absolute asset path to the validation report.\n-m, --[no-]messages              Print issue messages to stderr. Otherwise, only total number of issues will be printed.\n-a, --[no-]all                   Print all issue messages to stderr. Otherwise, only errors will be printed. Implies --messages.\n-c, --config                     YAML configuration file with validation options. See docs/config-example.yaml for details.\n-h, --threads                    The number of threads for directory validation. Set to 0 (default) for auto selection.\n```\n\n## Building\n\n### Prerequisites\n\n1. Download and install [Dart SDK](https://dart.dev/tools/sdk/archive) for your platform.\n2. Add Dart SDK `bin` directory to your PATH.\n3. From the repository root directory, run `dart pub get` to get dependencies.\n\n#### Fetching dependencies from behind a corporate firewall\n\n`dart pub get` downloads dependencies from Google's `pub.dev` server over HTTPS. If you need to specify a proxy, follow these steps:\n\n1. Set `https_proxy` or `HTTPS_PROXY` environment variable in form `hostname:port`.\n2. If the proxy requires credentials, use this syntax: `username:password@hostname:port`.\n\n`dart pub get` validates server's SSL certificate. If your corporate network interferes with SSL connections, follow these steps to get it running.\n\n1. Save your corporate self-signed root certificate as X.509 file.\n2. (Linux only) Try to add your cert to `/etc/pki/tls/certs/ca-bundle.crt` or `/etc/ssl/certs`.\n3. If that doesn't work or if you're on Windows, add environment variable `DART_VM_OPTIONS` with value `--root-certs-file=\u003ccert_file\u003e`.\n\nAfter doing this, `dart pub get` should be able to download dependencies successfully.\n\n#### Clearing Caches\n\nIn rare cases, you may encounter various build issues usually caused by previously cached artifacts and/or packages. To clear all caches and re-download the dependencies, do the following steps:\n\n1. Remove the `.dart_tool` directory and the `pubspec.lock` file from the project root directory.\n2. Run `dart pub cache clean --force`.\n3. Run `dart pub get`.\n\n### Drag-n-Drop Web Tool\n\nTo build the drag-n-drop online validation tool (as hosted [here](https://github.khronos.org/glTF-Validator/)), follow these steps after installation:\n\n1. Run `dart run grinder web`.\n2. All needed files will be written to `build/web` directory.\n\nTo build and package the drag-n-drop online validation tool, follow these steps after installation:\n\n1. Run `dart run grinder web-archive`.\n2. An archive will be written to the `build/gltf_validator-VERSION-web.zip` file.\n\n### CLI tool\n\nTo build the CLI tool, follow these steps after installation:\n\n1. Run `dart run grinder exe`.\n2. Native executable file will be written to `build/bin/gltf_validator` (Linux and macOS) or `build/bin/gltf_validator.exe` (Windows).\n\nTo build and package the CLI tool, follow these steps after installation:\n\n1. Run `dart run grinder exe-archive`.\n2. An archive will be written to the `build/gltf_validator-VERSION-PLATFORM.tar.xz` (Linux and macOS) or `build/gltf_validator-VERSION-PLATFORM.zip` (Windows) file.\n\n### NPM Package\n\nTo build an npm package for use in Node.js environment, follow these steps after installation:\n\n1. Run `dart run grinder npm`.\n2. `gltf-validator` npm package will be written to `build/node`.\n\nRefer to the [npm package documentation](https://www.npmjs.com/package/gltf-validator) for additional information.\n\n#### Publishing\n\nTo publish an npm package, follow these steps after installation:\n\n1. Run `dart run grinder npm-publish`.\n2. `gltf-validator` npm package will be built to `build/node` and published to npm registry using `npm publish`.\n\n### Validation Issues List\n\nTo generate [ISSUES.md](ISSUES.md), follow these steps after installation:\n\n1. Run `dart run grinder issues`.\n2. `ISSUES.md` file will be written to the repo root.\n\n## Contributing\n\nBefore making a pull request do the following steps:\n\n1. Run `dart format .` (note the dot) to format all source files.\n2. Run `dart analyze` to check that there are no analyzer issues.\n3. Run `dart test` to check that the tests pass.\n4. Run `dart run grinder all` to check that all targets build.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FKhronosGroup%2FglTF-Validator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FKhronosGroup%2FglTF-Validator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FKhronosGroup%2FglTF-Validator/lists"}