matrix-org / matrix-org/thirdroom

Get Third Room working on GitHub Pages

Open
#590 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
C
Stars
647
Forks
70
PR merge metrics
No merged PRs in 30d

Description

We're using netlify right now, but it'd be great if anyone could fork the repo and instantly have a working client and build system set up. GitHub Pages doesn't have a way that I know of to add COOP/COEP headers though. We should look into whether there's a zero config option to host after forking.

One possibility I found is to use a ServiceWorker. There are some limitations as you need to ensure that the the page is served via the ServiceWorker before it can load a script with SharedArrayBuffe, but I think we could work around that. https://dev.to/stefnotch/enabling-coop-coep-without-touching-the-server-2d3n

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are identified. Start by reviewing the current Netlify setup and the linked ServiceWorker approach for COOP/COEP, then assess whether GitHub Pages can support a forked client and build system; done means a fork deploys a working client without manual configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, javascript, typescript
Domain
build-system, devops, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.