├── .github
└── PULL_REQUEST_TEMPLATE.md
├── CONTRIBUTING.md
├── LICENSE
├── LICENSE-SAMPLECODE
├── LICENSE-SUMMARY
├── README.md
├── doc-source
├── amazon-sumerian.md
├── assets-artools.md
├── assets-hosts.md
├── assets-media.md
├── assets-models.md
├── assets-packs.md
├── assets-skybox.md
├── assets-templates.md
├── assets-vrtools.md
├── dashboard-assets.md
├── dashboard-locks.md
├── dashboard-projects.md
├── dashboard-scenes.md
├── dashboard-templates.md
├── dashboard-trash.md
├── editor-assetlib.md
├── editor-assets.md
├── editor-canvas.md
├── editor-entities.md
├── editor-inspector.md
├── editor-publish.md
├── editor-shortcuts.md
├── editor-tools.md
├── entities-2dgraphics.md
├── entities-animation.md
├── entities-camera.md
├── entities-collider.md
├── entities-dialogue.md
├── entities-geometry.md
├── entities-hmdcamera.md
├── entities-host.md
├── entities-html.md
├── entities-light.md
├── entities-material.md
├── entities-particlesystem.md
├── entities-rigidbody.md
├── entities-script.md
├── entities-sound.md
├── entities-speech.md
├── entities-statemachine.md
├── entities-timeline.md
├── entities-transform.md
├── entities-vrcamerarig.md
├── entities-vrcontroller.md
├── gettingstarted-robin.md
├── gettingstarted-showcase.md
├── gettingstarted-tutorial.md
├── index.md
├── scene-aws.md
├── scene-document.md
├── scene-environment.md
├── scene-posteffects.md
├── scene-scenesize.md
├── scene-scenestats.md
├── scene-snapshots.md
├── scripting-builtins.md
├── scripting-context.md
├── scripting-debugging.md
├── scripting-dependencies.md
├── scripting-parameters.md
├── statemachines-animation.md
├── statemachines-attributes.md
├── statemachines-audio.md
├── statemachines-aws.md
├── statemachines-controls.md
├── statemachines-effects.md
├── statemachines-materials.md
├── statemachines-physics.md
├── statemachines-scripting.md
├── sumerian-assets.md
├── sumerian-concepts.md
├── sumerian-dashboard.md
├── sumerian-editor.md
├── sumerian-entities.md
├── sumerian-gettingstarted.md
├── sumerian-permissions.md
├── sumerian-scene.md
├── sumerian-scripting.md
├── sumerian-statemachines.md
├── sumerian-troubleshooting.md
├── sumerian-usecases.md
└── troubleshooting-profiling.md
├── models
└── american-robin.fbx
└── scripts
├── README.md
├── add-quad.js
├── add-skybox.js
├── add-sphere.js
├── bot-selector.js
├── create-speech-action.js
├── download-lists.js
├── hide-entity-action.js
└── random-speech.js
/.github/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
1 | *Issue #, if available:*
2 |
3 | *Description of changes:*
4 |
5 |
6 | By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
7 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Guidelines for contributing
2 |
3 | Thank you for your interest in contributing to AWS documentation! We greatly value feedback and contributions from our community.
4 |
5 | Please read through this document before you submit any pull requests or issues. It will help us work together more effectively.
6 |
7 | ## What to expect when you contribute
8 |
9 | When you submit a pull request, our team is notified and will respond as quickly as we can. We'll do our best to work with you to ensure that your pull request adheres to our style and standards. If we merge your pull request, we might make additional edits later for style or clarity.
10 |
11 | The AWS documentation source files on GitHub aren't published directly to the official documentation website. If we merge your pull request, we'll publish your changes to the documentation website as soon as we can, but they won't appear immediately or automatically.
12 |
13 | We look forward to receiving your pull requests for:
14 |
15 | * New content you'd like to contribute (such as new code samples or tutorials)
16 | * Inaccuracies in the content
17 | * Information gaps in the content that need more detail to be complete
18 | * Typos or grammatical errors
19 | * Suggested rewrites that improve clarity and reduce confusion
20 |
21 | **Note:** We all write differently, and you might not like how we've written or organized something currently. We want that feedback. But please be sure that your request for a rewrite is supported by the previous criteria. If it isn't, we might decline to merge it.
22 |
23 | ## How to contribute
24 |
25 | To contribute, send us a pull request. For small changes, such as fixing a typo or adding a link, you can use the [GitHub Edit Button](https://blog.github.com/2011-04-26-forking-with-the-edit-button/). For larger changes:
26 |
27 | 1. [Fork the repository](https://help.github.com/articles/fork-a-repo/).
28 | 2. In your fork, make your change in a branch that's based on this repo's **master** branch.
29 | 3. Commit the change to your fork, using a clear and descriptive commit message.
30 | 4. [Create a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/), answering any questions in the pull request form.
31 |
32 | Before you send us a pull request, please be sure that:
33 |
34 | 1. You're working from the latest source on the **master** branch.
35 | 2. You check [existing open](https://github.com/awsdocs/amazon-sumerian-user-guide/pulls), and [recently closed](https://github.com/awsdocs/amazon-sumerian-user-guide/pulls?q=is%3Apr+is%3Aclosed), pull requests to be sure that someone else hasn't already addressed the problem.
36 | 3. You [create an issue](https://github.com/awsdocs/amazon-sumerian-user-guide/issues/new) before working on a contribution that will take a significant amount of your time.
37 |
38 | For contributions that will take a significant amount of time, [open a new issue](https://github.com/awsdocs/amazon-sumerian-user-guide/issues/new) to pitch your idea before you get started. Explain the problem and describe the content you want to see added to the documentation. Let us know if you'll write it yourself or if you'd like us to help. We'll discuss your proposal with you and let you know whether we're likely to accept it. We don't want you to spend a lot of time on a contribution that might be outside the scope of the documentation or that's already in the works.
39 |
40 | ## Finding contributions to work on
41 |
42 | If you'd like to contribute, but don't have a project in mind, look at the [open issues](https://github.com/awsdocs/amazon-sumerian-user-guide/issues) in this repository for some ideas. Any issues with the [help wanted](https://github.com/awsdocs/amazon-sumerian-user-guide/labels/help%20wanted) or [enhancement](https://github.com/awsdocs/amazon-sumerian-user-guide/labels/enhancement) labels are a great place to start.
43 |
44 | In addition to written content, we really appreciate new examples and code samples for our documentation, such as examples for different platforms or environments, and code samples in additional languages.
45 |
46 | ## Code of conduct
47 |
48 | This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). For more information, see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact [opensource-codeofconduct@amazon.com](mailto:opensource-codeofconduct@amazon.com) with any additional questions or comments.
49 |
50 | ## Security issue notifications
51 |
52 | If you discover a potential security issue, please notify AWS Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public issue on GitHub.
53 |
54 | ## Licensing
55 |
56 | See the [LICENSE](https://github.com/awsdocs/amazon-sumerian-user-guide/blob/master/LICENSE) file for this project's licensing. We will ask you to confirm the licensing of your contribution. We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
57 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Creative Commons Attribution-ShareAlike 4.0 International Public License
2 |
3 | By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-ShareAlike 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
4 |
5 | Section 1 – Definitions.
6 |
7 | a. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
8 |
9 | b. Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
10 |
11 | c. BY-SA Compatible License means a license listed at creativecommons.org/compatiblelicenses, approved by Creative Commons as essentially the equivalent of this Public License.
12 |
13 | d. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
14 |
15 | e. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
16 |
17 | f. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
18 |
19 | g. License Elements means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution and ShareAlike.
20 |
21 | h. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
22 |
23 | i. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
24 |
25 | j. Licensor means the individual(s) or entity(ies) granting rights under this Public License.
26 |
27 | k. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
28 |
29 | l. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
30 |
31 | m. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
32 |
33 | Section 2 – Scope.
34 |
35 | a. License grant.
36 |
37 | 1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
38 |
39 | A. reproduce and Share the Licensed Material, in whole or in part; and
40 |
41 | B. produce, reproduce, and Share Adapted Material.
42 |
43 | 2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
44 |
45 | 3. Term. The term of this Public License is specified in Section 6(a).
46 |
47 | 4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
48 |
49 | 5. Downstream recipients.
50 |
51 | A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
52 |
53 | B. Additional offer from the Licensor – Adapted Material. Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter’s License You apply.
54 |
55 | C. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
56 |
57 | 6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
58 |
59 | b. Other rights.
60 |
61 | 1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
62 |
63 | 2. Patent and trademark rights are not licensed under this Public License.
64 |
65 | 3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.
66 |
67 | Section 3 – License Conditions.
68 |
69 | Your exercise of the Licensed Rights is expressly made subject to the following conditions.
70 |
71 | a. Attribution.
72 |
73 | 1. If You Share the Licensed Material (including in modified form), You must:
74 |
75 | A. retain the following if it is supplied by the Licensor with the Licensed Material:
76 |
77 | i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
78 |
79 | ii. a copyright notice;
80 |
81 | iii. a notice that refers to this Public License;
82 |
83 | iv. a notice that refers to the disclaimer of warranties;
84 |
85 | v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
86 |
87 | B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
88 |
89 | C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
90 |
91 | 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
92 |
93 | 3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
94 |
95 | b. ShareAlike.In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply.
96 |
97 | 1. The Adapter’s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-SA Compatible License.
98 |
99 | 2. You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material.
100 |
101 | 3. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply.
102 |
103 | Section 4 – Sui Generis Database Rights.
104 |
105 | Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
106 |
107 | a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database;
108 |
109 | b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and
110 |
111 | c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
112 | For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
113 |
114 | Section 5 – Disclaimer of Warranties and Limitation of Liability.
115 |
116 | a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.
117 |
118 | b. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.
119 |
120 | c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
121 |
122 | Section 6 – Term and Termination.
123 |
124 | a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
125 |
126 | b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
127 |
128 | 1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
129 |
130 | 2. upon express reinstatement by the Licensor.
131 |
132 | c. For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
133 |
134 | d. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
135 |
136 | e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
137 |
138 | Section 7 – Other Terms and Conditions.
139 |
140 | a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
141 |
142 | b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
143 |
144 | Section 8 – Interpretation.
145 |
146 | a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
147 |
148 | b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
149 |
150 | c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
151 |
152 | d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.
153 |
--------------------------------------------------------------------------------
/LICENSE-SAMPLECODE:
--------------------------------------------------------------------------------
1 | Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2 |
3 | Permission is hereby granted, free of charge, to any person obtaining a copy of this
4 | software and associated documentation files (the "Software"), to deal in the Software
5 | without restriction, including without limitation the rights to use, copy, modify,
6 | merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
7 | permit persons to whom the Software is furnished to do so.
8 |
9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
10 | INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
11 | PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
12 | HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
13 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
14 | SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
15 |
--------------------------------------------------------------------------------
/LICENSE-SUMMARY:
--------------------------------------------------------------------------------
1 | Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2 |
3 | The documentation is made available under the Creative Commons Attribution-ShareAlike 4.0 International License. See the LICENSE file.
4 |
5 | The sample code within this documentation is made available under a modified MIT license. See the LICENSE-SAMPLECODE file.
6 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | ## Amazon Sumerian User Guide
2 |
3 | The open source version of the Amazon Sumerian User Guide
4 |
5 | ## License Summary
6 |
7 | The documentation is made available under the Creative Commons Attribution-ShareAlike 4.0 International License. See the LICENSE file.
8 |
9 | The sample code within this documentation is made available under a modified MIT license. See the LICENSE-SAMPLECODE file.
10 |
--------------------------------------------------------------------------------
/doc-source/amazon-sumerian.md:
--------------------------------------------------------------------------------
1 | # What Is Amazon Sumerian?
2 |
3 | Amazon Sumerian is a set of tools for creating high\-quality virtual reality \(VR\) experiences on the web\. With Sumerian, you can construct an interactive 3D scene without any programming experience, test it in the browser, and publish it as a website that is immediately available to users\.
4 |
5 | Use the Sumerian library of assets or bring your own\. When you import 3D models, Sumerian converts and optimizes them automatically\. Sumerian also has a library of primitive shapes, 3D models, hosts, textures, and scripts\.
6 |
7 | **Note**
8 | New to 3D, VR, animation, and scripting? The [Sumerian website](https://docs.sumerian.amazonaws.com/) has a ton of helpful tutorials for every level of experience\.
9 |
10 | The Sumerian 3D engine provides a library for advanced scripting with JavaScript, but you don't have to be a programmer to create interactive VR\! Use the built\-in state machine to animate objects and respond to user actions like clicks and movement\.
11 |
12 | When you're ready to share your work with the world, you can publish it directly to Amazon CloudFront as a static website that can be viewed with a [WebVR](https://webvr.info/)\-compatible browser and headset\.
--------------------------------------------------------------------------------
/doc-source/assets-artools.md:
--------------------------------------------------------------------------------
1 | # Amazon Sumerian Augmented Reality Tools
2 |
3 | Sumerian provides a template, assets, and sample projects that you can use to develop augmented reality \(AR\) applications for iOS and Android devices\.
4 |
5 | The **Augmented Reality** scene template is available in the [dashboard](sumerian-dashboard.md)\. Use it as a starting point for your augmented reality scene\.
6 |
7 | ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/templates-ar.png)
8 |
9 | The scene includes the following resources:
10 | + **AR Camera** – The main camera, with a script that maps it to the device's camera\.
11 | + **AR Camera Control** – A script that uses the Sumerian engine [AR System](https://content.sumerian.amazonaws.com/engine/latest/docs/ArSystem.html) to access the device's augmented reality API\. You can view this script in the text editor\.
12 | + **ARAnchor** – An empty entity that the AR app uses to anchor objects in the scene to the real world\.
13 |
14 | You can construct an AR scene from this template by adding models and making them children of the **ARAnchor** entity\. Publish the scene, and then use the sample AR Kit project to build an app that uses it\.
15 |
16 | **Topics**
17 | + [Android Sample Project](#assets-artools-android)
18 | + [iOS Sample Project](#assets-artools-ios)
19 |
20 | ## Android Sample Project
21 |
22 | The sample project, [amazon\-sumerian\-arcore\-starter\-app](https://github.com/aws-samples/amazon-sumerian-arcore-starter-app), is an Android Studio project with an ARCore app that loads a scene created with the AR template\. Replace the [scene URL in the view controller](https://github.com/aws-samples/amazon-sumerian-arcore-starter-app/blob/master/SumerianARCoreStarter/app/src/main/java/com/amazon/sumerianarcorestarter/MainActivity.java#L41) with the URL of your published scene, build the app, and then run it on a compatible Android device to see it in action\.
23 |
24 | See the [Augmented Reality Using Sumerian and ARCore](https://docs.sumerian.amazonaws.com/tutorials/create/intermediate/augmented-reality-using-sumerian-arcore/) tutorial to explore how to use these assets\.
25 |
26 | ## iOS Sample Project
27 |
28 | The sample project, [amazon\-sumerian\-arkit\-starter\-app](https://github.com/aws-samples/amazon-sumerian-arkit-starter-app), is an XCode project with a Swift app that loads a scene created with the AR template\. Replace the [scene URL in the view controller](https://github.com/aws-samples/amazon-sumerian-arkit-starter-app/blob/master/SumerianARKitStarter/ViewController.swift#L20) with the URL of your published scene, build the app, and then run it on a compatible iOS device to see it in action\.
29 |
30 | See the [Augmented Reality Using Sumerian and ARKit](https://docs.sumerian.amazonaws.com/tutorials/create/intermediate/augmented-reality-using-sumerian-arkit/) tutorial to explore how to use these assets\.
--------------------------------------------------------------------------------
/doc-source/assets-hosts.md:
--------------------------------------------------------------------------------
1 | # Amazon Sumerian Hosts
2 |
3 | A host is an asset provided by Sumerian that has built in animation, speech, and behavior for interacting with users\. Use hosts to engage users in conversation and convey information\.
4 |
5 | ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/hosts.png)
6 |
7 | **To add a host to your scene**
8 |
9 | 1. Open a scene in the Sumerian editor\.
10 |
11 | 1. Choose **Import assets**\.
12 |
13 | 1. Choose one of the following hosts:
14 | + **Cristine**
15 | + **Preston**
16 | + **Luke**
17 |
18 | 1. Choose **Add**\.
19 |
20 | 1. Drag the host entity from the assets panel onto the canvas\.
21 | ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/assets-host.png)
22 |
23 | All of a host's meshes, materials, animations, and scripts are bundled into a single entity with three configurable components:
24 | + **[Transform](entities-transform.md)** – The host's location relative to the scene or its parent entity\.
25 | + **[Host](entities-host.md)** – Animation and behavior settings\.
26 | + **[Speech](entities-speech.md)** – Text\-to\-speech capability with Amazon Polly\.
27 |
28 | Models and animations for hosts are locked\. You cannot modify or extend them\.
--------------------------------------------------------------------------------
/doc-source/assets-media.md:
--------------------------------------------------------------------------------
1 | # Media
2 |
3 | You can import media files into Sumerian to use as textures, audio, or text objects\. Sumerian supports the following file formats\.
4 |
5 | **Textures up to 10 MB**
6 | + CRN
7 | + DDS
8 | + JPG, JPEG
9 | + PNG
10 | + SVG
11 | + TGA
12 | + MP4
13 | + OGV
14 | + WEBM
15 |
16 | **Audio up to 10 MB**
17 | + OGG
18 | + MP3
19 | + WAVE, WAV
20 |
21 | **Text up to 1 MB**
22 | + JS
23 | + JSON
24 |
25 | You can combine multiple asset files into a ZIP archive up to 200 MB in size, as long as each file meets the size requirement for its type when decompressed\.
--------------------------------------------------------------------------------
/doc-source/assets-models.md:
--------------------------------------------------------------------------------
1 | # Models
2 |
3 | Drop a model file on the assets panel to import it\. When you import a model, Sumerian converts it into an asset pack that contains the model's meshes, skeletons, materials, and textures\. Meshes are triangulated automatically during import\. The process can take some time, depending on the model size and format\.
4 |
5 | You can import models up to 50 MB in size in the following formats\.
6 |
7 | **File Formats**
8 | + **FilmBox** – `.fbx`
9 |
10 | [ www\.autodesk\.com/products/fbx/overview ](http://www.autodesk.com/products/fbx/overview)
11 | + **Wavefront OBJ** – `.obj`
12 |
13 | [ en\.wikipedia\.org/wiki/Wavefront\_\.obj\_file ](http://en.wikipedia.org/wiki/Wavefront_.obj_file)
14 |
15 | After the model is imported, drop the model entity from the asset pack onto the canvas\. This adds one or more entities to the scene in a hierarchy based on the imported file\. At a minimum, the entity has transform, geometry, and material components\. If you import a model that has a skeleton and animations, you also get an animation component\. The skeleton and polygon mesh are attached to the geometry component, and textures are attached to the material component\.
16 |
17 | To optimize the model importing process, remove unneeded data by deleting the object history and freezing transformations in your modeling tool\. If you can, avoid using geometric transformations\. If your model has skeleton animations, bake them during export and avoid using constraints\.
18 |
19 | The Sumerian engine supports the following model features\.
20 |
21 | **Model Features**
22 | + **Vertex colors** – Per\-vertex colors or per\-face\-vertex colors are supported\.
23 |
24 | When the mesh data contains vertex colors, a slider is available on the mesh's material panel under the diffuse channel\. You can use the slider to blend between the set diffuse map or color and the vertex color\.
25 | + **UV maps** – If two are available, you can use the second one, for example, for light maps or ambient occlusion maps\.
26 |
27 | In the editor, you are able to apply these textures on the ambient channel in the material panel\.
28 | + **Tangents** – If no tangent data is provided, it is generated during the conversion\.
29 | + **Normals** – If no normal data is provided, interpolated normals are generated during the conversion\.
30 | + **Rig** – An animation rig or armature in an FBX file is imported as a skeleton asset\. Each vertex can have up to 4 weights\. If more are present, the lower valued weights are removed\. Minimize the number of joints to improve performance\.
31 | + **Animations** – Animation takes in an FBX file are imported as clips attached to an animation asset\. See [Amazon Sumerian Animation Component](entities-animation.md) for more information\.
32 | + **Textures** – When exporting to the FBX binary format, you can embed textures into the resulting file\.
--------------------------------------------------------------------------------
/doc-source/assets-packs.md:
--------------------------------------------------------------------------------
1 | # Amazon Sumerian Asset Packs
2 |
3 | You can organize your assets and share them between scenes by creating a *pack*\. Create a pack in the assets panel and move or copy assets into it\.
4 |
5 | Packs support the following actions:
6 | + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/assets-icons-add.png) – Create a new asset in the pack\.
7 | + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/assets-icons-assetlib.png) – Export the pack to the asset library\.
8 | + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/assets-icons-cleanup.png) – Delete any assets in the pack that are not used in the scene\.
9 | + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/assets-icons-trash.png) – Delete the asset pack\.
10 |
11 | Exporting a pack adds it to the project that you choose\. If you don't have a project yet, [create one in the dashboard](dashboard-projects.md)\. You can then use the dashboard to [copy or move the pack](dashboard-assets.md) to a different scene or project\. Exported packs are not tied to the in\-scene pack or its assets\.
12 |
13 | **To add an asset to a pack and export it**
14 |
15 | 1. Open a scene in the Sumerian editor\.
16 |
17 | 1. Under **Assets**, choose **Create pack**\.
18 |
19 | 1. Choose the pack and modify the name, description, tags, and custom attributes in the inspector panel\.
20 |
21 | 1. Drag an asset from the default pack into the custom pack\.
22 |
23 | **or**
24 |
25 | Duplicate the item by selecting it and then clicking the duplicate icon\. Drag the duplicate into the custom pack\.
26 |
27 | 1. Select the custom pack, and then click the asset library icon ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/assets-icons-assetlib.png), or choose **Add to asset library** in the inspector panel\.
28 | ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/assets-pack-export.png)
29 |
30 | 1. Choose an [asset type](sumerian-assets.md) for the asset pack\.
31 |
32 | 1. Choose **Add to asset library**\.
33 |
34 | 1. Choose a project, and then choose **Select**\.
--------------------------------------------------------------------------------
/doc-source/assets-skybox.md:
--------------------------------------------------------------------------------
1 | # Skybox
2 |
3 | A skybox is a texture that you apply to the background of a scene to show the sky, space, or an enclosing structure\. A skybox can be a single texture that wraps onto a sphere, or six textures that wrap onto a cube\. Add a skybox to your scene in the scene's [environment settings](scene-environment.md)\.
4 |
5 | **To create a skybox**
6 |
7 | 1. Open a scene in the Sumerian editor\.
8 |
9 | 1. Click the plus icon next to the default pack\. To see the icon, select the pack name\.
10 | ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/assets-bin-add.png)
11 |
12 | 1. Choose **Skybox**\.
13 |
14 | 1. Choose the shape of the skybox\.
15 |
16 | **Skybox Shapes**
17 | + **Box** – Six square images that map onto a cube \(cube map\)\.
18 | + **Sphere** – A single rectangular image that maps onto a sphere \(equirectangular projection\)\.
19 |
20 | 1. Drop a texture asset or image file on each section of the skybox\.
21 | ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/assets-skybox-textures.png)
22 |
23 | 1. Choose the root node in the **Entities** panel\.
24 | ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/editor-entities-scene.png)
25 |
26 | 1. Choose **Environment**\.
27 |
28 | 1. Drop the skybox asset from the assets panel onto the **Skybox** field\.
29 | ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/)
--------------------------------------------------------------------------------
/doc-source/assets-templates.md:
--------------------------------------------------------------------------------
1 | # Amazon Sumerian Scene Templates
2 |
3 | Sumerian provides scene templates that you can use as a starting point for your scene\.
4 |
5 | **Sumerian Scene Templates**
6 | + **Augmented reality** – Template for creating augmented reality \(AR\) scenes with a companion sample app\. See [Amazon Sumerian Augmented Reality Tools](assets-artools.md) for more information\.
7 | + **Default lighting** – An empty scene with a skysphere and three directional lights\. This template is used in the [interface tutorial](https://docs.sumerian.amazonaws.com/tutorials/create/getting-started/sumerian-interface/)\.
8 | + **Speech & gestures** – Scene with a [Sumerian host](assets-hosts.md) configured to use speech with a state machine\.
9 |
10 | Choose any of these templates in the [dashboard](sumerian-dashboard.md) to create a draft scene\.
--------------------------------------------------------------------------------
/doc-source/assets-vrtools.md:
--------------------------------------------------------------------------------
1 | # Amazon Sumerian Virtual Reality Tools
2 |
3 | Sumerian provides a pack of virtual reality \(VR\)\-related assets to make it easy to enable VR in your scene\. The asset pack includes a VR camera that lets the user enter VR mode, and VR controllers for interacting with the environment\.
4 |
5 | **Supported VR Headsets**
6 | + Oculus Rift
7 | + Oculus Go
8 | + HTC Vive
9 | + HTC Vive Pro
10 | + Lenovo Mirage Solo
11 | + Samsung Gear VR
12 | + Google Daydream
13 |
14 | **To enable VR in your scene**
15 |
16 | 1. Open a scene in the Sumerian editor\.
17 |
18 | 1. Choose **Import assets**\.
19 |
20 | 1. Choose **CoreVR**, and then choose **Add**\.
21 |
22 | 1. When the asset pack finishes loading, drag the **VRCameraRig** entity onto the canvas to add it to your scene\.
23 |
24 | 1. Choose the **VRCameraRig** entity\.
25 |
26 | 1. Choose the **VRCameraRig** component\.
27 |
28 | 1. Choose the **Current VR camera rig** option to enable the rig\.
29 |
30 | When a user enters VR mode with a headset and controllers attached, the [HMD camera](entities-hmdcamera.md) tracks the headset, and the [VR controllers](entities-vrcontroller.md) track the controllers in 3D space\. The [VR camera rig](entities-vrcamerarig.md) manages the other entities and enables the VR mode button in the scene\.
31 |
32 | Only the controllers of the type attached are rendered in the scene, so you can leave all of the included entities attached to support both types\. You can also replace the included controller models with your own\.
33 |
34 | See [Getting Started with VR](https://docs.sumerian.amazonaws.com/tutorials/create/beginner/getting-started-vr/) for a tutorial that uses these assets\.
--------------------------------------------------------------------------------
/doc-source/dashboard-assets.md:
--------------------------------------------------------------------------------
1 | # Asset Packs
2 |
3 | The **Assets** page for a project shows asset packs that have been exported from a scene\.
4 |
5 | In the dashboard, you can change the name and description of a pack, and copy or move it to another project\.
6 |
7 | **To manage an asset pack**
8 |
9 | 1. Open [the Sumerian dashboard](https://console.aws.amazon.com/sumerian/home)\.
10 |
11 | 1. Choose a project\.
12 |
13 | 1. Choose **Assets**\.
14 |
15 | 1. Choose an asset pack\.
16 |
17 | 1. Under **Asset details**, use one of the following options\.
18 | + **Thumbnail** – Choose **Browse** to upload a thumbnail image\.
19 | + **Name** – Change the asset pack name\.
20 | + **Description** – Change the asset pack description\.
21 | + **Tags** – Add tags to the asset pack for use with filters\.
22 | + **Actions**
23 | + **Move** – Move the asset pack to a different project\.
24 | + **Copy** – Copy the asset pack to a different project\.
25 | + **Delete** – Send the asset pack to the **Trash**
26 |
27 | Additional options for asset packs are available in the [Sumerian editor](assets-packs.md)\.
--------------------------------------------------------------------------------
/doc-source/dashboard-locks.md:
--------------------------------------------------------------------------------
1 | # Locks
2 |
3 | The Amazon Sumerian editor uses locks to control modifications to a scene\. When you open a scene, the editor creates a lock on the scene and refreshes it periodically\. If you try to open the scene in a different browser while the lock is active, you will see an error\.
4 |
5 | ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/dashboard-lock.png)
6 |
7 | You can force Sumerian to discard the lock if you are sure that no one else is working on the scene, or create a copy of the scene and work on that\.
--------------------------------------------------------------------------------
/doc-source/dashboard-projects.md:
--------------------------------------------------------------------------------
1 | # Projects
2 |
3 | Projects collect the scenes that you are working on\. You can create up to 1,000 projects per region\.
4 |
5 | **To create a project**
6 |
7 | 1. Open [the Sumerian dashboard](https://console.aws.amazon.com/sumerian/home)\.
8 |
9 | 1. Choose **Projects**\.
10 |
11 | 1. Choose **New project**\.
12 |
13 | 1. Enter a project name and choose **Create**\.
14 |
15 | Once you have a project, you can use the dashboard to make a copy or delete it\.
16 |
17 | **To manage a project**
18 |
19 | 1. Open [the Sumerian dashboard](https://console.aws.amazon.com/sumerian/home)\.
20 |
21 | 1. Choose a project\.
22 |
23 | 1. Under **Project details**, use one of the following options\.
24 | + **Thumbnail** – Choose **Browse** to upload a thumbnail image\.
25 | + **Name** – Change the project name\.
26 | + **Description** – Change the project description\.
27 | + **Actions** – **Move** or **Copy** the project\. **Delete** the project to send it to the **Trash**\.
28 | + **Published URLs** – Choose **View URL List** to get links to all of the project's scenes that have been published in Amazon CloudFront\.
--------------------------------------------------------------------------------
/doc-source/dashboard-scenes.md:
--------------------------------------------------------------------------------
1 | # Scenes
2 |
3 | A scene is a 3D space that you manage in the dashboard and work on in the Sumerian editor\. Sumerian provides several templates that you can use as a starting point\.
4 |
5 | ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/)
6 |
7 | Scenes can be drafts, or part of a project\. You can create up to 10,000 scenes per region\.
8 |
9 | **To create a scene**
10 |
11 | 1. Open [the Sumerian dashboard](https://console.aws.amazon.com/sumerian/home)\.
12 |
13 | 1. Choose the location to create the scene\.
14 | + **Home** – Create a draft scene\.
15 | + **Drafts** – Create a draft scene\.
16 | + **Project** – Create a scene in one of your projects\.
17 |
18 | 1. Choose **Create scene**\.
19 |
20 | 1. \(optional\) Choose a [template](dashboard-templates.md)\.
21 |
22 | 1. Enter a scene name and choose **Create**\.
23 |
24 | When you create a scene, it opens in the [Sumerian editor](sumerian-editor.md) for immediate use\. Once you have a scene, you can use the dashboard to make a copy or delete it\. Choose the Sumerian icon in the upper left corner to leave the scene and return to the dashboard\.
25 |
26 | **To manage a scene**
27 |
28 | 1. Open [the Sumerian dashboard](https://console.aws.amazon.com/sumerian/home)\.
29 |
30 | 1. Locate your scene under **Recent scenes**, **Drafts**, or a project\.
31 |
32 | 1. Choose the scene by clicking its thumbnail\.
33 | **Note**
34 | If you click on the name of the scene or double\-click the thumbnail, the scene opens in the Sumerian editor\.
35 |
36 | 1. Under **Scene details**, use one of the following options\.
37 | + **Thumbnail** – Choose **Browse** to upload a thumbnail image\.
38 | + **Name** – Change the scene name\.
39 | + **Description** – Change the scene description\.
40 | + **Tags** – Add tags to the scene for use with filters\.
41 | + **Actions**
42 | + **Open** – Open the scene in the Sumerian editor\.
43 | + **View published** – \(public scenes\) Open the published version of the scene hosted in Amazon CloudFront\.
44 | + **Download Amplify JSON** – \([private scenes](editor-publish.md)\) Download the Amplify configuration file\.
45 | + **Move** – Move the scene to a different project\.
46 | + **Copy** – Copy the scene to a different project\.
47 | + **Duplicate** – Create a copy of the scene in the same project\.
48 | + **Delete** – Send the scene to the **Trash**
49 |
50 | Additional options for scenes are available in the Sumerian editor [scene settings](sumerian-scene.md)\.
--------------------------------------------------------------------------------
/doc-source/dashboard-templates.md:
--------------------------------------------------------------------------------
1 | # Templates
2 |
3 | Templates are scenes that have been exported from a project for use as a starting point for other scenes\. In addition to the templates provided by Sumerian, the dashboard lets you manage templates that you have exported from a scene\.
4 |
5 | You can use the dashboard to create a scene from a template, or move or copy templates between scenes\. Sumerian also provides a library of templates\.
6 |
7 | **To create a scene from a template**
8 |
9 | 1. Open [the Sumerian dashboard](https://console.aws.amazon.com/sumerian/home)\.
10 |
11 | 1. Choose **Create new scene**\.
12 |
13 | 1. Choose one of the **Sumerian Templates**, or choose **My templates** to use a template from one of your projects\.
14 |
15 | 1. Enter a name for your scene and choose **Create**\.
16 |
17 | Create templates from your scenes from the [scene settings section](sumerian-scene.md) in the Sumerian editor\. You can then copy your templates to other projects from the **Templates** section of the scene's project page in the dashboard\.
18 |
19 | **To manage a template**
20 |
21 | 1. Open [the Sumerian dashboard](https://console.aws.amazon.com/sumerian/home)\.
22 |
23 | 1. Choose a project\.
24 |
25 | 1. Choose **Templates**\.
26 |
27 | 1. Choose a template\.
28 |
29 | 1. Under **Template details**, use one of the following options\.
30 | + **Thumbnail** – Choose **Browse** to upload a thumbnail image\.
31 | + **Name** – Change the template name\.
32 | + **Description** – Change the template description\.
33 | + **Tags** – Add tags to the template for use with filters\.
34 | + **Actions**
35 | + **Move** – Move the template to a different project\.
36 | + **Copy** – Copy the template to a different project\.
37 | + **Delete** – Send the template to the **Trash**
--------------------------------------------------------------------------------
/doc-source/dashboard-trash.md:
--------------------------------------------------------------------------------
1 | # Trash
2 |
3 | When you delete a scene, project, template, or asset pack, Amazon Sumerian moves it to the trash\. Items in the trash are retained indefinitely and you can restore them at any time\.
4 |
5 | ![\[\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/dashboard-trash.png)
6 |
7 | You use the trash menu to restore deleted items or delete them permanently\.
8 |
9 | **To restore a deleted item**
10 |
11 | 1. Open [the Sumerian dashboard](https://console.aws.amazon.com/sumerian/home)\.
12 |
13 | 1. Choose **Trash**\.
14 |
15 | 1. Choose an item, and then choose **Restore**\.
16 |
17 | Restored items are returned to their original project\.
18 |
19 | To avoid paying storage costs for deleted items, delete them permanently\.
20 |
21 | **To delete items permanently**
22 |
23 | 1. Open [the Sumerian dashboard](https://console.aws.amazon.com/sumerian/home)\.
24 |
25 | 1. Choose **Trash**\.
26 |
27 | 1. Choose an item, and then choose **Delete**\.
28 |
29 | *or*
30 |
31 | Choose **Empty trash**\.
32 |
33 | 1. Choose **Delete**\.
--------------------------------------------------------------------------------
/doc-source/editor-assetlib.md:
--------------------------------------------------------------------------------
1 | # Importing Assets From the Asset Library in the Amazon Sumerian Editor
2 |
3 | You can use the Sumerian editor's asset library to import assets from the Sumerian library, your local machine, or from [asset packs](assets-packs.md) that you export from a scene\.
4 |
5 | **To import assets**
6 |
7 | 1. Open a scene in the Sumerian editor\.
8 |
9 | 1. Choose **Import assets**\.
10 |
11 | 1. Choose an [asset type](sumerian-assets.md) to filter the available assets by type\.
12 |
13 | 1. Choose an asset pack, and then choose **Add** to add it to your scene's assets\.
14 | ![\[\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/assetlib.png)
15 |
16 | 1. After the editor finishes importing the asset pack, drag an entity that it contains from the [assets panel](editor-assets.md) onto the canvas to add it to your scene\.
17 | ![\[\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/assetlib-dropentity.png)
--------------------------------------------------------------------------------
/doc-source/editor-assets.md:
--------------------------------------------------------------------------------
1 | # Using the Assets Panel in the Amazon Sumerian Editor
2 |
3 | The assets panel shows all assets that belong to the scene\. Assets are portable versions of entities or entity components\. You can create them from external files or from entities that you create within the editor\.
4 |
5 | ![\[\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/assets-panel.png)
6 |
7 | To create an asset, drop a file from your machine, or an entity from the entities panel, onto the assets panel\. Depending on the type of file, you may be able to split the file into multiple assets\.
8 |
9 | For more information, see [Amazon Sumerian Assets](sumerian-assets.md)\.
--------------------------------------------------------------------------------
/doc-source/editor-canvas.md:
--------------------------------------------------------------------------------
1 | # Amazon Sumerian Editor Canvas
2 |
3 | The WebGL\-rendered viewport is located in the center of the Sumerian editor\. Here you can navigate, inspect, and preview the contents of your scene\.
4 |
5 | The menu bar at the top of the canvas has options for camera, playback, and rendering\. Many of the buttons also have equivalent [keyboard commands](editor-shortcuts.md)\.
6 |
7 | **Canvas Menu**
8 | ![\[\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/editor-canvas-bar.png)
9 | + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/canvas-icons-paneltog.png) – Hide or show side panels\.
10 | + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/canvas-icons-translate.png) – Change the transform handles to translate mode\.
11 | + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/canvas-icons-rotate.png) – Change the transform handles to rotation mode\.
12 | + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/canvas-icons-scale.png) – Change the transform handles to scale mode\.
13 | + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/canvas-icons-globalspace.png) – Switch between relative and absolute positioning\.
14 | + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/canvas-icons-playback.png) – Preview the rendered scene in the canvas\.
15 | + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/canvas-icons-rendering.png) – Choose the render mode for the canvas\.
16 | + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/canvas-icons-skybox.png) – Show or hide the [skybox](assets-skybox.md) texture\.
17 | + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/canvas-icons-grid.png) – Show or hide the grid\.
18 | + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/canvas-icons-posteffects.png) – Show or hide post effects\.
19 | + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/canvas-icons-camera.png) – View the scene with a preset camera\.
20 | + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/canvas-icons-frameentity.png) – Fill the canvas with the selected entity\.
21 | + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/canvas-icons-frameall.png) – Fill the canvas with all entities in the scene\.
22 | + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/canvas-icons-fullscreen.png) – Fill the screen with the canvas\.
--------------------------------------------------------------------------------
/doc-source/editor-entities.md:
--------------------------------------------------------------------------------
1 | # Using the Entities Panel in the Amazon Sumerian Editor
2 |
3 | The entities panel shows you a scene's entities in a hierarchy, starting with the scene itself\. An entity can be a child of the scene or of another entity\. When you choose the scene in the entities panel, the [inspector panel](editor-inspector.md) shows the scene's settings\. When you choose an entity, the inspector panel shows the entity's components\.
4 |
5 | ![\[\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/editor-entities-scene.png)
6 |
7 | Organize your entities by their physical or logical relationship to other entities\. An entity's position, rotation, and scale are relative to its parent\. When you move the parent, the child moves as well\. To change an entity's parent, drag it onto the new parent in the entities panel\.
8 |
9 | **Entities panel controls**
10 | + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/entities-icons-collapse.png) – Collapse the entity to hide its children in the entities panel\.
11 | + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/entities-icons-hide.png) – Hide or show an entity in the canvas\.
12 | + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/entities-icons-duplicate.png) – Duplicate an entity\.
13 | + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/entities-icons-trash.png) – Delete an entity\.
14 | + ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/entities-icons-undo.png) – Undo or redo changes\.
15 |
16 | Double click an entity's name to rename it\. Double click the entity's icon to frame it in the canvas\.
--------------------------------------------------------------------------------
/doc-source/editor-inspector.md:
--------------------------------------------------------------------------------
1 | # Using the Inspector Panel in the Amazon Sumerian Editor
2 |
3 | Use the inspector panel to manage scene settings, entities, and assets\. When you select any of these elements in the Sumerian editor, you get the following properties in a section named after the element\.
4 |
5 | ![\[\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/editor-entities-scene.png)
6 |
7 | **Generic properties**
8 | + **Thumbnail** – The thumbnail image for the element\. Drop an image onto the thumbnail field or pause your mouse over it\. Then choose **Take screenshot** to save an image of the current view of the canvas\.
9 | + **Name** – The name of the element\.
10 | + **ID** \(read\-only\) – A unique identifier for the element\.
11 | + **Type** \(read\-only\) – The type of element: scene, entity, or an [asset type](sumerian-assets.md)\.
12 | + **Description** – Description of the element\.
13 | + **Tags** – Key\-only metadata that you can use in scripting\. You can read tags or search for entities with specific tags by using the [context object](scripting-context.md)\.
14 | + **Custom attributes** – Key\-value metadata that you can use in scripting\. You can read attributes by using the [context object](scripting-context.md)\.
15 |
16 | When you choose the scene in the [entities panel](sumerian-entities.md), or click the scene's background in the canvas, the inspector panel shows several additional sections for settings that apply to the entire scene\. These include environmental settings, post\-processing effects, and AWS SDK credentials\. See [Amazon Sumerian Scene Settings](sumerian-scene.md) for more information\.
17 |
18 | When you choose an entity in the entities panel, or click it in the canvas, the inspector panel shows a section for each component on the entity\. At a minimum, every entity has a transform component that determines its location, rotation, and size\. Entities you create by dropping assets onto the scene have additional components based on their type\. You can add components to any entity in the inspector panel by choosing **Add component** at the bottom of the panel\. See [Amazon Sumerian Entities](sumerian-entities.md) for more information\.
19 |
20 | When you choose an asset in the [assets panel](editor-assets.md), the inspector panel shows sections for only components that apply to every instance of the asset in the scene\. For example, a script asset only has code, but a script component on an entity can have parameters that customize that instance of the script\. A material asset, however, has all of the [material component](entities-material.md) properties\. Modifying any of these properties changes every instance of the material in the scene\.
--------------------------------------------------------------------------------
/doc-source/editor-publish.md:
--------------------------------------------------------------------------------
1 | # Publishing Scenes in the Amazon Sumerian Editor
2 |
3 | Publish your Amazon Sumerian scene to share it with users on the internet\. When you publish a scene, Sumerian creates a static website with your scene and hosts it on Amazon CloudFront\. You can link users directly to the scene, or embed it in a frame in your website\.
4 |
5 | You can also deploy a scene for use with AWS Amplify\. When you choose a private deployment, Sumerian generates a configuration file that you can load into your web app to embed a scene that can only be accessed with credentials from Amazon Cognito\.
6 |
7 | **To publish a scene**
8 |
9 | 1. Open your scene in the Sumerian editor\.
10 |
11 | 1. Choose **Publish**\.
12 |
13 | 1. Choose **Create public link** or **Host privately**\.
14 |
15 | 1. Choose **Publish**\.
16 |
17 | For a public scene, open the URL to view it\. This URL is publicly hosted with Amazon CloudFront and can be viewed by anyone\.
18 |
19 | For a private scene, load the configuration file into your Amplify app with the XR module\. For more information, see [AWS Amplify](https://aws-amplify.github.io/amplify-js/media/xr_guide)\.
20 |
21 | With Amplify, access to your scene is granted to users who log in with Amazon Cognito\. For details about adding permissions to your app's identity pool, see [Restricting Access to a Published Scene](sumerian-permissions.md#permissions-amplify)\.
--------------------------------------------------------------------------------
/doc-source/editor-shortcuts.md:
--------------------------------------------------------------------------------
1 | # Keyboard and Mouse Controls for the Amazon Sumerian Editor
2 |
3 | The default camera that Sumerian adds to every scene supports mouse controls for pan, zoom, and orbiting around the camera's anchor point\. To move the camera, press and hold a mouse button while you move the mouse\. If you only have one mouse button, you can use a keyboard key plus mouse button combination to perform the same movements\.
4 |
5 | **Camera Movement**
6 | + **Zoom in or out** – Mouse wheel scroll up or down
7 | + **Pan** – Mouse wheel button, or ShiftLeft mouse button
8 | + **Orbit** – Right mouse button, or AltLeft mouse button
9 |
10 | The Sumerian editor provides keyboard equivalents of most of the [canvas menu buttons](editor-canvas.md)\. Use the bottom row of keys to switch between preset camera views, and the F key to fill the canvas with a single entity\. The space bar hides the side panels to let the canvas fill the screen\.
11 |
12 | **Camera**
13 | + **Frame entity** – F
14 | + **Frame all** – ShiftF
15 | + **Bottom and top views** – V
16 | + **Back and front views** – C
17 | + **Left and right views** – X
18 | + **Editor camera view** – Z
19 | + **Show and hide side bars** – Space
20 |
21 | Select entities by clicking them in either the editor or the **Entities** panel\. With an entity selected, use the following commands to speed up editing\.
22 |
23 | **Editing**
24 | + **Delete entity** – Backspace or Delete
25 | + **Duplicate entity** – Ctrl D
26 | + **Translate handles** – W
27 | + **Rotation handles** – E
28 | + **Scale handles** – R
29 | + **Switch between global and relative transform** – G
30 | + **Undo** – Ctrl Z
31 | + **Redo** – Ctrl Shift Z
32 |
33 | Use the following commands to open the text editor, timeline editor, and publishing menu\.
34 |
35 | **Tools**
36 | + **Text editor** – J
37 | + **Timeline** – T
38 | + **Publish** – Ctrl Shift P
39 |
40 | With the timeline open, use the following commands to adjust keyframes and playheads\.
41 |
42 | **Timeline**
43 | + **Move keyframe left** – Left \(fast\), Ctrl Left \(slow\)
44 | + **Move keyframe right** – Right \(fast\), Ctrl Right \(slow\)
45 | + **Move playhead left** – Shift Left \(fast\), Ctrl Shift Left \(slow\)
46 | + **Move playhead right** – Shift Right \(fast\), Ctrl Shift Right \(slow\)
47 | + **Align keyframe left** – Ctrl Alt 1
48 | + **Align keyframe center** – Ctrl Alt 2
49 | + **Align keyframe right** – Ctrl Alt 3
50 | + **Move keyframe to start** – Home
51 | + **Move keyframe to end** – End
--------------------------------------------------------------------------------
/doc-source/editor-tools.md:
--------------------------------------------------------------------------------
1 | # Using the Tools in the Amazon Sumerian Editor
2 |
3 | The Sumerian editor has three tool panels for working with complex assets and components:
4 | + The **text** editor provides an interface for authoring scripts, JSON documents, and speech files\.
5 | + The **timeline** editor animates entities between keyframes\.
6 | + The **state machine** editor lets you visually construct and connect state machine behaviors and actions\.
7 |
8 | ## Text Editor
9 |
10 | The text editor lets you view and modify all text assets in the scene, including scripts, JSON documents, and speech files\.
11 |
12 | ![\[\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/tools-texteditor.png)
13 |
14 | To use the text editor, choose **Tools**, **Text editor**\. Or press the J key\.
15 |
16 | The **Documents** panel lists the text assets in your scene\. Click one to open it in a tab\. To rename an asset, highlight it and click the pencil icon\.
17 |
18 | When you open a script, the **External Resources** panel appears\. You can use this panel to import librariesfrom the internet that your script depends on\. See [External Dependencies](scripting-dependencies.md) for more information\.
19 |
20 | ## State Machine Editor
21 |
22 | The state machine editor provides a visual representation of the actions and behaviors attached to a [state machine component](entities-statemachine.md)\.
23 |
24 | ![\[\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/tools-statemachine.png)
25 |
26 | To use the state machine editor, click the pencil icon next to a behavior in the assets panel or on a state machine component\.
27 |
28 | The state machine editor shows a box for each behavior\. Each box has a stack of actions, listed in the order that they execute\. When an action transitions to another behavior, an arrow connects the action to the target behavior\. Click an action and drag the cursor to a behavior to create a transition between the two\.
29 |
30 | For more information, see [Amazon Sumerian State Machines](sumerian-statemachines.md)\.
31 |
32 | ## Timeline
33 |
34 | Use timelines to move, rotate, or change the scale of entities over time\. You can set the start and end values of these properties, and add keyframes to control the speed or direction of the animation along the way\. The timeline can also emit custom events, which can be consumed from a state machine or script\.
35 |
36 | ![\[\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/tools-timeline.png)
37 |
38 | For more information, see [Amazon Sumerian Timeline Component](entities-timeline.md)\.
--------------------------------------------------------------------------------
/doc-source/entities-2dgraphics.md:
--------------------------------------------------------------------------------
1 | # Amazon Sumerian 2D Graphics Component
2 |
3 | A two\-dimensional image or video\.
4 |
5 | **Properties**
6 | + **Tint** – The tint color\.
7 | + **Emissiveness** – The emissiveness of the image\.
8 | + **Opacity** – The opacity of the image\.
9 | + **Reflection** – The reflectivity of the image\.
--------------------------------------------------------------------------------
/doc-source/entities-animation.md:
--------------------------------------------------------------------------------
1 | # Amazon Sumerian Animation Component
2 |
3 | You can use the animation component to manage the animations attached to an entity\. The animation component organizes animations into layers of animation states\. Each state refers to a clip in the **Assets** panel and contains additional configuration options\.
4 |
5 | When you import a 3D model that has animations, Amazon Sumerian splits it into separate assets for the model, skeleton, and the animation clips that it includes\. The entity that represents the model in the scene uses an animation component to organize and configure the clips\. For an example, see [Working with a Sample Model](gettingstarted-robin.md)\.
6 |
7 | The animation **State** contains information about an animation, such as how many times it should loop, how fast it should run, and if it has any transition\. If there's no transition for an animation state, the default transitions at the bottom of the list are used\. If you want to switch between animation states, but want the transition between them to be smooth, add a **Transition**\.
8 |
9 | **Transitions**
10 | + **Fade** – A transition that blends over a given time from one animation state to another, beginning with the target clip from local time 0 at the start of the transition\. This is best used with two clips that have similar motions\.
11 | + **SyncFade** – A transition that blends over a given time from one animation state to another, synchronizing the target state to the initial state's start time\. This is best used with two clips that have similar motions\.
12 | + **Frozen** – A two\-state transition that freezes the starting state at its current position and blends that over time with a target state\. The target state moves forward in time during the blend as normal\.
13 |
14 | As long as the skeleton matches, you can import additional or updated animations to an entity without replacing the model\. Drop your model file onto the **Drop animation state file here** field in an animation layer to add the clips from the file to the layer\. To replace a single animation, select the clip in the **Assets** panel and drag the model file onto the **Drop file to replace clip** field\.
--------------------------------------------------------------------------------
/doc-source/entities-camera.md:
--------------------------------------------------------------------------------
1 | # Amazon Sumerian Camera Component
2 |
3 | The camera component turns any entity into a camera\.
4 |
5 | **Properties**
6 | + **Main camera** – Use this camera at the beginning of the scene\. If you have multiple cameras, you can switch between them during both edit and playback modes\.
7 | + **Follow editor camera** – Set the camera position with the editor camera\. This is useful when switching between edit and play modes\.
8 | + **Projection** – Control how the camera projects the 3D world on the 2D canvas\.
9 | + **Field of view \(FOV\)** – Set the number of degrees from left to right that the camera spans\.
10 | + **Clipping planes** – Set the distance from the camera at which objects are drawn\.
11 |
12 | New scenes include a default camera that follows the position of the editor camera\. When you play the scene, the view matches what you last saw in the editor\. To fix the starting position of the camera during playback, clear the **Follow editor camera** check box\. Zoom out to see the default camera and its viewing frustrum, which you can adjust with the field of view and clipping settings\.
13 |
14 | To add a camera to your scene, choose one of the standard camera types from the [Create entity](sumerian-entities.md) menu, or add a camera component to any entity\.
15 |
16 | **Standard Cameras**
17 | + **2D cam** – A parallel projection camera with pan and zoom controls\.
18 | + Middle mouse – Pan\.
19 | + Mouse wheel – Zoom\.
20 | + **Fixed cam** – A perspective camera with no built\-in controls\.
21 | + **Fly cam** – A perspective camera with mouse and keyboard controls\.
22 | + Left mouse – Look around\.
23 | + W, A, S, D – Move forward, left, backward, and right\. Hold Shift to move slowly\.
24 | + **Orbit cam** – A perspective camera with orbit, pan, and zoom controls\.
25 | + Middle mouse – Pan\.
26 | + Right mouse – Orbit\.
27 | + Mouse wheel – Zoom\.
28 |
29 | Add or customize camera controls with the [built\-in camera scripts](scripting-builtins.md)\. Parameters on the scripts, which are also used by the standard camera types, let you customize the camera's controls and behavior\.
30 |
31 | To manage cameras during playback, use a state machine or script\.
32 |
33 | **Topics**
34 | + [State Machine](#entities-camera-statemachine)
35 | + [Script](#entities-dialogue-script)
36 |
37 | ## State Machine
38 |
39 | To manage cameras, add a [state machine](entities-statemachine.md) to any entity in your scene\. Use actions to change the active camera in response to user input\.
40 |
41 | **Example States for camera control**
42 | + **Ready** – 4 **Key pressed** actions listen for number keys and transition to the next state\.
43 | + **Cam 1** through **Cam 4** – **Switch camera** changes the active camera\. **Transition** returns to the ready state\.
44 |
45 | ![\[State machine behavior for camera controls.\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/components-camera-statemachine.png)
46 |
47 | For more information, see [Audio and Camera State Machine Actions in Amazon Sumerian](statemachines-audio.md)\.
48 |
49 | ## Script
50 |
51 | You can use a script to change the active camera during playback by sending the `sumerian.setCurrentCamera` message on the system bus\.
52 |
53 | The following example adds controls to switch between four fixed cameras\. Each camera entity has a script that stores its ID in the context object during setup\.
54 |
55 | **Example Scene**
56 | Use the buttons to switch between cameras\.
57 |
58 | **Example Camera Script**
59 |
60 | ```
61 | 'use strict';
62 | function setup(args, ctx) {
63 | ctx.worldData.camera1id = ctx.entity.id;
64 | }
65 | ```
66 |
67 | Buttons defined in an HTML component on another entity define the controls\.
68 |
69 | **Example Button HTML**
70 |
71 | ```
72 |
88 |