Skip to content
This repository has been archived by the owner on Jul 28, 2020. It is now read-only.

Commit

Permalink
Updated README.md for Sceneform SDK 1.16.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@fredsa
fredsa committed May 15, 2020
1 parent 492ef3a commit 26256a0
Showing 1 changed file with 162 additions and 13 deletions.
175 changes: 162 additions & 13 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,38 +1,187 @@
# Status: Archived
This repository has been archived and is no longer maintained.

![status: inactive](https://img.shields.io/badge/status-inactive-red.svg)

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.
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.

<table>
<tr>
<th>Sceneform SDK</th>
<th>Description</th>
</tr>
<tr>
<td>Sceneform for SDK<br>versions 1.0.0 - 1.15.0</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 for SDK<br>version 1.16.0</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>
</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)

Please note, we do not accept pull requests.

## Release notes

The SDK release notes are available on the
[releases](https://github.com/google-ar/sceneform-android-sdk/releases) page.

## Getting Started

This repository contains Sceneform sample projects.
## 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.

### 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/sceneform/reference/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

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)".
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)".

0 comments on commit 26256a0

Please sign in to comment.