{"id":15885755,"url":"https://github.com/kalegd/digitalbacon","last_synced_at":"2025-12-28T08:55:54.782Z","repository":{"id":41255794,"uuid":"493653974","full_name":"kalegd/DigitalBacon","owner":"kalegd","description":"Create 3D websites easily that run on AR, VR, Desktop, and Mobile devices with Digital Bacon. No coding required, but supports an API to create plugins for advanced customizations","archived":false,"fork":false,"pushed_at":"2024-12-04T16:13:22.000Z","size":66784,"stargazers_count":24,"open_issues_count":3,"forks_count":9,"subscribers_count":1,"default_branch":"dev","last_synced_at":"2025-05-08T21:44:11.318Z","etag":null,"topics":["3d","ar","cms","digitalbacon","javascript","threejs","vr","webgl","webxr","xr"],"latest_commit_sha":null,"homepage":"https://digitalbacon.io","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kalegd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["kalegd"]}},"created_at":"2022-05-18T12:29:27.000Z","updated_at":"2025-03-16T07:51:21.000Z","dependencies_parsed_at":"2023-11-09T00:23:44.560Z","dependency_job_id":"d4e3cc33-e167-41f5-825a-80a7815afaeb","html_url":"https://github.com/kalegd/DigitalBacon","commit_stats":{"total_commits":396,"total_committers":9,"mean_commits":44.0,"dds":0.03535353535353536,"last_synced_commit":"1a137f6f378a8dd30cb93f8b04cf55a7ab1e9fd6"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kalegd%2FDigitalBacon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kalegd%2FDigitalBacon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kalegd%2FDigitalBacon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kalegd%2FDigitalBacon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kalegd","download_url":"https://codeload.github.com/kalegd/DigitalBacon/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253154116,"owners_count":21862458,"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":["3d","ar","cms","digitalbacon","javascript","threejs","vr","webgl","webxr","xr"],"created_at":"2024-10-06T05:07:22.747Z","updated_at":"2025-12-28T08:55:54.724Z","avatar_url":"https://github.com/kalegd.png","language":"JavaScript","funding_links":["https://github.com/sponsors/kalegd"],"categories":[],"sub_categories":[],"readme":"# DigitalBacon\n\nCreate 3D websites easily that run on AR, VR, Desktop, and Mobile devices with Digital Bacon. No coding required, but supports an API to create plugins for advanced customizations\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"/resources/gifs/vr_asset_transform_demo.gif\" title=\"vr asset transform demo\" height=\"200\"\u003e \u0026nbsp;\u0026nbsp;\u0026nbsp;\u003cimg src=\"/resources/gifs/water_color_demo.gif\" title=\"vr water color demo\" height=\"200\"\u003e \u0026nbsp;\u0026nbsp;\u0026nbsp;\u003cimg src=\"/resources/gifs/ar_wall_occlusion_demo.gif\" title=\"ar wall occlusion demo\" height=\"200\"\u003e \u0026nbsp;\u0026nbsp;\u0026nbsp;\u003cimg src=\"/resources/gifs/iphone_demo.gif\" title=\"iphone demo\" height=\"200\"\u003e\u003c/p\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \n  [![NPM Package](https://img.shields.io/npm/v/digitalbacon)](https://www.npmjs.com/package/digitalbacon) [![Build Size](https://badgen.net/bundlephobia/minzip/digitalbacon)](https://bundlephobia.com/result?p=digitalbacon) [![NPM Downloads](https://img.shields.io/npm/dw/digitalbacon)](https://www.npmtrends.com/digitalbacon) \u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n  \n\u003c/div\u003e\n\n### How to use\nGo to the [Digital Bacon Editor](https://digitalbacon.io/app) to create a 3D website and then save your project zip file. You can then host your project using the below html snippet (or just [fork this repo](https://github.com/kalegd/DigitalBaconSampleProject) and replace my-project.zip with your project file)\n```html\n\u003chtml\u003e\n  \u003chead\u003e\n    \u003cscript type=\"importmap\"\u003e\n      {\n        \"imports\": {\n          \"DigitalBacon\": \"https://cdn.jsdelivr.net/npm/digitalbacon@latest/build/DigitalBacon.min.js\"\n        }\n      }\n    \u003c/script\u003e\n  \u003c/head\u003e\n  \u003cbody\u003e\n    \u003cdiv id=\"my-container-id\"\u003e\u003c/div\u003e\n    \u003cscript type=\"module\"\u003e\n      import { setup } from 'DigitalBacon';\n\n      let params = { projectFilePath: './my-project.zip'};\n\n      setup(\"my-container-id\", params);\n    \u003c/script\u003e\n  \u003c/body\u003e\n\u003c/html\u003e\n```\n\n### Adding Multi-User Support\n\nYou'll need an authUrl and socketUrl tied to a server to handle all the handshaking and management between users. [My Digital Bacon](https://mydigitalbacon.com) offers a free tier that you can use for this purpose, just create an account and add your website's origin as an external project and you'll get the necessary urls to be plugged into your setup parameters like so\n```javascript\nlet params = {\n    projectFilePath: './my-project.zip',\n    authUrl: '{AUTH_URL}',\n    socketUrl: '{WEBSOCKET_URL}',\n};\nsetup(\"my-container-id\", params);\n```\n\n### Local Network Testing\n\nIf you want to test your changes with another device on your local network, you can run `npm run start-ssl`. Before doing this you'll need to create both cert.pem and key.pem files. Mac Users can generate these files via `openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout key.pem -out cert.pem`\n\n## Contributors\n\nA special thanks to the following people for taking time to contribute to this project\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/prajwalbandak\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/62823252?v=4?s=100\" width=\"100px;\" alt=\"prajwalbandak\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eprajwalbandak\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"#infra-prajwalbandak\" title=\"Infrastructure (Hosting, Build-Tools, etc)\"\u003e🚇\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/laurittab\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/57863817?v=4?s=100\" width=\"100px;\" alt=\"Lauritta\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eLauritta\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"#infra-laurittab\" title=\"Infrastructure (Hosting, Build-Tools, etc)\"\u003e🚇\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/justjo3l\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/63659576?v=4?s=100\" width=\"100px;\" alt=\"Joel Jose\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eJoel Jose\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/kalegd/DigitalBacon/commits?author=justjo3l\" title=\"Tests\"\u003e⚠️\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/ShaunFrost\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/7031459?v=4?s=100\" width=\"100px;\" alt=\"Rasesh Kumar Rout\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eRasesh Kumar Rout\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/kalegd/DigitalBacon/commits?author=ShaunFrost\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/kaigidwani\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/112210757?v=4?s=100\" width=\"100px;\" alt=\"kaigidwani\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003ekaigidwani\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/kalegd/DigitalBacon/commits?author=kaigidwani\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkalegd%2Fdigitalbacon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkalegd%2Fdigitalbacon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkalegd%2Fdigitalbacon/lists"}