Skip to content

Commit

Permalink
General README tidyup (#157)
Browse files Browse the repository at this point in the history
  • Loading branch information
@mikeskydev
mikeskydev authored Aug 11, 2021
1 parent b7ceac5 commit bd0af4c
Showing 1 changed file with 35 additions and 40 deletions.
75 changes: 35 additions & 40 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,32 +1,36 @@
# Open Brush - A Tilt Brush fork

[![Support us on Open Collective!](https://img.shields.io/opencollective/all/icosa?logo=open-collective&label=Support%20us%20on%20Open%20Collective%21)](https://opencollective.com/icosa)
[![All GitHub releases](https://img.shields.io/github/downloads/icosa-gallery/open-brush/total?label=GitHub%20downloads)](https://github.com/icosa-gallery/open-brush/releases/latest)
[![Twitter](https://img.shields.io/badge/follow-%40IcosaGallery-blue.svg?style=flat&logo=twitter)](https://twitter.com/IcosaGallery)
[![Discord](https://discordapp.com/api/guilds/783806589991780412/embed.png?style=shield)](https://discord.gg/W7NCEYnEfy)
[![Open Collective backers and sponsors](https://img.shields.io/opencollective/all/icosa?logo=open-collective)](https://opencollective.com/icosa)

## Current Version: `0.3.0`

We hope to help maintain Tilt Brush.
**Current Version: ![Current Version](https://img.shields.io/github/v/release/icosa-gallery/open-brush)**

**Pre-release Version: ![Prerelease Version](https://img.shields.io/github/v/release/icosa-gallery/open-brush?include_prereleases&label=prerelease)**

Open brush is a fork of Tilt Brush, a room-scale 3D-painting virtual-reality application available from Google, originally developed by Skillman & Hackett. 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!

[Please join the Icosa Discord and get involved!](https://discord.com/invite/W7NCEYnEfy)
[Trello](https://trello.com/b/jItetqYe/open-brush)
[Open Brush Trello](https://trello.com/b/jItetqYe/open-brush)
[List of tutorials, write-ups and other things from the community](https://docs.google.com/document/d/1gjoYp4y-1qlE3a7fvXVxGR3ioj3nMfgprmTHQ-bpq0k/)
[Support us on Open Collective](https://opencollective.com/icosa)
**[Support us on Open Collective!](https://opencollective.com/icosa)**

## Downloads

- [Itch.io Store](https://openbrush.itch.io/openbrush)
### Stores (Did we mention it's free?)
- [itch.io](https://openbrush.itch.io/openbrush)
- [SideQuest](https://sidequestvr.com/app/2852/open-brush)
- [Oculus App Lab](https://www.oculus.com/experiences/quest/3600360710032222)
- [Oculus Rift](https://www.oculus.com/experiences/rift/5227489953989768)
- [Steam](https://store.steampowered.com/app/1634870/Open_Brush)
- [Viveport Desktop](https://www.viveport.com/f1f3d00b-cf8a-443f-825e-4fea2dd3b005)
### GitHub
- [Formal GitHub Releases](https://github.com/icosa-gallery/open-brush/releases/latest)
- [Bleeding Edge GitHub Releases](#bleeding-edge-releases)

### Currently we are:
* Getting Open Brush to work with the Poly replacement, [Icosa](https://github.com/icosa-gallery).
* Looking at modding support (custom brushes!)

See our [Trello](https://trello.com/b/jItetqYe/open-brush) board for more information.

## Acknowledgements
* Thank you to the Tilt Brush developers for your amazing work!
Expand All @@ -41,15 +45,9 @@ These builds share a save location with the official Open Brush release, but can

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 are also versions created for Linux (SteamVR and Monoscopic), OS X (Monoscopic only), and Windows Monoscopic that are listed as "Artifacts" of the Github Actions, however, these are intended only for developers, and should not be used by general users. You can find them by browsing to the [commit list](https://github.com/icosa-gallery/open-brush/commits/main), 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 (6)** and click on the name of the build. Unzip the downloaded file, and either run the executable (Desktop SteamVR/Monoscopic) or install the apk (Android Oculus) using `adb install com.Icosa.OpenBrush-github.apk`. Note that if you download a Mac OS X build, you'll need to run `xattr -d com.apple.quarantine /path/to/OpenBrush-github.app` prior to be able to launch the app, as it is not signed with Apple developer keys.
---
In addition, there are also versions created for Linux (SteamVR and Monoscopic), OS X (Monoscopic only), and Windows Monoscopic that are listed as "Artifacts" of the Github Actions, however, these are intended only for developers, and should not be used by general users. You can find them by browsing to the [commit list](https://github.com/icosa-gallery/open-brush/commits/main), 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 (6)** and click on the name of the build. Unzip the downloaded file, and either run the executable (Desktop SteamVR/Monoscopic) or install the apk (Android Oculus) using `adb install com.Icosa.OpenBrush-github.apk`. Note that if you download a Mac OS X build, you'll need to run `xattr -d com.apple.quarantine /path/to/OpenBrush-github.app` prior to be able to launch the app, as it is not signed with Apple developer keys.

# Tilt Brush README

Tilt Brush is licensed under Apache 2.0. It is not an officially supported
Google product. See the [LICENSE](LICENSE) file for more details.

## Trademarks
## Important note from the original Tilt Brush README

The Tilt Brush trademark and logo (“Tilt Brush Trademarks”) are trademarks of
Google, and are treated separately from the copyright or patent license grants
Expand All @@ -60,9 +58,11 @@ approved in advance.
For more information, read the
[Tilt Brush Brand Guidelines](BRAND_GUIDELINES.md).

## Building the application
---

Get the Tilt Brush open-source application running on your own devices.
# Building the application

Get the Open Brush open-source application running on your own devices.

### Prerequisites

Expand All @@ -89,10 +89,10 @@ These steps have been tested with Release 1.0.54.

### Building the application from the Unity editor

Although it's possible to build Tilt Brush using the standard Unity build tools,
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 **Tilt** > **Build** > **Do Build**,
or build from the Tilt Brush build window by navigating to **Tilt** >
or build from the Open Brush build window by navigating to **Tilt** >
**Build** > **Build Window**.

Note: The application may take a while to build the first time.
Expand All @@ -105,18 +105,14 @@ various build options.

### Additional features

You should be able to get the basic version of Tilt Brush up and running very
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.

* [Google service API support](#google-service-api-support)
* [Enabling native Oculus support](#enabling-native-oculus-support)
* [Sketchfab support](#sketchfab-support)
* [Offline rendering support](#offline-rendering-support)

**Note:** Uploading to Poly has been removed completely and cannot be added back
in, because it uses an internal Google API. Download from Poly can still be
enabled.

## Systems that were replaced or removed when open-sourcing Tilt Brush

Some systems in Tilt Brush were removed or replaced with alternatives due to
Expand Down Expand Up @@ -160,7 +156,6 @@ Follow these steps when enabling Google service APIs:
1. Enable the following APIs and services:

* **YouTube Data API v3** — for uploading videos to YouTube
* **Poly API** — for accessing the Poly model library
* **Google Drive API** — for backup to Google Drive
* **People API** — for username and profile picture

Expand Down Expand Up @@ -211,10 +206,10 @@ Follow these steps to store the Google API Key and credential data:

Note: _Tilt Brush_ is a Google trademark. If you intend to publish a cloned
version of the application, you are required to
[choose a different name](#changing-the-application-name) to distinguish it from
choose a different name to distinguish it from
the official version.

Tilt Brush targets SteamVR instead of Oculus by default. Follow these steps to
Open Brush targets SteamVR instead of Oculus by default. Follow these steps to
enable native Oculus support:

1. Enable the Oculus desktop package in the Package Manager.
Expand Down Expand Up @@ -259,9 +254,9 @@ Follow these steps to publish to Oculus stores:
have their own entries.
1. Put the app IDs in the `Client ID` field for each.

## Tilt Brush intro sketch
## Open Brush intro sketch

The Tilt Brush intro sketch uses some slightly modified shaders to produce the
The Open Brush intro sketch uses some slightly modified shaders to produce the
animating-in effect while the sketch fades in. For faster loading, the intro
sketch is turned into a `*.prefab` file beforehand. Only the shaders used in the
intro sketch have been converted to work with the introduction.
Expand All @@ -278,7 +273,7 @@ intro sketch have been converted to work with the introduction.

Follow these steps to replace or alter the intro sketch:

1. Make sure the sketch of your choice is already loaded. Run Tilt Brush in the
1. Make sure the sketch of your choice is already loaded. Run Open Brush in the
Unity Editor.
1. Select **Tilt** > **Convert To Intro Materials** in the main Unity menu.
This converts the materials in the sketch to the intro versions. \
Expand All @@ -301,7 +296,7 @@ Follow these steps to replace or alter the intro sketch:

You may want to have a pared-down version of the intro sketch for the mobile
version of the app. Stroke simplification is located in the **Settings** menu
inside Tilt Brush.
inside Open Brush.

## Sketchfab support

Expand Down Expand Up @@ -339,9 +334,9 @@ angled too far. Fix this by doing the following:

## Offline rendering support

When the user records a video from a saved sketch in Tilt Brush, a `.bat` file
When the user records a video from a saved sketch in Open Brush, a `.bat` file
is generated next to the `.mp4` for offline rendering support. This `.bat` file
requires the path to the executable of Tilt Brush. The code for writing out this
requires the path to the executable of Open Brush. The code for writing out this
path to the file has been removed.

Follow these steps to restore the path:
Expand All @@ -362,7 +357,7 @@ panel while disabling the intro sequence.

**New features and brushes that you find in experimental mode may not work as
expected.** Sketches that use experimental features and brushes won't work on
Poly or Sketchfab, and may break if loaded into production versions of Tilt
Icosa or Sketchfab, and may break if loaded into production versions of Tilt
Brush.

### Turning on experimental mode
Expand All @@ -372,7 +367,7 @@ Follow these steps to turn on experimental mode:
1. Find the Config object in the main scene by going to **App** > **Config**.
1. Turn on the **Is Experimental** flag.

The Tilt Brush build system will then set up the experimental flag as needed
The Open Brush build system will then set up the experimental flag as needed
when you make a build.

### Making your code experimental
Expand Down

0 comments on commit bd0af4c

Please sign in to comment.