Big update for review

Author: ryanmayeda

LICENSE

@@ -1,146 +1,17 @@
-SHOTGUN PIPELINE TOOLKIT SOURCE CODE LICENSE
+Your use of this Unreal® Engine 4 – Shotgun integration, as distributed in this GitHub repository, is governed by the BSD 3-clause license.
 
-Version: 7/07/2013
+Copyright 2018 Epic Games, Inc.
 
-Shotgun Software Inc. ("Company") provides the Shotgun Pipeline Toolkit,
-software, including source code, in this package or repository folder (the
-"Shotgun Toolkit Code") subject to your acceptance of and compliance with
-the following terms and conditions (the "License Terms"). By accessing,
-downloading, copying, using or modifying any of the Shotgun Toolkit Code,
-you agree to these License Terms.
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 
-Eligibility
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 
-The following license to the Shotgun Toolkit Code is valid only if and while
-you are a customer of Company in good standing with either: (a) a current,
-paid-up (or free-for-evaluation) subscription or fixed-term license for
-Company's Shotgun Platform; or (b) a perpetual license and current, paid-up
-maintenance and support contract for the Shotgun Platform.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 
-Shotgun Toolkit Code License
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 
-Subject to the eligibility criteria above and your compliance with these
-License Terms, Company grants to you a non-exclusive, limited license to
-reproduce, use, and make derivative works of (including by compiling object
-code versions of) the Shotgun Toolkit Code solely for your non-commercial or
-internal business purposes in connection with your authorized use of the
-Shotgun Platform.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-Company reserves all rights in the Shotgun Toolkit Code not expressly granted
-above. These License Terms do not grant or require Company to grant, by
-implication, estoppel, or otherwise, any other licenses or rights with respect
-to the Shotgun Toolkit Code or any of Company's other software or intellectual
-property rights. You agree not to take any action with respect to the Shotgun
-Toolkit Code that is not expressly authorized above.
+#########
 
