Skip to content

Commit 62154ae

Browse files
author
Datsik Mikhail
committed
1. Fix Typo.
2. Remove all rudement code and custom function. 3. Leave only base functional for first release.
1 parent fcd1a5e commit 62154ae

34 files changed

+122
-1147
lines changed

README.md

+49-23
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,12 @@
11
# Cinema 4D Shotgun toolkit engine
22

33
Cinema 4D Shotgun toolkit base on [Diego Garcia Huerta](https://www.linkedin.com/in/diegogh/) Clarisse Shotgun toolkit.
4-
Developing in progress...
5-
6-
## TODO:
7-
* Find method to stop listen Open, Switch Message Events.
8-
* Clear My Load and Publish functions
9-
* Find Way to Build Menu Automatic.
104

115
![tk-cinema_screenshot01](config/images/tk-cinema_screenshot01.PNG)
126

137
## Overview
148

15-
Implementation of a shotgun toolkit engine for [**Cinema 4D**](https://www.maxon.net). This engine is based on the [tk-maya engine](https://github.com/shotgunsoftware/tk-maya) heavily adapted to Cinema 4D. It supports the classic boostrap startup methodology and integrates with cinema adding a shotgun menu in it's menu bar.
9+
Implementation of a shotgun toolkit engine for [**Cinema 4D**](https://www.maxon.net). This engine is based on the [tk-clarisse engine](https://github.com/diegogarciahuerta/tk-clarisse) adapted to Cinema 4D. It supports the classic boostrap startup methodology and integrates with cinema adding a shotgun menu in it's menu bar.
1610

1711
* [Engine Installation](#engine-installation)
1812
* [Configuring your project for Shotgun Toolkit](#configuring-your-project-for-shotgun-toolkit)
@@ -30,7 +24,7 @@ With the engine, hooks for most of the standard tk application are provided:
3024
* [tk-multi-breakdown](#tk-multi-breakdown)
3125
* [tk-multi-setframerange](#tk-multi-setframerange) ( see notes below as this is a fork from the original shotgun repository to allow having hooks per engine, as the original one has support only for certain applications)
3226

33-
(I've also included a hook that allows to take a [thumbnail](hooks/thumbnail.py) of cinema window, useful for configuring tk-multi-snapshot for example.)
27+
(Also included a hook that allows to take a [thumbnail](hooks/thumbnail.py) of cinema window, useful for configuring tk-multi-snapshot for example.)
3428

3529
**Note: This engine has been tested in Windows using Cinema 4D R20**
3630

@@ -60,19 +54,33 @@ If you haven't done it yet, make sure you have gone through the basic steps to c
6054

6155
* click on *Advanced project setup*
6256

63-
![advanced_project_setup](config/images/advanced_project_setup.png)
57+
<p align="center">
58+
<img src="config/images/advanced_project_setup.png">
59+
</p>
6460

6561
* *Select a configuration*: "Shotgun Default" or pick an existing project that you have already setup pages and filters for.
66-
![select_a_project_configuration](config/images/select_a_project_configuration.png)
62+
63+
<p align="center">
64+
<img src="config/images/select_a_project_configuration.png">
65+
</p>
6766

6867
* *Select a Shotgun Configuration*: select "default" which will download the standard templates/configuration from shotgun. (this documentation is written assuming you have this configuration)
69-
![select_a_shotgun_configuration](config/images/select_a_shotgun_configuration.png)
68+
69+
<p align="center">
70+
<img src="config/images/select_a_shotgun_configuration.png">
71+
</p>
7072

7173
* *Define Storages*: Make sure you name your first storage "primary", and a choose a primary folder where all the 'jobs' will be stored, in this case "D:\demo\jobs" for illustrative purposes.
72-
![define_storages](config/images/define_storages.png)
74+
75+
<p align="center">
76+
<img src="config/images/define_storages.png">
77+
</p>
7378

7479
* *Project Folder Name*: This is the name of the project in disk. You might have some sort of naming convention for project that you might follow, or leave as it is. (My advice is that you do not include spaces in the name!)
75-
![project_folder_name](config/images/project_folder_name.png)
80+
81+
<p align="center">
82+
<img src="config/images/project_folder_name.png">
83+
</p>
7684

7785
* *Select Deployment*: Choose "Centralized Setup". This will be the location of the configuration files (that we will be modifying later). For example, you could place the specific configuration for a project (in this example called game_config) within a folder called "configs" at the same level then the jobs folder, something like:
7886
```shell
@@ -98,8 +106,10 @@ If you haven't done it yet, make sure you have gone through the basic steps to c
98106
└───frameworks
99107
```
100108
(Note that this might not be suitable for more complex setups, like distributed configurations)
101-
![select_deployment](config/images/select_deployment.png)
102109

110+
<p align="center">
111+
<img src="config/images/select_deployment.png">
112+
</p>
103113

104114
## Modifying the toolkit configuration files to add this engine and related apps
105115

@@ -158,20 +168,27 @@ In order for Cinema 4D to show up in the shotgun launcher, we need to add it to
158168
* Navigate to your shotgun url, ie. `example.shotgunstudio.com`, and once logged in, clink in the Shotgun Settings menu, the arrow at the top right of the webpage, close to your user picture.
159169
* Click in the Software menu
160170

161-
![software_entity](config/images/software_entity.png)
171+
<p align="center">
172+
<img src="config/images/software_entity.png">
173+
</p>
162174

163175
* We will create a new entry for Cinema 4D, called "Cinema 4D". The description was conveniently copied and pasted from Wikipedia.
164-
![create_new_software](config/images/create_new_software.png)
176+
177+
<p align="center">
178+
<img src="config/images/create_new_software.png">
179+
</p>
165180

166181
* We should now specify the engine this software will use. "tk-cinema"
167-
![software_specify_engine](config/images/software_specify_engine.png)
182+
183+
<p align="center">
184+
<img src="config/images/software_specify_engine.png">
185+
</p>
168186

169187
* Note that you can restrict this application to certain projects by specifying the project under the projects column. If no projects are specified this application will show up for all the projects that have this engine in their configuration files.
170188

171189
If you want more information on how to configure software launches, here is the detailed documentation from shotgun.
172190
[Configuring software launches](https://support.shotgunsoftware.com/hc/en-us/articles/115000067493#Configuring%20the%20software%20in%20Shotgun%20Desktop)
173191

174-
175192
## Caching and downloading the engine into disk
176193

177194
One last step is to cache the engine and apps from the configuration files into disk. Shotgun provides a tank command for this.
@@ -189,8 +206,9 @@ One last step is to cache the engine and apps from the configuration files into
189206

190207
If we now go back and forth from our project in shotgun desktop ( < arrow top left if you are already within a project ), we should be able to see Cinema 4D as an application to launch.
191208

192-
![cinema_is_configured.png](config/images/cinema_is_configured.png)
193-
209+
<p align="center">
210+
<img src="config/images/cinema_is_configured.png">
211+
</p>
194212

195213
## [tk-multi-workfiles2](https://support.shotgunsoftware.com/hc/en-us/articles/219033088)
196214
This application forms the basis for file management in the Shotgun Pipeline Toolkit. It lets you jump around quickly between your various Shotgun entities and gets you started working quickly. No path needs to be specified as the application manages that behind the scenes. The application helps you manage your working files inside a Work Area and makes it easy to share your work with others.
@@ -203,22 +221,30 @@ A Shotgun Snapshot is a quick incremental backup that lets you version and manag
203221
Hooks are provided to be able to use this tk-app, similar to workfiles2.
204222

205223
## [tk-multi-loader2](https://support.shotgunsoftware.com/hc/en-us/articles/219033078)
206-
![tk-cinema_screenshot01](config/images/tk-cinema_screenshot01.PNG)
224+
225+
<p align="center">
226+
<img src="config/images/tk-cinema_screenshot01.PNG">
227+
</p>
207228

208229
The Shotgun Loader lets you quickly overview and browse the files that you have published to Shotgun. A searchable tree view navigation system makes it easy to quickly get to the task, shot or asset that you are looking for and once there the loader shows a thumbnail based overview of all the publishes for that item. Through configurable hooks you can then easily reference or import a publish into your current scene.
209230

210231
The hooks provided support all the input reference and import formats from Cinema 4D.
211232

212233
## [tk-multi-publish2](https://support.shotgunsoftware.com/hc/en-us/articles/115000097513)
213-
![tk-cinema_screenshot03](config/images/tk-cinema_screenshot05.PNG)
234+
235+
<p align="center">
236+
<img src="config/images/tk-cinema_screenshot05.PNG">
237+
</p>
214238

215239
The Publish app allows artists to publish their work so that it can be used by artists downstream. It supports traditional publishing workflows within the artist’s content creation software as well as stand-alone publishing of any file on disk. When working in content creation software and using the basic Shotgun integration, the app will automatically discover and display items for the artist to publish. For more sophisticated production needs, studios can write custom publish plugins to drive artist workflows.
216240

217241
Only the basic publishing of the current session is provided with this app.
218242

219243
## [tk-multi-breakdown](https://support.shotgunsoftware.com/hc/en-us/articles/219032988)
220-
![tk-clarisse_screenshot02](config/images/tk-cinema_screenshot02.PNG)
221244

245+
<p align="center">
246+
<img src="config/images/tk-cinema_screenshot02.PNG">
247+
</p>
222248

223249
The Scene Breakdown App shows you a list of items you have loaded (referenced) in your scene and tells you which ones are out of date. From this overview, you can select multiple objects and click the update button which will update all your selected items to use the latest published version.
224250

config/core/templates.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
99
# not expressly granted therein are reserved by Shotgun Software Inc.
1010

11-
# Author: Diego Garcia Huerta
12-
# Contact: https://www.linkedin.com/in/diegogh/
11+
# Author: Mykhailo Datsyk
12+
# Contact: https://www.linkedin.com/in/mykhailo-datsyk/
1313
#
1414
# YOU SHOULD MERGE these entries into your templates.yml configuration file, as
1515
# THIS FILE BY ITSELF WILL NOT WORK

config/env/asset.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
# not expressly granted therein are reserved by Shotgun Software Inc.
1010
#
1111

12-
# Author: Diego Garcia Huerta
13-
# Contact: https://www.linkedin.com/in/diegogh/
12+
# Author: Mykhailo Datsyk
13+
# Contact: https://www.linkedin.com/in/mykhailo-datsyk/
1414
#
1515
# YOU SHOULD MERGE these entries into your asset.yml environment file, as
1616
# THIS FILE BY ITSELF WILL NOT WORK

config/env/asset_step.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
# not expressly granted therein are reserved by Shotgun Software Inc.
1010
#
1111

12-
# Author: Diego Garcia Huerta
13-
# Contact: https://www.linkedin.com/in/diegogh/
12+
# Author: Mykhailo Datsyk
13+
# Contact: https://www.linkedin.com/in/mykhailo-datsyk/
1414
#
1515
# YOU SHOULD MERGE these entries into your asset_step.yml environment file, as
1616
# THIS FILE BY ITSELF WILL NOT WORK

config/env/includes/engine_locations.yml

+9-10
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,20 @@
88
# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
99
# not expressly granted therein are reserved by Shotgun Software Inc.
1010

11-
# Author: Diego Garcia Huerta
12-
# Contact: https://www.linkedin.com/in/diegogh/
11+
# Author: Mykhailo Datsyk
12+
# Contact: https://www.linkedin.com/in/mykhailo-datsyk/
1313
#
1414
# YOU SHOULD MERGE these entries into your engine_locations.yml environment
1515
# file, as
1616
# THIS FILE BY ITSELF WILL NOT WORK
1717
# These are the additions to get cinema engine up and running with the
1818
# default tk-apps for this environment
1919

20-
# Cinema
21-
engines.tk-cinema.location:
22-
type: path
23-
path: C:\Users\diego\GoogleDrive\Development\factor64\tk-cinema
24-
25-
# type: git
26-
# path: https://github.com/diegogarciahuerta/tk-cinema
27-
# version: v1.0.0
20+
################################################################################
2821

22+
# -- Cinema
23+
engines.tk-cinema.location:
24+
type: git
25+
branch: master
26+
path: https://github.com/mikedatsik/tk-cinema.git
27+
version: v1.0.0

config/env/includes/settings/tk-clarisse.yml config/env/includes/settings/tk-cinema.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
# not expressly granted therein are reserved by Shotgun Software Inc.
1010
#
1111

12-
# Author: Diego Garcia Huerta
13-
# Contact: https://www.linkedin.com/in/diegogh/
12+
# Author: Mykhailo Datsyk
13+
# Contact: https://www.linkedin.com/in/mykhailo-datsyk/
1414

1515
################################################################################
1616

config/env/includes/settings/tk-multi-breakdown.yml

+6-2
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,18 @@
88
# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
99
# not expressly granted therein are reserved by Shotgun Software Inc.
1010

11-
# Author: Diego Garcia Huerta
12-
# Contact: https://www.linkedin.com/in/diegogh/
11+
# Author: Mykhailo Datsyk
12+
# Contact: https://www.linkedin.com/in/mykhailo-datsyk/
1313
#
1414
# YOU SHOULD MERGE these entries into your tk-app yaml configuration file, as
1515
# THIS FILE BY ITSELF WILL NOT WORK
1616
# These are the additions to get cinema engine up and running with the
1717
# default tk-apps for this environment
1818

19+
################################################################################
20+
21+
# -- Cinema
22+
1923
settings.tk-multi-breakdown.cinema:
2024
hook_scene_operations: '{engine}/tk-multi-breakdown/tk-cinema_scene_operations.py'
2125
location: "@apps.tk-multi-breakdown.location"

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

+6-7
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,24 @@
88
# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
99
# not expressly granted therein are reserved by Shotgun Software Inc.
1010

11-
# Author: Diego Garcia Huerta
12-
# Contact: https://www.linkedin.com/in/diegogh/
11+
# Author: Mykhailo Datsyk
12+
# Contact: https://www.linkedin.com/in/mykhailo-datsyk/
1313
#
1414
# YOU SHOULD MERGE these entries into your tk-app yaml configuration file, as
1515
# THIS FILE BY ITSELF WILL NOT WORK
1616
# These are the additions to get cinema engine up and running with the
1717
# default tk-apps for this environment
1818

19-
# cinema
19+
################################################################################
20+
21+
# -- Cinema
22+
2023
settings.tk-multi-loader2.cinema:
2124
actions_hook: '{engine}/tk-multi-loader2/tk-cinema_actions.py'
2225
action_mappings:
2326
Alembic Cache: [reference, import]
24-
Obj File: [import]
25-
Lwo File: [import]
26-
Lws File: [import]
2727
Image: [texture_node, texture_stream_node, import]
2828
Cinema Project File: [reference, import]
29-
Vdb File: [import]
3029
entities:
3130
- caption: Assets
3231
entity_type: Asset

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
99
# not expressly granted therein are reserved by Shotgun Software Inc.
1010

11-
# Author: Diego Garcia Huerta
12-
# Contact: https://www.linkedin.com/in/diegogh/
11+
# Author: Mykhailo Datsyk
12+
# Contact: https://www.linkedin.com/in/mykhailo-datsyk/
1313
#
1414
# YOU SHOULD MERGE these entries into your tk-app yaml configuration file, as
1515
# THIS FILE BY ITSELF WILL NOT WORK
@@ -18,7 +18,7 @@
1818

1919
################################################################################
2020

21-
# --- Cinema
21+
# -- Cinema
2222

2323
# asset step
2424
settings.tk-multi-publish2.cinema.asset_step:

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

+6-3
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,18 @@
88
# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
99
# not expressly granted therein are reserved by Shotgun Software Inc.
1010

11-
# Author: Diego Garcia Huerta
12-
# Contact: https://www.linkedin.com/in/diegogh/
11+
# Author: Mykhailo Datsyk
12+
# Contact: https://www.linkedin.com/in/mykhailo-datsyk/
1313
#
1414
# YOU SHOULD MERGE these entries into your tk-app yaml configuration file, as
1515
# THIS FILE BY ITSELF WILL NOT WORK
1616
# These are the additions to get cinema engine up and running with the
1717
# default tk-apps for this environment
1818

19-
# cinema
19+
################################################################################
20+
21+
# -- Cinema
22+
2023
settings.tk-multi-shotgunpanel.cinema:
2124
action_mappings:
2225
PublishedFile:

config/env/includes/settings/tk-multi-snapshot.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
99
# not expressly granted therein are reserved by Shotgun Software Inc.
1010

11-
# Author: Diego Garcia Huerta
12-
# Contact: https://www.linkedin.com/in/diegogh/
11+
# Author: Mykhailo Datsyk
12+
# Contact: https://www.linkedin.com/in/mykhailo-datsyk/
1313
#
1414
# YOU SHOULD MERGE these entries into your tk-app yaml configuration file, as
1515
# THIS FILE BY ITSELF WILL NOT WORK
@@ -18,7 +18,7 @@
1818

1919
################################################################################
2020

21-
# ---- Cinema
21+
# -- Cinema
2222

2323
# asset step
2424
settings.tk-multi-snapshot.cinema.asset_step:

config/env/includes/settings/tk-multi-workfiles2.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
99
# not expressly granted therein are reserved by Shotgun Software Inc.
1010

11-
# Author: Diego Garcia Huerta
12-
# Contact: https://www.linkedin.com/in/diegogh/
11+
# Author: Mykhailo Datsyk
12+
# Contact: https://www.linkedin.com/in/mykhailo-datsyk/
1313
#
1414
# YOU SHOULD MERGE these entries into your tk-app yaml configuration file, as
1515
# THIS FILE BY ITSELF WILL NOT WORK
@@ -18,7 +18,7 @@
1818

1919
################################################################################
2020

21-
# -- cinema
21+
# -- Cinema
2222

2323
settings.tk-multi-workfiles2.cinema.project:
2424
allow_task_creation: true

config/env/project.yml

+2-3
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
# not expressly granted therein are reserved by Shotgun Software Inc.
1010
#
1111

12-
# Author: Diego Garcia Huerta
13-
# Contact: https://www.linkedin.com/in/diegogh/
12+
# Author: Mykhailo Datsyk
13+
# Contact: https://www.linkedin.com/in/mykhailo-datsyk/
1414
#
1515
# YOU SHOULD MERGE these entries into your project.yml environment file, as
1616
# THIS FILE BY ITSELF WILL NOT WORK
@@ -20,6 +20,5 @@
2020
includes:
2121
- ./includes/settings/tk-cinema.yml
2222

23-
2423
engines:
2524
tk-cinema: "@settings.tk-cinema.project"

config/env/sequence.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
# not expressly granted therein are reserved by Shotgun Software Inc.
1010
#
1111

12-
# Author: Diego Garcia Huerta
13-
# Contact: https://www.linkedin.com/in/diegogh/
12+
# Author: Mykhailo Datsyk
13+
# Contact: https://www.linkedin.com/in/mykhailo-datsyk/
1414
#
1515
# YOU SHOULD MERGE these entries into your sequence.yml environment file, as
1616
# THIS FILE BY ITSELF WILL NOT WORK

0 commit comments

Comments
 (0)