{"id":17598018,"url":"https://github.com/cvan/aframe-firebase-component","last_synced_at":"2025-06-20T20:37:23.884Z","repository":{"id":63894574,"uuid":"59707980","full_name":"cvan/aframe-firebase-component","owner":"cvan","description":"Firebase component for multiuser A-Frame.","archived":false,"fork":false,"pushed_at":"2016-05-25T04:06:17.000Z","size":4909,"stargazers_count":3,"open_issues_count":0,"forks_count":14,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-12T00:55:44.949Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://ngokevin.github.io/aframe-firebase-component","language":"JavaScript","has_issues":false,"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/cvan.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}},"created_at":"2016-05-26T00:50:33.000Z","updated_at":"2022-11-28T12:57:05.000Z","dependencies_parsed_at":"2023-01-14T12:15:54.627Z","dependency_job_id":null,"html_url":"https://github.com/cvan/aframe-firebase-component","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cvan/aframe-firebase-component","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cvan%2Faframe-firebase-component","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cvan%2Faframe-firebase-component/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cvan%2Faframe-firebase-component/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cvan%2Faframe-firebase-component/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cvan","download_url":"https://codeload.github.com/cvan/aframe-firebase-component/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cvan%2Faframe-firebase-component/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261013406,"owners_count":23097031,"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-10-22T09:44:15.122Z","updated_at":"2025-06-20T20:37:18.870Z","avatar_url":"https://github.com/cvan.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## aframe-firebase-component\n\n\u003e Learn [how to get started with Firebase](https://firebase.google.com/docs/web/setup).\n\nA Firebase component for [A-Frame](https://aframe.io).\n\nComes with a Firebase broadcast component for multiuser experiences\nout-of-the-box by syncing entities' component data to Firebase realtime\ndatabase. The parent-child relationships between entities are maintained as\nwell as long as all entities in the hierarchy have the `broadcast` component\nattached.\n\nTo deploy with GitHub pages when setting up Firebase with the [Firebase\nConsole](https://firebase.google.com/console/), go into *Auth*, and add your\nGitHub pages domain (e.g., `ngokevin.github.io`). This will whitelist your\ndomain.\n\nIf you want to allow unauthenticated users (most should), then go into\n*Database*, click on *Rules*, and set both the `.read` and `.write` to `true`.\n\n### Properties\n\n#### firebase\n\nFirebase configuration component for `\u003ca-scene\u003e`. Firebase will provide all of\nthis for you when you set up a Firebase app.\n\n| Property      | Description                     |\n| --------      | -----------                     |\n| apiKey        | API key for Firebase.           |\n| authDomain    | Firebase authentication domain. |\n| databaseURL   | Firebase database URL.          |\n| storageBucket | Firebase storage bucket URL.    |\n\n#### firebase-broadcast\n\nBroadcast component data to be synced across all clients using Firebase realtime database.\n\n| Property   | Description                                          | Default Value      |\n| --------   | -----------                                          | -------------      |\n| components | List of comma-delimited component names to broadcast | position, rotation |\n\n### Accessing the Firebase Object\n\nYou can access the Firebase object:\n\n```js\ndocument.querySelector('a-scene').systems.firebase.firebase\n```\n\nIf you wanted to add game logic or features such as chat.\n\n### Usage\n\n#### Browser Installation\n\nInstall and use by directly including the [browser files](dist):\n\n```html\n\u003chead\u003e\n  \u003ctitle\u003eMy A-Frame Scene\u003c/title\u003e\n  \u003cscript src=\"https://aframe.io/releases/0.2.0/aframe.min.js\"\u003e\u003c/script\u003e\n  \u003cscript src=\"https://rawgit.com/ngokevin/aframe-firebase-component/master/dist/aframe-firebase-component.min.js\"\u003e\u003c/script\u003e\n\u003c/head\u003e\n\n\u003cbody\u003e\n  \u003ca-scene firebase=\"apiKey: abc;\n                     authDomain: mysite.firebaseapp.com;\n                     databaseURL: https://mysite.firebaseio.com;\n                     storageBucket: mysite.appspot.com\"\u003e\n    \u003ca-assets\u003e\n      \u003c!-- Using mixins to decrease amount of data send over the wire. --\u003e\n      \u003ca-mixin id=\"avatar-head\"\n              geometry=\"primitive: box; depth: 0.3; height: 0.3; width: 0.3\"\n              material=\"color: #222\"\u003e\u003c/a-mixin\u003e\n    \u003c/a-assets\u003e\n\n    \u003ca-entity id=\"avatar\" mixin=\"avatar-head\"\n              camera look-controls wasd-controls\n              firebase-broadcast=\"components: mixin, position, rotation\"\n              position=\"0 1.8 5\"\u003e\n    \u003c/a-entity\u003e\n  \u003c/a-scene\u003e\n\u003c/body\u003e\n```\n\n#### NPM Installation\n\nInstall via NPM:\n\n```bash\nnpm install aframe-firebase-component\n```\n\nThen register and use.\n\n```js\nrequire('aframe');\nrequire('aframe-firebase-component');\n```\n\n#### FAQ\n\n*Why can't I see anyone else?*\n\nTry positioning everyone at a different start point. In\n`examples/presentation/components/`, there is a `random-position-at` component\nthat starts everyone at a different position (more specifically at one of the\nchairs).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcvan%2Faframe-firebase-component","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcvan%2Faframe-firebase-component","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcvan%2Faframe-firebase-component/lists"}