Latest Sceneform version

CONTRIBUTING.md

@@ -1,7 +1,10 @@
 # How to Contribute
 
-We'd love to accept your patches and contributions to the source code included
-in this project. There are just a few small guidelines you need to follow.
+Please use the [issue tracker](https://github.com/google-ar/sceneform-android-sdk/issues)
+to report any issue as we do not accept pull requests for this repository.
+
+If you'd like to send us a patch or pull request, there are just a few small
+guidelines you need to follow.
 
 ## Contributor License Agreement
 
@@ -15,15 +18,7 @@ You generally only need to submit a CLA once, so if you've already submitted one
 (even if it was for a different project), you probably don't need to do it
 again.
 
-## Code reviews
-
-Although we do not use the normal GitHub pull request process to incorporate
-contributions, it's okay to send us pull requests. Once we have received your
-CLA we will review and consider your contribution for inclusion in a future
-release of the SDK.
-
 ## Community Guidelines
 
-This project follows
-[Google's Open Source Community
+This project follows [Google's Open Source Community
 Guidelines](https://opensource.google.com/conduct/).

MIGRATING-1.15.0-1.16.0.md

@@ -0,0 +1,30 @@
+# Migrating from Sceneform 1.15.0 to 1.16.0
+
+As of ARCore release 1.16.0, Google open-sourced the implementation of Sceneform
+to allow you to extend Sceneform's features and capabilities. If you're
+interested in using the latest Sceneform release, we recommend upgrading to
+version 1.16.0 and invite you to make your own modifications to the SDK.
+
+To migrate an existing project using Sceneform version 1.15.0 to version 1.16.0,
+follow the following steps:
+
+
+## Convert existing `SFA` / `SFB` assets
+
+In the interest of adopting open standards, the support for `SFA` and `SFB`
+files has been removed in 1.16.0 and replaced with
+[`glTF`](https://www.khronos.org/gltf/) support. Refer to the [GltfActivity](https://github.com/google-ar/sceneform-android-sdk/blob/master/samples/gltf/app/src/main/java/com/google/ar/sceneform/samples/gltf/GltfActivity.java#L104)
+activity to see an example of how to load a `glTF` file.
+
+## Migrate Sceneform dependencies
+
+1. Remove the Sceneform plugin from your project's `build.gradle`:
+   * `classpath 'com.google.ar.sceneform:plugin:1.15.0'`
+1. Remove the Sceneform dependencies from your app's `build.gradle`:
+   * `implementation 'com.google.ar.sceneform.ux:sceneform-ux:1.15.0'`
+   * `implementation 'com.google.ar.sceneform:core:1.15.0'`
+   * `implementation 'com.google.ar.sceneform:animation:1.15.0'`.
+1. Remove any Sceneform asset references from your app's `build.gradle`:
+   * `apply plugin: 'com.google.ar.sceneform.plugin'`
+   * All `sceneform.asset(…)` directives
+1. Follow the setup guide in the [README.md](https://github.com/google-ar/sceneform-android-sdk/tree/master/README.md) to include the 1.160.0 Sceneform SDK in your app.

README.md

@@ -1,33 +1,207 @@
-Sceneform SDK for Android
-=====================
-Copyright (c) 2018 Google Inc.  All rights reserved.
-
-Sceneform is a 3D framework, with a physically based renderer, that's optimized for mobile, and that makes it easy for Java developers to build augmented reality apps.
+# Status: Archived
+This repository has been archived and is no longer maintained.
 
-Please note, we do not accept pull requests.
+![status: inactive](https://img.shields.io/badge/status-inactive-red.svg)
 
+Sceneform SDK for Android
+=========================
+Copyright (c) 2018 Google Inc.  All rights reserved.
 
-## Getting Started
+Sceneform is a 3D framework with a physically based renderer that's optimized
+for mobile devices and that makes it easy for you to build augmented reality
+apps without requiring OpenGL.
+
+
+## Choosing the right Sceneform SDK version for your project
+
+As of ARCore release 1.16.0, Google open-sourced the implementation of Sceneform
+allowing you to extend Sceneform's features and capabilities. As part of the
+1.16.0 release, support for `SFA` and `SFB` assets was removed in favor of
+adding `glTF` support
+
+You can continue to use Sceneform 1.15.0 (or earlier). There is no requirement
+that you migrate to Sceneform 1.16.0.
+
+Do not use Sceneform 1.17.0 as that release will not work correctly. (Sceneform
+1.17.1 can be used, but is otherwise identical to Sceneform 1.15.0.)
+
+
+<table>
+  <tr>
+    <th>Sceneform SDK</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td>Sceneform SDK<br>versions <b>1.0.0 - 1.15.0</b></td>
+    <td>
+      <ul>
+        <li>Closed source</li>
+        <li>Included in your project as an external Gradle dependency</li>
+        <li>
+          <code>FBX</code> and <code>OBJ</code> files can be converted to
+          Sceneform's <code>SFA</code> and <code>SFB</code> Sceneform
+          formats
+        </li>
+      </ul>
+    </td>
+  </tr>
+  <tr>
+    <td>Sceneform SDK<br>version <b>1.16.0</b></td>
+    <td>
+      <ul>
+        <li>Open source</li>
+        <li>Built alongside an application as a Gradle module</li>
+        <li>
+          Supports <a href="https://www.khronos.org/gltf/">glTF</a> instead of
+          <code>SFA</code> and <code>SFB</code> Sceneform formats
+        </li>
+      </ul>
+    </td>
+  </tr>
+  <tr>
+    <td>Sceneform SDK<br>version <b>1.17.0</b></td>
+    <td>Do not use</td>
+  </tr>
+  <tr>
+    <td>Sceneform SDK<br>version <b>1.17.1</b></td>
+    <td>Identical to version 1.15.0</td>
+  </tr>
+</table>
+
+
+## Getting started with Sceneform 1.16.0
+
+Use the following steps to include and build the Sceneform 1.16.0 SDK with your
+app:
+
+1. Download `sceneform-android-sdk-1.16.0.zip` from the Sceneform SDK
+   [releases](https://github.com/google-ar/sceneform-android-sdk/releases/tag/v1.16.0)
+   page.
+2. Extract the `sceneformsrc` and `sceneformux` directories into your project's
+   top-level directory. The resulting directory structure should be similar to
+   the following:
+```
+project
++-- app
+|   +-- build.gradle
+|   +-- ...
++-- sceneformsrc
++-- sceneformux
++-- build.gradle
++-- settings.gradle
++-- ...
+```
+
+3. Modify your project's `settings.gradle` to include the Sceneform projects:
+```
+include ':app'
+
+// Add these lines:
+include ':sceneform'
+project(':sceneform').projectDir=new File('sceneformsrc/sceneform')
+
+include ':sceneformux'
+project(':sceneformux').projectDir=new File('sceneformux/ux')
+```
+
+4. Finally, add a reference to the Sceneform SDK to your app's `build.gradle`:
+```
+dependencies {
+    api project(":sceneformux")
+}
+```
+
+To get started with the Sceneform SDK, check out the
+[Sceneform sample](https://github.com/google-ar/sceneform-android-sdk/tree/master/samples/gltf/app).
+
+
+## Archived Sceneform 1.15.0 content
+
+Documentation for the Sceneform SDK for Android 1.15.0 is available from
+https://developers.google.com/sceneform.
+
+* [Getting started](https://developers.google.com/sceneform/develop/getting-started)
+* [API reference](https://developers.google.com/sceneform/reference)
+* [Samples](https://github.com/google-ar/sceneform-android-sdk/tree/v1.15.0/samples)
+
+
+## Release notes
+
+The SDK release notes are available on the
+[releases](https://github.com/google-ar/sceneform-android-sdk/releases) page.
+
+
+## License
+
+Please see the
+[LICENSE](https://github.com/google-ar/sceneform-android-sdk/blob/master/LICENSE)
+file.
+
+
+## Brand Guidelines
+
+The Sceneform trademark is a trademark of Google, and is not subject to the
+copyright or patent license grants contained in the Apache 2.0-licensed
+Sceneform repositories on GitHub. Any uses of the Sceneform trademark other than
+those permitted in these guidelines must be approved by Google in advance.
+
+### Purpose of the Brand Guidelines
+
+These guidelines exist to ensure that the Sceneform project can share its
+technology under open source licenses while making sure that the "Sceneform"
+brand is protected as a meaningful source identifier in a way that's consistent
+with trademark law. By adhering to these guidelines, you help to promote the
+freedom to use and develop high-quality Sceneform technology.
 
-This repository contains Sceneform sample projects.
+### Acceptable uses
 
-To get started with the Sceneform SDK, follow the ARCore [Android Quickstart](//developers.google.com/ar/develop/java/quickstart) guide.
+Because we are open-sourcing the Sceneform technology, you may use the Sceneform
+trademark to refer to the project without prior written permission. Examples of
+these approved references include the following:
 
+* To refer to the Sceneform project itself;
+* To refer to unmodified source code or other files shared by the Sceneform
+  repositories on GitHub;
+* To accurately identify that your design or implementation is based on, is for
+  use with, or is compatible with the Sceneform technology.
 
-## API Reference
+Examples:
 
-See the [Sceneform API Reference](//developers.google.com/ar/reference/java/com/google/ar/sceneform/package-summary).
+* "[Your Product] for Sceneform."
+* "[Your Product] is a fork of the Sceneform project."
+* "[Your Product] is compatible with Sceneform."
 
 
-## Release Notes
+### Usage guidelines
 
-The SDK release notes are available on the [releases](//github.com/google-ar/sceneform-android-sdk/releases) page.
+* The Sceneform name may never be used or registered in a manner that would
+  cause confusion as to Google's sponsorship, affiliation, or endorsement.
+* Don't use the Sceneform name, or a confusingly similar term, as part of your
+  company name, product name, domain name, or social media profile.
+* Other than as permitted by these guidelines, the Sceneform name should not be
+  combined with other trademarks, terms, or source identifiers.
+* Don't remove, distort or alter the Sceneform name. That includes modifying the
+  Sceneform name, for example, through hyphenation, combination, or
+  abbreviation. Do not shorten, abbreviate, or create acronyms out of the
+  Sceneform name.
+* Don't display the Sceneform name using any different stylization, color, or
+  font from the surrounding text.
+* Don't use the term Sceneform as a verb, or use it in possessive form.
 
 
 ## Terms & Conditions
 
-By downloading the Sceneform SDK for Android, you agree that the [Google APIs Terms of Service](//developers.google.com/terms/) governs your use thereof.
+By downloading the Sceneform SDK for Android, you agree that the
+[Google APIs Terms of Service](https://developers.google.com/terms/) governs
+your use thereof.
+
 
-## User privacy requirements 
+## User privacy requirements
 
-You must disclose the use of Google Play Services for AR (ARCore) and how it collects and processes data, prominently in your application, easily accessible to users. You can do this by adding the following text on your main menu or notice screen: "This application runs on [Google Play Services for AR](//play.google.com/store/apps/details?id=com.google.ar.core) (ARCore), which is provided by Google LLC and governed by the [Google Privacy Policy](//policies.google.com/privacy)"
+You must disclose the use of Google Play Services for AR (ARCore) and how it
+collects and processes data, prominently in your application, easily accessible
+to users. You can do this by adding the following text on your main menu or
+notice screen: "This application runs on
+[Google Play Services for AR](https://play.google.com/store/apps/details?id=com.google.ar.core)
+(ARCore), which is provided by Google LLC and governed by the
+[Google Privacy Policy](https://policies.google.com/privacy)".