How to open a Flock XR project hosted on GitHub

You can open a Flock XR project that is hosted on GitHub by using the file’s raw GitHub address.

This is useful if you want to:

• share a Flock XR project from a GitHub repository
• open a .flock file without downloading it first
• link students, collaborators, or learners directly to a project
• keep example projects in version control

To do this, you need two things:

1. The raw file address from GitHub
2. A Flock XR link using the ?project= URL parameter

The finished link will look like this:

https://app.flockxr.com/?project=https://raw.githubusercontent.com/USERNAME/REPOSITORY/BRANCH/path/to/project.flock

What is a raw GitHub file address?

A normal GitHub file page shows the file inside the GitHub interface, with menus, buttons, syntax highlighting, comments, and repository navigation.

A raw file address points directly to the file itself.

For Flock XR, this matters because the project parameter needs the actual .flock file address, not the GitHub page that displays the file.

A normal GitHub file URL usually looks like this:

https://github.com/USERNAME/REPOSITORY/blob/main/project.flock

A raw GitHub file URL usually looks like this:

https://raw.githubusercontent.com/USERNAME/REPOSITORY/main/project.flock

Before you start

Make sure your project file is:

• saved as a .flock file
• uploaded to a GitHub repository
• in a public repository, or otherwise accessible to the person opening the link

If the file is in a private repository, Flock XR may not be able to load it for other users unless they have access and the browser can retrieve the file.

Step 1: Open your project file on GitHub

Go to your GitHub repository and find the Flock XR project file you want to open.

For example, this might be a file named:

my-project.flock

Click the file name to open it in GitHub.

Step 2: Click the Raw button

On the GitHub file page, click Raw.

GitHub will open the plain file view. This is the version of the file that Flock XR needs.

Step 3: Copy the raw file address

After clicking Raw, copy the full address from your browser’s address bar.

It should start with:

https://raw.githubusercontent.com/

For example:

https://raw.githubusercontent.com/example-user/example-repo/main/projects/space-scene.flock

Step 4: Add the raw address to a Flock XR project link

Start with the Flock XR app URL:

https://app.flockxr.com/

Then add:

?project=

Finally, paste the raw GitHub file address after it.

Example:

https://app.flockxr.com/?project=https://raw.githubusercontent.com/example-user/example-repo/main/projects/space-scene.flock

When someone opens this link, Flock XR will try to load the project file from GitHub.

Step 5: Open the project without running it

By default, Flock XR runs the project when it loads.

To open the project in the editor without running it automatically, add:

&autoplay=false

Example:

https://app.flockxr.com/?project=https://raw.githubusercontent.com/example-user/example-repo/main/projects/space-scene.flock&autoplay=false

This is useful when you want learners to inspect or edit the project before running it.

Common problems

My link opens GitHub instead of Flock XR

Check that your final link starts with:

https://app.flockxr.com/?project=

The GitHub raw file address should come after ?project=.

My project does not load

Check that the GitHub address starts with:

https://raw.githubusercontent.com/

If the address contains /blob/, it is probably the normal GitHub file page rather than the raw file address.

Incorrect:

https://github.com/USERNAME/REPOSITORY/blob/main/project.flock

Correct:

https://raw.githubusercontent.com/USERNAME/REPOSITORY/main/project.flock

The project loads for me but not for someone else

Make sure the repository or file is public.

If the file is in a private repository, other users may not be able to access it.

Example GitHub to Flock XR workflow

Here is the full process:

1. Upload your Flock XR project file to GitHub.
2. Open the .flock or file in GitHub.
3. Click Raw.
4. Copy the raw GitHub address.
5. Add it after https://app.flockxr.com/?project=.
6. Add &autoplay=false if you want the project to open without running.

Example final link:

https://app.flockxr.com/?project=https://raw.githubusercontent.com/example-user/example-repo/main/project.flock&autoplay=false

Frequently asked questions

Can I open a Flock XR project stored on GitHub?

Yes. Upload the .flock or project file to GitHub, copy the file’s raw address, and add it to a Flock XR link using ?project=.

What kind of GitHub link does Flock XR need?

Flock XR needs the raw file address. This usually starts with:

https://raw.githubusercontent.com/

A normal GitHub file page that contains /blob/ is not the same as the raw file address.

Can I use GitHub to share Flock XR projects with students?

Yes. GitHub can be used to host Flock XR project files. Once you have the raw file address, you can create a Flock XR link that opens the project directly.

Can I stop the project from running automatically?

Yes. Add &autoplay=false to the end of the Flock XR link.

Example:

https://app.flockxr.com/?project=https://raw.githubusercontent.com/example-user/example-repo/main/project.flock&autoplay=false

Related article

For more ways to use Flock XR URL parameters, see:

👉 How to load specific projects in Flock XR