{"id":21858587,"url":"https://github.com/vircadia/vircadia-assets","last_synced_at":"2025-06-11T00:34:05.497Z","repository":{"id":203222911,"uuid":"704374552","full_name":"vircadia/vircadia-assets","owner":"vircadia","description":"Static files used by Vircadia Web.","archived":false,"fork":false,"pushed_at":"2023-11-09T08:52:46.000Z","size":77696,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-21T19:48:59.698Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/vircadia.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-10-13T06:05:07.000Z","updated_at":"2024-10-23T22:17:33.000Z","dependencies_parsed_at":null,"dependency_job_id":"aed38883-48ca-421a-8d36-d06f9d5d4779","html_url":"https://github.com/vircadia/vircadia-assets","commit_stats":null,"previous_names":["vircadia/vircadia-assets"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vircadia%2Fvircadia-assets","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vircadia%2Fvircadia-assets/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vircadia%2Fvircadia-assets/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vircadia%2Fvircadia-assets/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vircadia","download_url":"https://codeload.github.com/vircadia/vircadia-assets/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vircadia%2Fvircadia-assets/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259176050,"owners_count":22817107,"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-11-28T02:46:30.120Z","updated_at":"2025-06-11T00:34:05.467Z","avatar_url":"https://github.com/vircadia.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Vircadia Assets\n\nStatic files used by Vircadia Web.  \n\nThis repo is optimized to be used as a submodule.  \nHere are some [handy instructions](https://gist.github.com/gitaarik/8735255) for working with Git submodules.\n\n\n## Programmatic Access\n\nEach directory contains an `index.ts` file listing the files and sub-directories within. This allows you to read the contents of any directory without using node-only modules like `fs`. For example, to check if the `/models/avatars` directory contains a given file:\n```ts\nimport * as assets from \"vircadia-assets\";\n\nconsole.log(assets.directories.models.directories.avatars.files.includes(\"awesome_avatar.glb\"));\n//      ^- true\n```\n\n\n## Adding New Directories\n\nWhen adding a new directory to this repo, please give it an `index.ts` file using the following template:\n```ts\nexport const directories = {} as const;\n\nexport const files = [] as const;\n\n```\n\nThen, in the parent directory, add a reference to the new index file you just created:\n```ts\n/*  the parent index.ts file  */\n\nimport * as audio from \"./audio/index.js\";\nimport * as images from \"./images/index.js\";\nimport * as new_directory from \"./new directory/index.js\";  // Import the directory's index.\nimport * as video from \"./video/index.js\";\n\nexport const directories = {\n    audio,\n    images,\n    new_directory,        // Add the directory reference to the `directories` list.\n    video\n} as const;\n\n...\n```\n*Note: The path to the directory's index file must end in `.js`, [despite it being a TypeScript file](https://stackoverflow.com/questions/75807785/why-do-i-need-to-include-js-extension-in-typescript-import-for-custom-module).*\n\n\n## Adding New Files\n\nWhen adding a new file to this repo, please make sure to include its name in the parent directory's index.  \nFor example, when adding `cat.png` to the `/images` directory:\n```ts\n/*  /images/index.ts  */\n\n...\n\nexport const files = [\n\t\"apple.jpg\",\n\t\"banana.png\",\n\t\"cat.png\",        // Add the file name (with extension) to the `files` list.\n\t\"mouse.webp\"\n] as const;\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvircadia%2Fvircadia-assets","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvircadia%2Fvircadia-assets","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvircadia%2Fvircadia-assets/lists"}