Skip to content

Commit f664bfc

Browse files
authored
6648 setup (#1)
Added the unreal integration to a standard tk-config-basic config. Added a bootstrap hook to download tk-framework-unrealqt build for the current platform. _Note: tk-unreal and tk-framework-unrealqt will have to be changed to point to ue4plugins organisation after the various PRs we have are merged to master._
1 parent cbfd42a commit f664bfc

17 files changed

Lines changed: 649 additions & 147 deletions

.gitignore

Lines changed: 44 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,44 @@
1-
# Byte-compiled / optimized / DLL files
2-
__pycache__/
3-
*.py[cod]
4-
*$py.class
5-
.idea/
1+
# ---- ignore special files written during config setup
2+
3+
core/app_store.yml
4+
core/install_location.yml
5+
core/interpreter_*.cfg
6+
core/pipeline_configuration.yml
7+
core/shotgun.yml
8+
tk-metadata
9+
10+
11+
# compiled python files
12+
*.py[co]
13+
14+
# Packages
15+
*.egg
16+
*.egg-info
17+
dist
18+
build
19+
eggs
20+
parts
21+
bin
22+
var
23+
sdist
24+
develop-eggs
25+
.installed.cfg
26+
27+
# Installer logs
28+
pip-log.txt
29+
30+
# Unit test / coverage reports
31+
.coverage
32+
.tox
33+
34+
#Translations
35+
*.mo
36+
37+
#Mr Developer
38+
.mr.developer.cfg
39+
40+
# Visual studio
41+
.vs
42+
# Jetbrains Pycharm
43+
.idea
44+
venv

LICENSE

Lines changed: 9 additions & 138 deletions
Original file line numberDiff line numberDiff line change
@@ -1,146 +1,17 @@
1-
SHOTGUN PIPELINE TOOLKIT SOURCE CODE LICENSE
1+
Your use of this Unreal® Engine 4 – Shotgun integration, as distributed in this GitHub repository, is governed by the BSD 3-clause license.
22

3-
Version: 7/07/2013
3+
Copyright 2018 Epic Games, Inc.
44

5-
Shotgun Software Inc. ("Company") provides the Shotgun Pipeline Toolkit,
6-
software, including source code, in this package or repository folder (the
7-
"Shotgun Toolkit Code") subject to your acceptance of and compliance with
8-
the following terms and conditions (the "License Terms"). By accessing,
9-
downloading, copying, using or modifying any of the Shotgun Toolkit Code,
10-
you agree to these License Terms.
5+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
116

12-
Eligibility
7+
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
138

14-
The following license to the Shotgun Toolkit Code is valid only if and while
15-
you are a customer of Company in good standing with either: (a) a current,
16-
paid-up (or free-for-evaluation) subscription or fixed-term license for
17-
Company's Shotgun Platform; or (b) a perpetual license and current, paid-up
18-
maintenance and support contract for the Shotgun Platform.
9+
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.
1910

20-
Shotgun Toolkit Code License
11+
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.
2112

22-
Subject to the eligibility criteria above and your compliance with these
23-
License Terms, Company grants to you a non-exclusive, limited license to
24-
reproduce, use, and make derivative works of (including by compiling object
25-
code versions of) the Shotgun Toolkit Code solely for your non-commercial or
26-
internal business purposes in connection with your authorized use of the
27-
Shotgun Platform.
13+
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.
2814

29-
Company reserves all rights in the Shotgun Toolkit Code not expressly granted
30-
above. These License Terms do not grant or require Company to grant, by
31-
implication, estoppel, or otherwise, any other licenses or rights with respect
32-
to the Shotgun Toolkit Code or any of Company's other software or intellectual
33-
property rights. You agree not to take any action with respect to the Shotgun
34-
Toolkit Code that is not expressly authorized above.
15+
#########
3516

36-
You must keep intact (and, in the case of copies, reproduce) all copyright
37-
and other proprietary notices, including all references to and copies of these
38-
License Terms, as originally included on, in, or with the Shotgun Toolkit
39-
Code. You must ensure that all derivative works you make of the Shotgun
40-
Toolkit Code contain or are accompanied by comparable and conspicuous notices
41-
that the underlying Shotgun Toolkit Code is the confidential information of
42-
Company and is subject to Company's copyrights and these License Terms.
43-
44-
No Redistribution or Disclosure
45-
46-
You acknowledge that the Shotgun Toolkit Code is and contains proprietary and
47-
trade-secret information of Company. You may not distribute, disclose to any
48-
third party, operate for the benefit of third parties (for example, on a
49-
hosted basis), or otherwise commercially exploit the Shotgun Toolkit Code or
50-
any portion or derivative work thereof without Company's separate and express
51-
written consent. For purposes of this restriction, third parties do not
52-
include your employees or agents acting on your behalf who are bound to abide
53-
by these License Terms.
54-
55-
No Warranties or Support
56-
57-
The Shotgun Toolkit Code is provided "AS IS" and with all faults. Company
58-
makes no warranties whatsoever, whether express, implied, or otherwise,
59-
concerning the Shotgun Toolkit Code. Company has no obligation to provide
60-
maintenance or technical support for the Shotgun Toolkit Code (unless
61-
otherwise expressly agreed in a separate written agreement between you and
62-
Company).
63-
64-
Liability
65-
66-
You agree to be solely responsible for your use and modifications of the
67-
Shotgun Toolkit Code, and for any harm or liability arising out of such use
68-
or modifications, including but not limited to any liability for infringement
69-
of third-party intellectual property rights.
70-
71-
To the fullest extent permitted under applicable law, you agree that: (a)
72-
Company will not be liable under these License Terms or otherwise for any
73-
direct, indirect, incidental, special, consequential, or exemplary damages,
74-
including but not limited to damages for loss of profits, goodwill, use, data
75-
or other intangible losses, in relation to the Shotgun Toolkit Code or your
76-
use or inability to use the Shotgun Toolkit Code, even if Company has been
77-
advised of the possibility of such damages; and (b) in any event, Company's
78-
aggregate liability under these License Terms or in connection with the
79-
Shotgun Toolkit Code, regardless of the form of action and under any theory
80-
(whether in contract, tort, statutory, or otherwise), will not exceed the
81-
greater of $50 or the amount (if any) that you actually paid for access to
82-
the Shotgun Toolkit Code.
83-
84-
Ownership
85-
86-
Company retains sole and exclusive ownership of the Shotgun Toolkit Code and
87-
all copyright and other intellectual property rights therein. You will own any
88-
derivative works you make to the Shotgun Toolkit Code, subject to: (a) the
89-
preceding sentence; and (b) the provisions below regarding ownership of any
90-
code you elect to contribute to Company.
91-
92-
Contributions
93-
94-
The following terms apply to any derivative works of the Shotgun Toolkit Code
95-
(or any other materials) that you choose to contribute to Company.
96-
97-
For good and valuable consideration, receipt of which is acknowledged, you
98-
hereby transfer and assign to Company your entire right, title, and interest
99-
(including all rights under copyright) in: (a) any software code,
100-
documentation, and/or other materials that you deliver to Company for
101-
inclusion in, improvement of, use with, or documentation of Company's software
102-
program(s), including but not limited to any code, documentation, and/or other
103-
materials identified in a contribution form you submit to Company in an
104-
applicable form designated by Company; and (b) any future revisions of such
105-
code, documentation, and/or other materials that you make hereafter. The code,
106-
documentation, other materials, and future revisions described above are
107-
collectively referred to below as the "Contribution."
108-
109-
As used below, the "Company Programs" means and includes the Company software
110-
program(s) identified on any contribution form you submit to Company, and any
111-
other software into which Company incorporates or with which Company uses or
112-
distributes the Contribution or any version or portion thereof.
113-
114-
Company grants you a non-exclusive right to continue to modify, make
115-
derivative works of, reproduce, and use the Contribution for your
116-
non-commercial or internal business purposes, and to further Company's
117-
development of Company Programs. This grant does not: (a) limit Company's
118-
rights, (b) grant you any rights with respect to the Company Programs; nor
119-
(c) permit you to distribute, operate for the benefit of third parties (for
120-
example, on a hosted basis), or otherwise commercially exploit the
121-
Contribution.
122-
123-
You acknowledge that if Company elects to distribute the Contribution or any
124-
version or portion thereof, it may do so on any basis that it chooses
125-
(including under any proprietary or open-source licensing terms), without
126-
further compensation to you.
127-
128-
You agree that if you have or acquire hereafter any patent or interface
129-
copyright or other intellectual property interest dominating the Contribution
130-
or any Company Programs (or use thereof), such dominating interest will not be
131-
used to undermine the effect of the assignment set forth above. Accordingly,
132-
Company and its direct and indirect licensees are licensed to make, use, sell,
133-
distribute, and otherwise exploit, in the Company Programs and their future
134-
versions and derivative works, without royalty or limitation, the subject
135-
matter of the dominating interest. This license provision will be binding on
136-
you and on any assignees of, or other successors to, the dominating interest.
137-
138-
You hereby represent and warrant that you are the sole copyright holder for
139-
the Contribution and that you have the right and power to enter into this
140-
contract. You shall indemnify and hold harmless Company and its officers,
141-
employees, and agents against any and all claims, actions or damages
142-
(including attorney's reasonable fees) asserted by or paid to any party on
143-
account of a breach or alleged breach of the foregoing warranty. You make no
144-
other express or implied warranty (including without limitation any warranty
145-
of merchantability or fitness for a particular purpose) regarding the
146-
Contribution.
17+
Your use of the Shotgun Pipeline Toolkit is governed by the applicable license agreement between you and Autodesk/Shotgun.

README.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,38 @@
11
[![Build Status](https://dev.azure.com/shotgun-ecosystem/Toolkit/_apis/build/status/Configs/tk-config-basic?branchName=master)](https://dev.azure.com/shotgun-ecosystem/Toolkit/_build/latest?definitionId=40&branchName=master)
22

3-
### Toolkit zero configuration setup
3+
-------------------------------------------------------------------------
4+
Configuration for running ShotGrid with the Unreal Engine
5+
-------------------------------------------------------------------------
46

5-
For documentation, please see the [github wiki](https://github.com/shotgunsoftware/tk-config-basic/wiki/Documentation).
7+
This Toolkit configuration was forked from [tk-config-basic](https://github.com/shotgunsoftware/tk-config-basic) and updates
8+
from that configuration are regularly merged in.
9+
10+
This configuration extends the tk-config-basic configuration with an
11+
Unreal engine as well as several Unreal related options in Maya.
12+
13+
For more information on how to use the Unreal engine, please see the support
14+
documentation:
15+
16+
https://docs.unrealengine.com/en-US/Engine/Content/UsingUnrealEnginewithAutodeskShotgun/index.html
17+
18+
-------------------------------------------------------------------------
19+
20+
## Updating this config with changes from the ShotGrid basic config
21+
22+
It is possible to update this config with latest changes done on the ShotGrid basic config, for example
23+
to udpate Shotgun Toolkit standard apps to their latest approved version.
24+
25+
This can be done by merging a particular ShotGrid basic config into a branch and merging this branch once checked on master
26+
27+
* Add ShotGrid basic config repo as a remote: `git remote add sgbasic git@github.com:shotgunsoftware/tk-config-basic.git`
28+
* Fetch latest changes for the ShotGrid basic config repo: `git fetch sgbasic master`
29+
* You can checkout these changes in a branch to check logs and tags: `git checkout sgbasic/master`
30+
* If needed you can keep this branch around with: `git switch -c sgmaster`
31+
* Create a new merge branch from the master branch: `git checkout -b basic_merge`
32+
* Merge a particular tag on this branch: `git merge v1.3.11`.
33+
* A regular merge needs to be used to preserve tags from the ShotGrid basic config.
34+
* Fix conflicts if any, commit and review changes.
35+
* Merge approved changes on master, tag the internal release, push changes and the tags: `git push; git push --tags`.
36+
37+
The convention used so far when tagging releases for this config is `<ShotGrid basic config release>-unreal.<internal release>`
38+
For example `v1.3.11-unreal.0.2.6`

0 commit comments

Comments
 (0)