{"id":14990335,"url":"https://github.com/coryrylan/usd-viewer","last_synced_at":"2025-04-12T02:10:25.028Z","repository":{"id":144710956,"uuid":"603830555","full_name":"coryrylan/usd-viewer","owner":"coryrylan","description":"Experimental Web Component for displaying 3d files in USDZ format","archived":false,"fork":false,"pushed_at":"2023-02-25T21:25:39.000Z","size":16056,"stargazers_count":36,"open_issues_count":0,"forks_count":5,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-10T18:46:44.291Z","etag":null,"topics":["usd","usdz","web-component"],"latest_commit_sha":null,"homepage":"https://usd-viewer.web.app/usd-viewer-interactive-iframe","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coryrylan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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":"2023-02-19T17:39:29.000Z","updated_at":"2025-04-03T14:12:08.000Z","dependencies_parsed_at":null,"dependency_job_id":"278e536b-fe50-4df0-9c5c-da9e75a2348e","html_url":"https://github.com/coryrylan/usd-viewer","commit_stats":{"total_commits":3,"total_committers":2,"mean_commits":1.5,"dds":"0.33333333333333337","last_synced_commit":"5b12bb2025e2a4a15226f6220f32341724163b07"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coryrylan%2Fusd-viewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coryrylan%2Fusd-viewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coryrylan%2Fusd-viewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coryrylan%2Fusd-viewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coryrylan","download_url":"https://codeload.github.com/coryrylan/usd-viewer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248505929,"owners_count":21115354,"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":["usd","usdz","web-component"],"created_at":"2024-09-24T14:19:54.571Z","updated_at":"2025-04-12T02:10:24.996Z","avatar_url":"https://github.com/coryrylan.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# usd-viewer\n\n[![npm version](https://img.shields.io/npm/v/usd-viewer?color=%2334D058\u0026label=usd-viewer)](https://www.npmjs.com/package/usd-viewer)\n\n### [usd-viewer demo](https://usd-viewer.web.app/usd-viewer-interactive-iframe)\n\n**Experimental** Web Component for rendering USDZ 3d format. Built on the experimental work and efforts of [github.com/autodesk-forks/USD/tree/release](https://github.com/autodesk-forks/USD/tree/release)\n\n## Instalation\n\n```shell\nnpm install usd-viewer\n```\n\n## Web Assembly Dependencies\n\nCurrently this depends on the [SharedArrayBuffer](https://developer.mozilla.org/fr/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer) so to enable in the browser the following response headers must be set:\n\n```json\n\"Cross-Origin-Embedder-Policy\": \"require-corp\"\n\"Cross-Origin-Opener-Policy\": \"same-origin\"\n```\n\nTo load the Wasm dependencies in the browser copy them from the `node_modules` into your host env.\n\n```\ncpy node_modules/usd-viewer/wasm/**/* dist/wasm\n```\n\nTo change the default path (`./wasm`) of the Wasm resources add the following meta tag to the document.\n\n```html\n\u003cmeta name=\"usd-viewer:wasm\" content=\"custom-path/wasm\" /\u003e\n```\n\n## Usage\n\n```html\n\u003cscript type=\"module\"\u003e\n  import 'usd-viewer/include.js';\n\u003c/script\u003e\n\n\u003cusd-viewer src=\"./usd/perseverance.usdz\" alt=\"Perseverance Mars Rover\"\u003e\u003c/usd-viewer\u003e\n```\n\n## API\n\n| Property          | Attribute           | Type    | Description                                    |\n| ----------------- | ------------------- | ------  | ---------------------------------------------- |\n| `src`             | `src`               | string  | source path for usd/usdz file                   |\n| `alt`             | `alt`               | string  | alt descriptive text                           |\n| `controls`        | `conrols`           | boolean | enable or disable model touch/mouse controls   |\n| `fileName`         | `file-name`          | boolean | enable or disable display of file name          |\n| `autoRotate`      | `auto-rotate`       | boolean | enable or disable auto rotation of model       |\n| `autoRotateSpeed` | `auto-rotate-speed` | number  | adjust speed of rotations of model             |\n| `minDistance`     | `min-distance`      | number  | minimum zoom distance of model                 |\n| `maxDistance`     | `max-distance`      | number  | maximum zoom distance of model                 |\n| `zoom`            | `zoom`              | number  | default zoom level of camera relative to model |\n\n## Licensing\n\nThe Web Component of this project is MIT licensed, however refer to the following external dependencies and explicitly marked file headers. For additional license details see:\n- https://github.com/autodesk-forks/USD\n- https://github.com/autodesk-forks/USD/tree/gh-pages/usd_for_web_demos","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoryrylan%2Fusd-viewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoryrylan%2Fusd-viewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoryrylan%2Fusd-viewer/lists"}