Skip to content

Commit 39e71d5

Browse files
ryanmayedaryanmayeda
authored
Merge pull request #4 from ue4plugins/gpltech
Merging all updates from Gpltech for official release
2 parents 90c2816 + ff8cedd commit 39e71d5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

95 files changed

+4545
-3
lines changed

‎.gitignore

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
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

‎.pre-commit-config.yaml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Copyright (c) 2019 Shotgun Software Inc.
2+
#
3+
# CONFIDENTIAL AND PROPRIETARY
4+
#
5+
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
6+
# Source Code License included in this distribution package. See LICENSE.
7+
# By accessing, using, copying or modifying this work you indicate your
8+
# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
9+
# not expressly granted therein are reserved by Shotgun Software Inc.
10+
11+
# Styles the code properly
12+
# Exclude the UI files, as they are auto-generated.
13+
exclude: "ui\/.*py$"
14+
# List of super useful formatters.
15+
repos:
16+
- repo: https://github.com/pre-commit/pre-commit-hooks
17+
rev: v3.2.0
18+
hooks:
19+
# Ensures the code is syntaxically correct
20+
- id: check-ast
21+
language_version: python3
22+
# Ensures a yaml file is properly formatted
23+
- id: check-yaml
24+
# Ensures a file name will resolve on all platform
25+
- id: check-case-conflict
26+
# Checks files with the execute bit set have shebangs
27+
- id: check-executables-have-shebangs
28+
# Ensure there's no incomplete merges
29+
- id: check-merge-conflict
30+
# Adds an empty line if missing at the end of a file.
31+
- id: end-of-file-fixer
32+
# Makes sure requirements.txt is properly formatted
33+
- id: requirements-txt-fixer
34+
# Removes trailing whitespaces.
35+
- id: trailing-whitespace
36+
# Leave black at the bottom so all touchups are done before it is run.
37+
- repo: https://github.com/ambv/black
38+
rev: 20.8b1
39+
hooks:
40+
- id: black
41+
language_version: python3

‎LICENSE

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Your use of this Unreal® Engine 4 – Shotgun integration, as distributed in this GitHub repository, is governed by the BSD 3-clause license.
2+
3+
Copyright 2018 Epic Games, Inc.
4+
5+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
6+
7+
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
8+
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.
10+
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.
12+
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.
14+
15+
#########
16+
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 & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,38 @@
1+
[![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)
2+
13
-------------------------------------------------------------------------
2-
Configuration for running Shotgun with the Unreal Engine
4+
Configuration for running ShotGrid with the Unreal Engine
35
-------------------------------------------------------------------------
46

5-
This Toolkit configuration aims to be a version of tk-config-basic that
6-
supports Unreal Engine
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 update 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 [email protected]: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`

‎azure-pipelines.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Copyright (c) 2019 Shotgun Software Inc.
2+
#
3+
# CONFIDENTIAL AND PROPRIETARY
4+
#
5+
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
6+
# Source Code License included in this distribution package. See LICENSE.
7+
# By accessing, using, copying or modifying this work you indicate your
8+
# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
9+
# not expressly granted therein are reserved by Shotgun Software Inc.
10+
11+
# Imports the shared Azure CI tools
12+
resources:
13+
repositories:
14+
- repository: templates
15+
type: github
16+
name: shotgunsoftware/tk-ci-tools
17+
ref: refs/heads/master
18+
endpoint: shotgunsoftware
19+
20+
# We want builds to trigger for 3 reasons:
21+
# - The master branch sees new commits
22+
# - Each PR should get rebuilt when commits are added to it.
23+
# - When we tag something
24+
trigger:
25+
branches:
26+
include:
27+
- master
28+
tags:
29+
include:
30+
- v*
31+
pr:
32+
branches:
33+
include:
34+
- "*"
35+
36+
# This pulls in a variable group from Azure. Variables can be encrypted or not.
37+
variables:
38+
- group: deploy-secrets
39+
40+
jobs:
41+
- template: build-pipeline.yml@templates
42+
parameters:
43+
skip_tests: true

‎core/core_api.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Copyright (c) 2016 Shotgun Software Inc.
2+
#
3+
# CONFIDENTIAL AND PROPRIETARY
4+
#
5+
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
6+
# Source Code License included in this distribution package. See LICENSE.
7+
# By accessing, using, copying or modifying this work you indicate your
8+
# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
9+
# not expressly granted therein are reserved by Shotgun Software Inc.
10+
11+
# this configuration file defines which version of the toolkit
12+
# core API that should be used at runtime.
13+
14+
location:
15+
type: app_store
16+
name: tk-core
17+
version: v0.20.11

‎core/hooks/README

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
This location is for core hook override files.
2+
3+
The ShotGrid Pipeline Toolkit comes with a series of Core Hooks, essentially snippets of python
4+
that contain key operations such as copying a file, creating directories etc.
5+
6+
These hooks are part of the platform distribution and are therefore bundled with the code itself.
7+
8+
If you want to provide your own hook implementations, for example control file system permissions
9+
as files are being copied, you can override the core hooks by putting a file with the same
10+
name as the core hook in this location. Sgtk will basically look in this folder first as it is
11+
requesting a core hook - if it doesn't find the core hook here, it will look in its internal
12+
platform location.

0 commit comments

Comments
 (0)