Skip to content

Commit

Permalink
README updates: update GIF of new demo scene; add screenshot and link…
Browse files Browse the repository at this point in the history
… to Unity Asset Store detail page; add Support + Credits sections (borrowed from blog post)
  • Loading branch information
cvan committed Feb 15, 2018
1 parent 667f3df commit 36ac5c4
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 15 deletions.
56 changes: 41 additions & 15 deletions README.md
@@ -1,55 +1,81 @@
# Unity WebVR Assets

Assets for creating [WebVR](https://webvr.rocks/)-enabled [Unity3D](https://unity3d.com/) projects.

![Preview of Unity WebVR-exported project in the browser](https://raw.githubusercontent.com/mozilla/unity-webvr-export/master/img/preview.gif)

## **[Try it out!](https://mozilla.github.io/unity-webvr-export/)**
## **[Try the demo out now!](https://mozilla.github.io/unity-webvr-export/)**

Assets for creating [WebVR](https://webvr.rocks/)-enabled [Unity3D](https://unity3d.com/) projects.
**[Free to download](https://assetstore.unity.com/packages/templates/systems/webvr-assets-109152)** and available now on the [Unity Asset Store](https://assetstore.unity.com/packages/templates/systems/webvr-assets-109152).

## Supported Unity Versions
[![Download the WebVR Assets package for free on the Unity Asset Store](https://raw.githubusercontent.com/mozilla/unity-webvr-export/master/img/asset-store.png)](https://assetstore.unity.com/packages/templates/systems/webvr-assets-109152)

These assets work with Unity versions `2017.3.0` or higher.
<hr>

## Compatibility

These assets work with Unity versions `2017.2.0f3` and later.

### Browser Compatibility

| Platform | Browser | Compatible headsets | |
| --- | --- | --- | --- |
| Desktop | Firefox | HTC VIVE, Oculus Rift, Windows Mixed Reality headsets (using Steam VR) | [Setup instructions](https://webvr.rocks/firefox) |
| Desktop | Microsoft Edge | Windows Mixed Reality headsets | [Setup instructions](https://webvr.rocks/microsoft_edge) |
| Desktop | Chrome Canary | HTC VIVE, Oculus Rift, Windows Mixed Reality headsets | Browser flags required. [Setup instructions](https://webvr.rocks/chrome#setup) |
| Desktop | Chrome Canary | HTC VIVE, Oculus Rift, Windows Mixed Reality headsets | Browser flags required. [Setup instructions](https://webvr.rocks/chrome) |

### Polyfilled WebVR

If the user does not have a supported headset, browser, or device, the web page will still work through the use of the [WebVR Polyfill](https://github.com/immersive-web/webvr-polyfill).
If the user does not have supported headset, browser or device, the content will still work through the use of the [WebVR Polyfill](https://github.com/immersive-web/webvr-polyfill).

### Mobile support

This asset works by utilizing [Unity's WebGL platform support](https://docs.unity3d.com/2018.1/Documentation/Manual/webgl-gettingstarted.html) and therefore shares the same limitations. Because of this, mobile support is limited and may not work. See [Unity's **WebGL Browser Compatibility** table](https://docs.unity3d.com/2018.1/Documentation/Manual/webgl-browsercompatibility.html).

#### Chrome for Android
This asset works by utilizing Unity's WebGL platform support and therefore shares the same limitations. Because of this, mobile support is limited and may not work. See [Unity's WebGL browser compatibility](https://docs.unity3d.com/2018.1/Documentation/Manual/webgl-browsercompatibility.html).

For WebVR content to work with the regular release version of Chrome for Android, users will need to [manually enable WebVR and Gamepad extensions](https://webvr.rocks/chrome_for_android#setup) from `chrome://flags`.

Alternatively, sites can register for a [WebVR Origin Trial token](https://webvr.rocks/chrome_for_android#what_is_the_webvr_origin_trial) which will allows the API to be available for whitelisted origins.

## Getting started

* [Setting up a Unity project for WebVR](./docs/project-setup.md)
* [Publishing](./docs/publishing.md)
* [Controllers and input system](./docs/controllers.md)


## Need help?

* [Join the **WebVR Slack** and chat with us **`#unity` channel**](https://webvr.rocks/slack)
* [Join the WebVR Slack](https://webvr.rocks/slack) (join the [#unity channel](https://webvr.slack.com/messages/unity))


## Contributing

Contributions from the developer community are very important to us. You're encouraged to [open an issue](https://github.com/mozilla/unity-webvr-export/issues/new), report a problem, contribute with code, open a feature request, share your work, or ask a question.
Contributions from the developer community are very important to us. You're encouraged to [open an issue](https://github.com/mozilla/unity-webvr-export/issues/new), report a problem, contribute with code, open a feature request, share your work or ask a question.

Be sure to check out the contributor guides as well:
Take a look at the contributor guides too.

* [Building the Unity Assets Package](./docs/build.md)


## We want to hear from you!

We’d love to hear about what you come up with using the _WebVR Assets_. **Share your work with us** and use the [#unitywebvr](https://twitter.com/search?f=tweets&q=%23unitywebvr) Twitter hashtag.

The Unity WebVR Assets is an open-source project (licensed under Apache 2) [available on GitHub](https://github.com/mozilla/unity-webvr-export).

* [View known issues](https://github.com/mozilla/unity-webvr-export/issues)
* [File an issue or feature request](https://github.com/mozilla/unity-webvr-export/issues/new)
* [Contribute code or documentation to the project](https://github.com/mozilla/unity-webvr-export#contributing)

Reach out to us with any questions you may have or help you may need, and participate in the discussions on the [WebVR Slack](https://webvr.rocks/slack) in the [#unity channel](https://webvr.slack.com/messages/unity).

* [Join the WebVR Slack](https://webvr.rocks/slack) (join the [#unity channel](https://webvr.slack.com/messages/unity))


## Credits

This project was heavily influenced by early explorations in using Unity to build for WebVR by [@gtk2k](https://github.com/gtk2k).

Also, thanks to [@arturitu](https://github.com/arturitu) for creating the [3D-hand models](https://github.com/aframevr/assets/tree/gh-pages/controllers/hands) used for controllers in these examples.


## License

Copyright 2017 - 2018 Mozilla Corporation
Expand Down
Binary file added img/asset-store.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/preview-boxes.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified img/preview.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 36ac5c4

Please sign in to comment.