Skip to content

Commit 6a00e39

Browse files
authored
6647 remove script (#6)
Removed the add integration and wrote some doc instead.
1 parent 40ce7ae commit 6a00e39

File tree

2 files changed

+68
-354
lines changed

2 files changed

+68
-354
lines changed

README.md

Lines changed: 68 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,70 @@
11
## Documentation
22

3-
For more information on how to run the Shotgun/Unreal integration, please see the [support documentation](https://docs.unrealengine.com/en-us/Editor/Content/Using-Unreal-Engine-with-Autodesk-Shotgun).
3+
This repository is a part of the ShotGrid Pipeline Toolkit/Unreal integration and contains the source code for SG TK Unreal engine.
4+
5+
The simplest way to add the ShotGrid Toolkit integration to Unreal is to start from the available standard Shotgrid Toolkit configurations:
6+
- Default2 SG TK configuration: https://github.com/ue4plugins/tk-config-unreal
7+
- Basic SG TK configuration: https://github.com/ue4plugins/tk-config-unrealbasic
8+
9+
However, it is possible to manually add the integration to an existing SG TK configuration from the files provided in the `resources/config` folder.
10+
11+
### Configuring the file system schema for a default2 base configuration
12+
If your SG TK configuration needs a file system schema, copy the files and directories from `resources/config/schema` under the `core/schema` folder of your existing configuration.
13+
```
14+
schema/
15+
└── project
16+
├── assets
17+
│   └── asset_type
18+
│   └── asset
19+
│   └── step
20+
│   ├── publish
21+
│   │   └── fbx
22+
│   │   └── placeholder
23+
│   └── work
24+
│   └── fbx
25+
│   └── placeholder
26+
└── sequences
27+
└── sequence
28+
└── editorial
29+
└── placeholder
30+
```
31+
32+
### Adding the SG TK Unreal components
33+
The `resources/config/unreal` folder contains all definitions needed by the integration
34+
```
35+
unreal/
36+
├── frameworks.yml
37+
├── settings
38+
│   ├── tk-multi-loader2.yml
39+
│   ├── tk-multi-publish2.yml
40+
│   ├── tk-multi-shotgunpanel.yml
41+
│   └── tk-unreal.yml
42+
├── templates.yml
43+
└── tk-unreal-location.yml
44+
```
45+
46+
This folder should be copied to the `env/includes` folder of your existing configuration.
47+
48+
Then the following files (or similar) need to be modified to add the Unreal integration:
49+
50+
- *core/templates.yml*:
51+
- add `include: ../env/includes/unreal/templates.yml`
52+
- *env/project.yml*:
53+
- add `- ./includes/unreal/settings/tk-unreal.yml` to *includes*
54+
- add `tk-unreal: "@settings.tk-unreal.project"` to *engines*
55+
- *env/asset_step.yml*:
56+
- add `- ./includes/unreal/settings/tk-unreal.yml` to *includes*
57+
- add `tk-unreal: "@settings.tk-unreal.asset_step"` to *engines*
58+
- *env/includes/settings/tk-maya.yml* or *env/includes/maya/asset_step.yml*:
59+
- add `- ../unreal/settings/tk-multi-publish2.yml` to *includes*
60+
- replace *tk-multi-publish2* asset step setting with: `tk-multi-publish2: "@settings.tk-multi-publish2.maya.asset_step.unreal"`
61+
- *env/includes/frameworks* or *env/includes/common/frameworks.yml*:
62+
- add `include: unreal/frameworks.yml`
63+
- *env/includes/settings/tk-desktop.yml* or *env/includes/desktop/project.yml*:
64+
- add "*Unreal*" to Creative Tools group.
65+
66+
67+
68+
## See also:
69+
For more information on how to run the ShotGrid/Unreal integration, please see the [support documentation](https://docs.unrealengine.com/4.27/en-US/ProductionPipelines/UsingUnrealEnginewithAutodeskShotGrid).
70+

0 commit comments

Comments
 (0)