Tk framework adobe Code Review

.gitignore

@@ -0,0 +1,11 @@
+*.py[co]
+
+.DS_Store
+*.swp
+*.lock
+profile
+Thumbs.db
+
+*.rnd
+*.swp
+pkgs/*

README.md

@@ -1,5 +1,72 @@
 # tk-framework-adobe
 
-A framework for adobe engines
+
+A framework for Adobe engines
+
+
+# Contributing
+
+## Setup development environment
+
+To setup the development environment for this project, you will need to obtain the _**ZXPSignCmd**_ tool provided by Adobe, which can be found [here](https://labs.adobe.com/downloads/extensionbuilder3.html). Once you have logged in using your existing Adobe user account, download the _**CC Extensions Signing Toolkit**_, which will provide you with the necessary executable.
+
+If you are developing on a ***Mac*** please set all necessary variables in `dev/env.mk`.
+
+On ***Windows*** please fill all necessary variables in `dev\env.cmd`
+
+From now on you may test and sign with the following targets:
+
+---
+***Note***
+Be sure to run all of the following commands from the top-level directory of this project.
+---
+
+
+### To install the CEP extension for testing without signing:
+```
+cd dev
+make test
+```
+
+### To sign the CEP extension
+```
+cd dev
+make sign
+```
+
+
+### To create a certificate in for signing the CEP extension
+```
+cd dev
+make create_certificate
+```
+
+---
+***Note***
+In case the configured CERTIFICATE_FILE is not existing this command will automatically be evaluated if using the *sign* target.
+---
+
+
+### To remove the latest signed zxp file
+```
+cd dev
+make clean
+```
+
+### Notes on editing the env files (env.mk/env.cmd)
+
+Changes to the env files (env.mk/env.cmd) will not be tracked in git, because they were configured to be skipped using `git update-index --skip-worktree`.
+This is because changes done to these files will most likely be specific to your development environment and not apply to any others environment.
+
+If you need to change these files - for example because you added a feature to the build process - you can use the following commands:
+
+```
+git update-index --no-skip-worktree dev/env.mk dev/env.cmd
+git add dev\env.*
+git commit -m "your message"
+git update-index --skip-worktree dev/env.mk dev/env.cmd
+```
+
+Please make sure, that when doing so you don't accidentally commit environment specific values like the certificate file path or even your certificate password.
 
 

cep/.debug

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ExtensionList>
+    <Extension Id="com.sg.basic.adobe.panel">
+        <HostList>
+           <Host Name="PHSP" Port="45216"/>
+           <Host Name="PHXS" Port="45217"/>
+           <Host Name="AEFT" Port="45218"/>
+        </HostList>
+    </Extension>
+    <Extension Id="com.sg.basic.adobe.manager">
+        <HostList>
+           <Host Name="PHSP" Port="45226"/>
+           <Host Name="PHXS" Port="45227"/>
+           <Host Name="AEFT" Port="45228"/>
+        </HostList>
+    </Extension>
+</ExtensionList>

cep/CSXS/manifest.xml

@@ -0,0 +1,84 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<ExtensionManifest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ExtensionBundleId="com.sg.basic.adobe" ExtensionBundleName="Shotgun Engine for Adobe CC" ExtensionBundleVersion="1.0" Version="6.0">
+    <ExtensionList>
+        <Extension Id="com.sg.basic.adobe.manager" Version="1.0"/>
+        <Extension Id="com.sg.basic.adobe.panel" Version="1.0"/>
+    </ExtensionList>
+    <ExecutionEnvironment>
+        <HostList>
+            <!-- Photoshop - CC 2014+ -->
+            <Host Name="PHSP" Version="15.0"/>
+            <Host Name="PHXS" Version="15.0"/>
+            <!-- After Effects - CC 2014+ -->
+            <Host Name="AEFT" Version="15.0"/>
+            <!-- Supporting more engines than Photoshop and After Effects can be done in this line -->
+        </HostList>
+        <LocaleList>
+            <Locale Code="All"/>
+        </LocaleList>
+        <RequiredRuntimeList>
+            <RequiredRuntime Name="CSXS" Version="6.0"/>
+        </RequiredRuntimeList>
+    </ExecutionEnvironment>
+    <DispatchInfoList>
+        <Extension Id="com.sg.basic.adobe.manager">
+            <DispatchInfo>
+                <Resources>
+                    <MainPath>./html/manager.html</MainPath>
+                    <CEFCommandLine>
+                        <Parameter>--enable-nodejs</Parameter>
+                    </CEFCommandLine>
+                </Resources>
+                <Lifecycle>
+                    <!-- don't show. keep it secret. keep it safe. -->
+                    <AutoVisible>false</AutoVisible>
+                    <StartOn>
+                        <!-- Adobe CEP startup event -->
+                        <Event>com.adobe.csxs.events.AppOnline</Event>
+                        <!-- Adobe CEP startup event -->
+                        <Event>com.adobe.csxs.events.ApplicationActivate</Event>
+                    </StartOn>
+                </Lifecycle>
+                <UI>
+                    <!-- Custom keeps it hidden. -->
+                    <Type>Custom</Type>
+                    <Geometry>
+                        <Size>
+                            <Height>100</Height>
+                            <Width>100</Width>
+                        </Size>
+                    </Geometry>
+                </UI>
+            </DispatchInfo>
+        </Extension>
+        <Extension Id="com.sg.basic.adobe.panel">
+            <DispatchInfo>
+                <Resources>
+                    <MainPath>./html/panel.html</MainPath>
+                    <CEFCommandLine>
+                        <Parameter>--enable-nodejs</Parameter>
+                    </CEFCommandLine>
+                </Resources>
+                <Lifecycle>
+                    <AutoVisible>true</AutoVisible>
+                </Lifecycle>
+                <UI>
+                    <Type>Panel</Type>
+                    <Menu>Shotgun</Menu>
+                    <Geometry>
+                        <Size>
+                            <Height>350</Height>
+                            <Width>400</Width>
+                        </Size>
+                    </Geometry>
+                    <Icons>
+                        <Icon Type="Normal">./images/IconLight.png</Icon>
+                        <Icon Type="RollOver">./images/IconLightRollOver.png</Icon>
+                        <Icon Type="DarkNormal">./images/IconDark.png</Icon>
+                        <Icon Type="DarkRollOver">./images/IconDarkRollOver.png</Icon>
+                    </Icons>
+                </UI>
+            </DispatchInfo>
+        </Extension>
+    </DispatchInfoList>
+</ExtensionManifest>