• This project is a sub-project of XRCLOUD (https://xrcloud.app), an open-source project that aimed to provide membership-based cloud services for Hubs' Room and Scene resources, by forking the hubs project from BELIVVR and developing additional features.

  • (Korean) 본 프로젝트는 BELIVVR에서 hubs 프로젝트를 fork하여 추가 기능을 개발하고, Hubs의 Room, Scene의 자원들을 회원제로 별도의 회원제 클라우드로 서비스를 제공하는 것을 목표 했던 XRCLOUD(https://xrcloud.app) 오픈소스 프로젝트의 서브 프로젝트 입니다.

• This repository is forked from dialog created by hubfoundation.

  • (Korean) 본 저장소는 hubfoundation에서 만든 hubs를 fork한 저장소입니다.

• This Project was created as a sub-project of hubs-all-in-one, a project that runs the hubs project created by BELIVVR on a single host. For detailed information about XRCLOUD, please refer to the XRCLOUD project page.

  • (Korean) 본 프로젝트는 BELIVVR 에서 만든 hubs프로젝트를 단일 호스트에서 실행하는 프로젝트 hubs-all-in-one의 서브 프로젝트로 만들었습니다. XRCLOUD의 상세한 설명은 XRCLOUD 프로젝트 페이지를 참고 바랍니다.

• As of February 2025, BELIVVR is releasing this as open source (https://github.com/belivvr/xrcloud) as the company will not be proceeding with further development due to operational difficulties.

  • 2025년 2월, BELIVVR는 기업의 운영이 어려워 추가 개발을 진행하지 않으므로 오픈 소스(https://github.com/belivvr/xrcloud)로 공개 합니다.

• For additional inquiries, please contact the former CEO of BELIVVR, Luke Yang (fstory97@gmail.com).

  • (Korean) 추가 문의는 BELIVVR의 대표 였던 양병석 대표(fstory97@gmail.com)에게 문의 바랍니다.

• Below is the original README.md at the time of forking.

  • (Korean) 아래는 fork할 당시 원본 README.md 입니다.

Mozilla Hubs

The client-side code for Mozilla Hubs, an online 3D collaboration platform that works for desktop, mobile, and VR platforms.

Learn more about Hubs

Getting Started

If you would like to run Hubs on your own servers, check out Hubs Cloud.

If you would like to deploy a custom client to your existing Hubs Cloud instance please refer to this guide.

If you would like to contribute to the main fork of the Hubs client please see the contributor guide.

If you just want to check out how Hubs works and make your own modifications continue on to our Quick Start Guide.

Quick Start

Install NodeJS if you haven't already. We use 16.16.0 on our build servers. If you work on multiple javascript projects it may be useful to use something like NVM to manage multiple versions of node for you.

Run the following commands:

git clone https://github.com/mozilla/hubs.git
cd hubs
# nvm use v16.16.0 # if using NVM
npm ci
npm run dev

The backend dev server is configured with CORS to only accept connections from "hubs.local:8080", so you will need to access it from that host. To do this, you likely want to add "hubs.local" and "hubs-proxy.local" to the local "hosts" file on your computer:

127.0.0.1	hubs.local
127.0.0.1	hubs-proxy.local

Then visit https://hubs.local:8080 (note: HTTPS is required, you'll need to accept the warning for the self-signed SSL certificate)

Note: When running the Hubs client locally, you will still connect to the development versions of our Janus WebRTC and reticulum servers. These servers do not allow being accessed outside of localhost. If you want to host your own Hubs servers, please check out Hubs Cloud.

Documentation

The Hubs documentation can be found here.

Community

Join us on our Discord Server or follow us on Twitter.

Contributing

Read our contributor guide to learn how you can submit bug reports, feature requests, and pull requests.

We're also looking for help with localization. The Hubs redesign has a lot of new text and we need help from people like you to translate it. Follow the localization docs to get started.

Contributors are expected to abide by the project's Code of Conduct and to be respectful of the project and people working on it.

Additional Resources

• Reticulum - Phoenix-based backend for managing state and presence.
• NAF Janus Adapter - A Networked A-Frame adapter for the Janus SFU service.
• Janus Gateway - A WebRTC proxy used for centralizing network traffic in this client.
• Janus SFU Plugin - Plugins for Janus which enables it to act as a SFU.
• Hubs-Ops - Infrastructure as code + management tools for running necessary backend services on AWS.

Privacy

Mozilla and Hubs believe that privacy is fundamental to a healthy internet. Read our privacy policy for more info.

License

Hubs is licensed with the Mozilla Public License 2.0