Open Brush is the open source, community led evolution of Tilt Brush! Forked from https://github.com/googlevr/tilt-brush
Open Brush is the open source, community led evolution of Tilt Brush! Forked from https://github.com/googlevr/tilt-brush
Open Brush is a free fork of Tilt Brush, a room-scale 3D-painting virtual-reality application available from Google, originally developed by Skillman & Hackett. We have made a large number of changes from the original repository, including Unity upgrades and feature additions to bring Open Brush up to modern XR development standards. You can find the notable changes on our docs site.
We hope to maintain and improve upon Tilt Brush as a community-led project, free forever!
As the original repo is archived we cannot submit PRs, so feel free to submit them here!
User Guide
Developer Notes
Roadmap
Please join the Icosa Discord and get involved!
List of tutorials, write-ups and other things from the community
Support us on Open Collective
Instead of waiting for a formal release, you can download a ZIP from Github containing an automatically built release for either Windows (SteamVR) or Oculus Quest / Quest 2 from the Github releases page. Versions of the form "vX.Y.0" are official releases, whereas versions that do not end in .0 are made available for testing purposes only, with no guarantees as to their quality. Additionally, these releases are marked as "pre-release". However, if you'd like to test a recent change prior to the official release, you can use these either in place of or in parallel with the formal Open Brush releases.
These builds share a save location with the official Open Brush release, but can be installed alongside the formal version. The Oculus build, like all sideloaded content, will be listed in "Unknown Sources", and will have the word "Github" appended to the name (with a different package name as well) to differentiate it from the official release).
Note that the "experimental" builds contain experimental brushes, and sketches created using the experimental brushes may appear differently when loaded in the official build of Open Brush!
In addition, there is also a version created for Windows Monoscopic that is listed as an "Artifact" of the Github Actions, however, this is intended only for developers, and should not be used by general users. You can find it by browsing to the commit list, and then clicking on the green check mark below the title (next to the XXX committed XXX ago), and scroll to the build you want, and click on Details. Then, towards the upper right corner, click on Artifacts and click on the name of the build. Unzip the downloaded file, and either run the executable (Desktop OpenXR/Monoscopic) or install the apk (Android Oculus) using adb install com.Icosa.OpenBrush-github.apk.
The Tilt Brush trademark and logo (“Tilt Brush Trademarks”) are trademarks of Google, and are treated separately from the copyright or patent license grants contained in the Apache-licensed Tilt Brush repositories on GitHub. Any use of the Tilt Brush Trademarks other than those permitted in these guidelines must be approved in advance.
For more information, read the Tilt Brush Brand Guidelines.
Get the Open Brush open-source application running on your own devices.
Support/bin directory)
Tested with Python 3.8.Follow these steps when running the application for the first time:
/Assets/Scenes/Main.unity. Unity should automatically prompt you to
import TextMesh Pro.When no VR headset is detected, Open Brush can be navigated using the WASD keys or a connected gamepad.
These steps have been tested with Release 1.0.54.
Although it's possible to build Open Brush using the standard Unity build tools, we recommend using a build script to ensure the application builds with the correct settings. To run this script, go to Open Brush > Build > Do Build, or build from the Open Brush build window by navigating to Open Brush > Build > Build Window.
Note: The application may take a while to build the first time.
Use the build script in the Support/bin directory to specify the target
platform and the build options you wish to enable. Run build —help to see the
various build options.
You should be able to get the basic version of Open Brush up and running very quickly. The following features will take a little more time.
Some systems in Tilt Brush were removed or replaced with alternatives due to open-source licensing issues. These are:
Credentials for services such as Google and Sketchfab are stored in a SecretsConfig scriptable object. This has been ignored in the git config for safety. To add it back:
/Assets folder in Unity's project window.
Select Create, then Secrets Config. This will create Secrets.asset in the Asset folder.Scenes/Main.unity go to App > Config and replace SecretsExample
with the newly generated Secrets.asset.Set up Google API support to access Google services in the app.
Follow these steps when enabling Google service APIs:
Create a new project in the Google Cloud Console.
Enable the following APIs and services:
Note: The name of your application on the developer console should match the
name you've given the app in App.kGoogleServicesAppName in App.cs.
Follow these steps when creating a Google API key:
The OAuth consent screen asks users for permission to access their Google account. You should be able to configure it from the Credentials screen.
Follow these steps when configuring the OAuth consent screen:
Fill in the name and logo of your app, as well as the scope of the user data that the app will access.
Add the following paths to the list of scopes:
../auth/drive.appdata../auth/drive.fileThe credential identifies the application to the Google servers. Follow these steps to create an OAuth credential:
Follow these steps to store the Google API Key and credential data:
Google as the service. Paste in the API key, client ID, and client
secret that were generated earlier.Follow these steps to build your app for Oculus Quest:
../Builds/OculusMobile_Release_OpenBrush/.adb install com.Icosa.OpenBrush.apk.No open issues yet, or sync has not completed.