-You must keep intact (and, in the case of copies, reproduce) all copyright
-and other proprietary notices, including all references to and copies of these
-License Terms, as originally included on, in, or with the Shotgun Toolkit
-Code. You must ensure that all derivative works you make of the Shotgun
-Toolkit Code contain or are accompanied by comparable and conspicuous notices
-that the underlying Shotgun Toolkit Code is the confidential information of
-Company and is subject to Company's copyrights and these License Terms.
-
-No Redistribution or Disclosure
-
-You acknowledge that the Shotgun Toolkit Code is and contains proprietary and
-trade-secret information of Company. You may not distribute, disclose to any
-third party, operate for the benefit of third parties (for example, on a
-hosted basis), or otherwise commercially exploit the Shotgun Toolkit Code or
-any portion or derivative work thereof without Company's separate and express
-written consent. For purposes of this restriction, third parties do not
-include your employees or agents acting on your behalf who are bound to abide
-by these License Terms.
-
-No Warranties or Support
-
-The Shotgun Toolkit Code is provided "AS IS" and with all faults. Company
-makes no warranties whatsoever, whether express, implied, or otherwise,
-concerning the Shotgun Toolkit Code. Company has no obligation to provide
-maintenance or technical support for the Shotgun Toolkit Code (unless
-otherwise expressly agreed in a separate written agreement between you and
-Company).
-
-Liability
-
-You agree to be solely responsible for your use and modifications of the
-Shotgun Toolkit Code, and for any harm or liability arising out of such use
-or modifications, including but not limited to any liability for infringement
-of third-party intellectual property rights.
-
-To the fullest extent permitted under applicable law, you agree that: (a)
-Company will not be liable under these License Terms or otherwise for any
-direct, indirect, incidental, special, consequential, or exemplary damages,
-including but not limited to damages for loss of profits, goodwill, use, data
-or other intangible losses, in relation to the Shotgun Toolkit Code or your
-use or inability to use the Shotgun Toolkit Code, even if Company has been
-advised of the possibility of such damages; and (b) in any event, Company's
-aggregate liability under these License Terms or in connection with the
-Shotgun Toolkit Code, regardless of the form of action and under any theory
-(whether in contract, tort, statutory, or otherwise), will not exceed the
-greater of $50 or the amount (if any) that you actually paid for access to
-the Shotgun Toolkit Code.
-
-Ownership
-
-Company retains sole and exclusive ownership of the Shotgun Toolkit Code and
-all copyright and other intellectual property rights therein. You will own any
-derivative works you make to the Shotgun Toolkit Code, subject to: (a) the
-preceding sentence; and (b) the provisions below regarding ownership of any
-code you elect to contribute to Company.
-
-Contributions
-
-The following terms apply to any derivative works of the Shotgun Toolkit Code
-(or any other materials) that you choose to contribute to Company.
-
-For good and valuable consideration, receipt of which is acknowledged, you
-hereby transfer and assign to Company your entire right, title, and interest
-(including all rights under copyright) in: (a) any software code,
-documentation, and/or other materials that you deliver to Company for
-inclusion in, improvement of, use with, or documentation of Company's software
-program(s), including but not limited to any code, documentation, and/or other
-materials identified in a contribution form you submit to Company in an
-applicable form designated by Company; and (b) any future revisions of such
-code, documentation, and/or other materials that you make hereafter. The code,
-documentation, other materials, and future revisions described above are
-collectively referred to below as the "Contribution."
-
-As used below, the "Company Programs" means and includes the Company software
-program(s) identified on any contribution form you submit to Company, and any
-other software into which Company incorporates or with which Company uses or
-distributes the Contribution or any version or portion thereof.
-
-Company grants you a non-exclusive right to continue to modify, make
-derivative works of, reproduce, and use the Contribution for your
-non-commercial or internal business purposes, and to further Company's
-development of Company Programs. This grant does not: (a) limit Company's
-rights, (b) grant you any rights with respect to the Company Programs; nor
-(c) permit you to distribute, operate for the benefit of third parties (for
-example, on a hosted basis), or otherwise commercially exploit the
-Contribution.
-
-You acknowledge that if Company elects to distribute the Contribution or any
-version or portion thereof, it may do so on any basis that it chooses
-(including under any proprietary or open-source licensing terms), without
-further compensation to you.
-
-You agree that if you have or acquire hereafter any patent or interface
-copyright or other intellectual property interest dominating the Contribution
-or any Company Programs (or use thereof), such dominating interest will not be
-used to undermine the effect of the assignment set forth above. Accordingly,
-Company and its direct and indirect licensees are licensed to make, use, sell,
-distribute, and otherwise exploit, in the Company Programs and their future
-versions and derivative works, without royalty or limitation, the subject
-matter of the dominating interest. This license provision will be binding on
-you and on any assignees of, or other successors to, the dominating interest.
-
-You hereby represent and warrant that you are the sole copyright holder for
-the Contribution and that you have the right and power to enter into this
-contract. You shall indemnify and hold harmless Company and its officers,
-employees, and agents against any and all claims, actions or damages
-(including attorney's reasonable fees) asserted by or paid to any party on
-account of a breach or alleged breach of the foregoing warranty. You make no
-other express or implied warranty (including without limitation any warranty
-of merchantability or fitness for a particular purpose) regarding the
-Contribution.
+Your use of the Shotgun Pipeline Toolkit is governed by the applicable license agreement between you and Autodesk/Shotgun. 

core/schema/project/assets/asset_type/asset/step/publish/fbx/placeholder

@@ -0,0 +1,4 @@
+# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
+# Any file named 'placeholder' will not be copied across when folders are created.
+# Note: You can which files should be ignored when folders are created in the ignore_files file,
+# located in the schema folder.

core/schema/project/assets/asset_type/asset/step/work/fbx/placeholder

@@ -0,0 +1,4 @@
+# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
+# Any file named 'placeholder' will not be copied across when folders are created.
+# Note: You can which files should be ignored when folders are created in the ignore_files file,
+# located in the schema folder.

core/templates.yml

@@ -121,6 +121,20 @@ keys:
         default: ma
         alias: extension
 
+    # These are used by Unreal
+    sg_category_1:
+        type: str
+        shotgun_entity_type: Asset
+        shotgun_field_name: sg_category_1
+    sg_category_2:
+        type: str
+        shotgun_entity_type: Asset
+        shotgun_field_name: sg_category_2
+    sg_category_3:
+        type: str
+        shotgun_entity_type: Asset
+        shotgun_field_name: sg_category_3
+
 #
 # The paths section contains all the the key locations where files are to be stored
 # by Sgtk Apps. Each path is made up of several keys (like {version} or {shot}) and
@@ -358,6 +372,16 @@ paths:
     hiero_render_path:
         definition: 'sequences/{Sequence}/{Shot}/editorial/{YYYY}_{MM}_{DD}/renders/{project}_{Shot}.{SEQ}.dpx'
 
+    #
+    # Unreal
+    #
+
+    # level sequence review output from unreal
+    unreal_movie_render:
+        definition: 'shotgun/movie_render/{name}[.v{version}].avi'
+    unreal_movie_publish:
+        definition: 'to_publish/{name}[.v{version}].avi'
+
     ##########################################################################################
     # Asset pipeline
 
@@ -414,6 +438,20 @@ paths:
     # The location of published maya files
     maya_asset_publish:
         definition: '@asset_root/publish/maya/{name}.v{version}.{maya_extension}'
+    # use maya_asset_work
+    # maya_scenes: "shotgun/maya_scenes/{name}[.v{version}].mb"
+    # use maya_asset_publish
+    # maya_scenes_publish: "shotgun/maya_publish/{name}[.v{version}].mb"
+    # The location of FBX exports for Unreal
+    maya_asset_fbx_export: 
+        definition: '@asset_root/work/fbx/{name}.v{version}.fbx'
+    maya_asset_fbx_publish:
+        definition: '@asset_root/publish/fbx/{name}.v{version}.fbx'
+    # The location of turntable review output rendered in Unreal
+    maya_ue4_turntable_render:
+        definition: '@asset_root/work/images/{name}_turntable_v{version}.avi'
+    maya_ue4_turntable_publish:
+        definition: '@asset_root/review/{name}_turntable_v{version}.avi'
 
 
     #
@@ -527,6 +565,17 @@ paths:
         definition: '@asset_root/publish/nuke/{name}.v{version}.nk'
 
 
+    #
+    # Unreal
+    #
+
+    # static mesh export from unreal
+    unreal_asset_fbx_export:
+        definition: 'shotgun/fbx_export/{name}.fbx'
+    unreal_asset_publish:
+        definition: 'to_publish/{name}.fbx'
+
+
 #
 # The strings section is similar to the paths section - but rather than defining paths
 # on disk, it contains a list of strings. Strings are typically used when you want to be
@@ -549,3 +598,14 @@ strings:
 
     # define how new Mari projects should be named
     mari_asset_project_name: "{mari.project_name} - Asset {asset_name}, {task_name}"
+
+    # base templates for a Shotgun asset to import into the Unreal Content Browser
+    unreal_asset_template: "/Game/Assets/{sg_asset_type}/{Asset}/"
+    unreal_asset_notype: "/Game/Assets/{Asset}/"
+    unreal_published_file: "/Game/PublishedFiles/{Asset}/"
+
+    # project-specific templates using categories to classify assets for Unreal import
+    unreal_fields_query: "{sg_asset_type} {Asset} {sg_category_1} {sg_category_2} {sg_category_3}"
+    unreal_asset_3_categories: "/Game/Assets/{sg_category_1}/{sg_category_2}/{sg_category_3}/{Asset}/"
+    unreal_asset_2_categories: "/Game/Assets/{sg_category_1}/{sg_category_2}/{Asset}/"
+    unreal_asset_1_category: "/Game/Assets/{sg_category_1}/{Asset}/"

env/includes/engine_locations.yml

@@ -79,4 +79,10 @@ engines.tk-shotgun.location:
   name: tk-shotgun
   version: v0.8.2
 
+# Unreal
+engines.tk-unreal.location:
+  type: git_branch
+  path: [email protected]:shotgunsoftware/tk-unreal
+  branch: master
+  version: 3f7ab98bfe2f8b475a64208481e8037d21ab1c4b
 

env/includes/frameworks.yml

@@ -54,3 +54,11 @@ frameworks:
       version: v0.2.7
       type: app_store
       name: tk-framework-widget
+
+  # unrealqt - PySide build for Unreal (Windows-only)
+  tk-framework-unrealqt_v1.x.x:
+    location:
+      type: git_branch
+      path: [email protected]:shotgunsoftware/tk-framework-unrealqt
+      branch: master
+      version: d21ff6124a901ce018ab639cbefe8bfc67115a79

env/includes/settings/tk-multi-loader2.yml

@@ -259,3 +259,23 @@ settings.tk-multi-loader2.motionbuilder:
     hierarchy: [entity, content]
   location: "@apps.tk-multi-loader2.location"
 
+# unreal
+settings.tk-multi-loader2.unreal:
+  action_mappings:
+    Motion Builder FBX: [import_content, import_level]
+    Maya FBX: [import_content]
+  actions_hook: '{engine}/tk-multi-loader2/tk-unreal_actions.py'
+  entities:
+  - caption: Current Project
+    type: Hierarchy
+    root: "{context.project}"
+    publish_filters: []
+  - caption: My Tasks
+    type: Query
+    entity_type: Task
+    filters:
+    - [project, is, '{context.project}']
+    - [task_assignees, is, '{context.user}']
+    hierarchy: [entity, content]
+  publish_filters: [["sg_status_list", "is_not", null]]
+  location: "@apps.tk-multi-loader2.location"

env/includes/settings/tk-multi-publish2.yml

@@ -178,9 +178,15 @@ settings.tk-multi-publish2.maya.asset_step:
     settings:
         Publish Template: maya_asset_publish
   - name: Publish to Shotgun
-    hook: "{self}/publish_file.py:{engine}/tk-multi-publish2/basic/publish_session_geometry.py"
+    hook: "{self}/publish_file.py:{config}/tk-multi-publish2/tk-maya/basic/publish_fbx.py"
     settings:
-        Publish Template: asset_alembic_cache
+        Work Template: maya_asset_fbx_export
+        Publish Template: maya_asset_fbx_publish
+  - name: Render Turntable in UE4
+    hook: "{self}/publish_file.py:{config}/tk-multi-publish2/tk-maya/basic/publish_turntable.py"
+    settings:
+        Work Template: maya_ue4_turntable_render
+        Publish Template: maya_ue4_turntable_publish
   help_url: *help_url
   location: "@apps.tk-multi-publish2.location"
 
@@ -391,4 +397,33 @@ settings.tk-multi-publish2.motion_builder.shot_step:
   help_url: *help_url
   location: "@apps.tk-multi-publish2.location"
 
+################################################################################
+
+# ---- Unreal
 
+# project
+settings.tk-multi-publish2.unreal.project:
+  collector: "{self}/collector.py:{engine}/tk-multi-publish2/basic/collector.py"
+  collector_settings:
+    Work Template: unreal_asset_fbx_export
+  publish_plugins:
+  - name: Publish to Shotgun
+    hook: "{self}/publish_file.py"
+    settings: {}
+  - name: Upload for review
+    hook: "{self}/upload_version.py"
+    settings: {}
+  - name: Publish to Shotgun
+    hook: "{self}/publish_file.py:{engine}/tk-multi-publish2/basic/publish_session.py"
+    settings: {}
+  - name: Publish to Shotgun
+    hook: "{self}/publish_file.py:{engine}/tk-multi-publish2/basic/publish_asset.py"
+    settings:
+        Publish Template: unreal_asset_publish
+  - name: Publish to Shotgun
+    hook: "{self}/publish_file.py:{engine}/tk-multi-publish2/basic/publish_movie.py"
+    settings:
+        Work Template: unreal_movie_render
+        Publish Template: unreal_movie_publish
+  help_url: *help_url
+  location: "@apps.tk-multi-publish2.location"

env/includes/settings/tk-multi-shotgunpanel.yml

@@ -222,4 +222,11 @@ settings.tk-multi-shotgunpanel.photoshop:
     Version:
     - actions: [quicktime_clipboard, sequence_clipboard, add_to_playlist]
       filters: {}
+  location: "@apps.tk-multi-shotgunpanel.location"
+
+# unreal
+settings.tk-multi-shotgunpanel.unreal:
+  actions_hook: '{self}/general_actions.py:{engine}/tk-multi-shotgunpanel/tk-unreal_actions.py'
+  action_mappings: {}
+  enable_context_switch: true
   location: "@apps.tk-multi-shotgunpanel.location"