|
| 1 | +[](https://dev.azure.com/shotgun-ecosystem/Toolkit/_build/latest?definitionId=49&branchName=master) |
| 2 | + |
| 3 | +------------------------------------------------------------------------- |
| 4 | +Configuration for running ShotGrid with the Unreal Engine |
| 5 | +------------------------------------------------------------------------- |
| 6 | + |
| 7 | +This Toolkit configuration was forked from [tk-config-default2](https://github.com/shotgunsoftware/tk-config-default2) and updates |
| 8 | +from that configuration are regularly merged in. |
| 9 | + |
| 10 | +This configuration extends the tk-config-default2 configuration with an |
| 11 | +Unreal engine as well as several unreal related options in Maya. |
| 12 | + |
| 13 | +For more information how to use the unreal engine, please see the support |
| 14 | +documentation: |
| 15 | + |
| 16 | +https://docs.unrealengine.com/en-US/Engine/Content/UsingUnrealEnginewithAutodeskShotGrid/index.html |
| 17 | + |
| 18 | +For more information about ShotGrid integrations, go to the following url: |
| 19 | +https://developer.shotgridsoftware.com/8085533c/?title=ShotGrid+Integrations+Admin+Guide |
| 20 | + |
| 21 | + |
| 22 | +## Updating this config with changes from the ShotGrid default2 config |
| 23 | + |
| 24 | +It is possible to update this config with latest changes done on the ShotGrid default2 config, for example |
| 25 | +to update ShotGrid Toolkit standard apps to their latest approved version. |
| 26 | + |
| 27 | +This can be done by merging a particular ShotGrid default2 config into a branch and merging this branch once checked on master |
| 28 | + |
| 29 | +* Add ShotGrid default2 config repo as a remote: `git remote add sgdefault2 [email protected]:shotgunsoftware/tk-config-default2.git` |
| 30 | +* Fetch latest changes for the ShotGrid default2 config repo: `git fetch sgdefault2 master` |
| 31 | +* You can checkout these changes in a branch to check logs and tags: `git checkout sgdefault2/master` |
| 32 | +* If needed you can keep this branch around with: `git switch -c sgmaster` |
| 33 | +* Create a new merge branch from the master branch: `git checkout -b default2_merge` |
| 34 | +* Merge a particular tag on this branch: `git merge v1.3.11`. |
| 35 | +* A regular merge needs to be used to preserve tags from the ShotGrid default2 config. |
| 36 | +* Fix conflicts if any, commit and review changes. |
| 37 | +* Merge approved changes on master, tag the internal release, push changes and the tags: `git push; git push --tags`. |
| 38 | + |
| 39 | +The convention used so far when tagging releases for this config is `<ShotGrid default2 config release>-unreal.<internal release>` |
| 40 | +For example `v1.3.11-unreal.0.2.6` |
| 41 | + |
| 42 | +------------------------------------------------------------------------- |
0 commit comments