{"id":15146688,"url":"https://github.com/vircadia/vircadia-web","last_synced_at":"2025-04-05T16:04:46.574Z","repository":{"id":37609126,"uuid":"365073574","full_name":"vircadia/vircadia-web","owner":"vircadia","description":"Vircadia open source metaverse web interface for virtual worlds.","archived":false,"fork":false,"pushed_at":"2025-01-29T09:20:53.000Z","size":264487,"stargazers_count":66,"open_issues_count":42,"forks_count":54,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-03-29T15:04:12.183Z","etag":null,"topics":["babylonjs","javascript","metaverse","vr","vrmmo","webgl","webgpu","webxr","xr"],"latest_commit_sha":null,"homepage":"https://app.vircadia.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","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":"2021-05-07T00:44:11.000Z","updated_at":"2025-03-27T07:22:12.000Z","dependencies_parsed_at":"2023-10-16T02:49:57.958Z","dependency_job_id":"809e5489-0c56-4cc6-a8bb-62f26c8409d6","html_url":"https://github.com/vircadia/vircadia-web","commit_stats":{"total_commits":939,"total_committers":13,"mean_commits":72.23076923076923,"dds":0.549520766773163,"last_synced_commit":"3b58c6fcb8845661d08f55030fd77072af8fe07c"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vircadia%2Fvircadia-web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vircadia%2Fvircadia-web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vircadia%2Fvircadia-web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vircadia%2Fvircadia-web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vircadia","download_url":"https://codeload.github.com/vircadia/vircadia-web/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247361615,"owners_count":20926642,"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":["babylonjs","javascript","metaverse","vr","vrmmo","webgl","webgpu","webxr","xr"],"created_at":"2024-09-26T12:03:51.288Z","updated_at":"2025-04-05T16:04:46.549Z","avatar_url":"https://github.com/vircadia.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# ![Vircadia Web](https://raw.githubusercontent.com/vircadia/vircadia-assets/master/images/branding/vircadia_web_text_logo.svg)\r\n\r\n![Alt](https://repobeats.axiom.co/api/embed/52cc737e78701f8a1302f7f9f3dd2fdaf8296f2d.svg \"Repobeats analytics image\")\r\n\r\n## ⚠️ Early Developer Alpha ⚠️\r\n### The Vircadia web client is in Early Developer Alpha! There will be unimplemented features and bugs.\r\n***Please take a moment to check the [list of issues](https://github.com/vircadia/vircadia-web/issues) and file an issue if one does not exist already.\r\nIf you are able, please try to implement a feature or fix a bug yourself! The metaverse appreciates your assistance. 🙏***\r\n\r\nVircadia Web (*codename Aether*) is an open source metaverse web client for accessing virtual worlds.\r\n\r\n## Compatibility\r\n\r\nThis interface is tested and validated for the following browser platforms:\r\n* Mobile, Tablet, Desktop\r\n    * Chromium (Chrome, Brave, Edge etc.)\r\n    * Webkit (Safari)\r\n    * Gecko (Firefox)\r\n* Native\r\n    * Windows 10+\r\n    * MacOS Monterey\r\n    * Linux (Ubuntu 20+)\r\n* XR on Android *(COMING SOON!)*\r\n    * Quest 2/Quest Pro\r\n    * Pico 4\r\n    * Vive Focus 3\r\n\r\n## Project Setup\r\n\r\n### Prerequisites\r\n\r\nVircadia Web has been tested to work with:\r\n\r\n* Node versions `16` - `20`\r\n* NPM versions `8.19` - `10.1`\r\n\r\n*(Use of Node versions other than stated is untested and may not work correctly.)*\r\n\r\n### Clone the Repo\r\n\r\nFirst, clone the repository to your machine with Git. Then, open a terminal in that directory.\r\n\r\nVircadia Web relies on the Vircadia Assets submodule, so you must pull recursively.\r\n\r\n```sh\r\ngit clone --recursive https://github.com/vircadia/vircadia-web.git\r\n```\r\n\r\nIf you forget to pull recursively, you can initialize the submodule later with:\r\n```sh\r\ngit submodule update --init --recursive\r\n```\r\n\r\n### Install the dependencies\r\n\r\n```sh\r\nnpm i\r\n```\r\nor\r\n```sh\r\nyarn\r\n```\r\n\r\nIf you want to use a local copy of the Vircadia Web SDK, from a directory beside the web app's:\r\n```sh\r\nnpm run install-local-web-sdk\r\n```\r\n\r\n## Run, Compile, and Test\r\n\r\n### Customization Options\r\n\r\nThe web client's settings such as branding, default servers, and more, can be customized directly from [environment variables](https://github.com/vircadia/vircadia-web/blob/master/quasar.conf.js#L131) which you must set at or prior to build/compile time.\r\n\r\nSee [Configuring quasar.conf.js](https://v2.quasar.dev/quasar-cli/quasar-conf-js) for a full set of customization options.\r\n\r\n### Start the app in development mode\r\n\r\nDevelopment mode benefits from features like hot-code reloading, error reporting, etc.\r\n\r\n```sh\r\nnpm run dev\r\n```\r\nor\r\n```\r\nyarn run dev\r\n```\r\n\r\n### Lint the files\r\n\r\n```sh\r\nnpm run lint\r\n```\r\n\r\nAnd fix lint issues automatically with\r\n\r\n```sh\r\nnpm run lint -- --fix\r\n```\r\n\r\n### Run tests\r\n\r\n```sh\r\nnpm run test\r\n```\r\n\r\n### Build the app for production\r\n\r\n```sh\r\nnpm run build\r\n```\r\n\r\n## Desktop\r\n\r\nThe web client can also be compiled to a standalone desktop app. When doing so, the `VRCA_DESKTOP_MODE` environment variable must be set to either `dev` or `build`.\r\n\r\nAfter installing the base Node dependencies with `npm i`, you will also need to install [Tauri's Rust dependencies](https://tauri.app/v1/guides/getting-started/prerequisites).\r\n\r\nTo run the desktop wrapper in development mode:\r\n```sh\r\nnpm run dev-desktop\r\n```\r\n\r\nTo build the desktop executable:\r\n```sh\r\nnpm run build-desktop\r\n```\r\n\r\n## To Update Contributors\r\n\r\n```sh\r\nnpm run update-contributors\r\n```\r\n\r\n## Local Assets\r\n\r\nTo enable faster loading, you may put local models into the `public/local-assets` folder, then reference them in your entity tree like so `/local-assets/yourModel.glb`. The asset should now be available to you in-world.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvircadia%2Fvircadia-web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvircadia%2Fvircadia-web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvircadia%2Fvircadia-web/lists"}