Tools and documentation for building Creative Cloud app extensions with CEP
JavaScript HTML CSS
Clone or download
dkstevekwak Merge pull request #192 from Adobe-CEP/dev-bridge-doc
Updating Bridge documentation for Bridge 8.1 release
Latest commit dd9fddd Jul 25, 2018

README.md

Getting Started with the Creative Cloud Extension SDK

This page provides resources you need to get started creating extensions for Adobe Creative Cloud applications, using the new HTML5/JavaScript interface model. The Flash/ActionScript interface model for extensions is deprecated in the Creative Cloud release; support has already been removed from CC2014 and later releases.

  • Creative Cloud 2018 products include CEP 8 for developing extensions and add-ons.

  • Refer to https://github.com/Adobe-CEP/CEP-Resources/blob/master/CEP_8.x/Documentation/CEP%208.0%20HTML%20Extension%20Cookbook.md#applications-integrated-with-cep for 2017 product integration with CEP 8.

  • In the Creative Cloud 2015.x release in June 2016, Photoshop and Illustrator use CEP 7 while other applications still use CEP 6.1. Extensions and add-ins must be built on at least CEP 6 infrastructure.

  • In the Creative Cloud 2015 release extensions and add-ins must be built on the CEP 6 infrastructure.

  • In the Creative Cloud 2014 release, extensions and add-ins must be built on the CEP 5 infrastructure and loaded with Extension Manager. The current releases either do not now or soon will not support CEP 4 and Flash/ActionScript extensions.

  • The Creative Suite 6 and the Creative Cloud 2013 releases of Adobe desktop applications support CEP 4, which allows you to build extensions using the older Flash/ActionScript interface model. However, the new HTML5/JavaScript model is preferred. It is recommended that you port existing Flash/ActionScript extensions to the new model.

This SDK provides the low-level tools that you need to build extensions. Extensions that you build using these tools must be packaged as ZXP files in order to be seen and loaded by Extension Manager. You can offer extensions as free or paid products through our marketing portals (Adobe Exchange, the Add-ins website, the Creative Cloud desktop app). When you do this, you upload the extension to Adobe as a single ZXP file.

Resources you will need include:

  • CEP JavaScript libraries for communicating with the operating system and Extension Manager and for communicating with the host application and other extensions.
  • Sample code for how to use these libraries
  • The ZXP packager, a command-line utility

For developing CEP 8.0 HTML/JavaScript extensions for CC 2018.x host applications

Documentation

APIs (https://github.com/Adobe-CEP/CEP-Resources/tree/master/CEP_8.x)

  • Include these files in your extension project if you need to use the APIs.
    • AgoraLib.js
    • CSInterface.js
    • Vulcan.js
  • Do NOT include this file in your extension project. It is already integrated into CEP.
    • CEPEngine_extensions.js
  • Extension Manifest
    • ExtensionManifest_v_7_0.xsd (Please note that, there is no change in xsd file for CEP 8).

Samples

Packaging and Signing Tool (ZXPSignCMD)

Extension Installation Tools


For developing CEP 7.0 HTML/JavaScript extensions for CC 2015.x host applications

Documentation

APIs (https://github.com/Adobe-CEP/CEP-Resources/tree/master/CEP_7.x)

  • Include these files in your extension project if you need to use the APIs.
    • AgoraLib.js
    • CSInterface.js
    • Vulcan.js
  • Do NOT include this file in your extension project. It is already integrated into CEP.
    • CEPEngine_extensions.js
  • Extension Manifest
    • ExtensionManifest_v_7_0.xsd

Samples

Packaging and Signing Tool (ZXPSignCMD)

Extension Installation Tools


For developing CEP 6.1 HTML/JavaScript extensions for CC2015.1 host applications

Documentation

APIs (https://github.com/Adobe-CEP/CEP-Resources/tree/master/CEP_6.x)

  • Include these files in your extension project if you need to use the APIs.
    • AgoraLib.js
    • CSInterface.js
    • Vulcan.js
  • Do NOT include this file in your extension project. It is already integrated into CEP.
    • CEPEngine_extensions.js
  • Extension Manifest
    • ExtensionManifest_v_6_0.xsd

Samples

Packaging and Signing Tool (ZXPSignCMD)

Extension Installation Tools


For developing CEP 6.0 HTML/JavaScript extensions for CC2015 host applications

Documentation

APIs (https://github.com/Adobe-CEP/CEP-Resources/tree/master/CEP_6.x)

  • Include these files in your extension project if you need to use the APIs.
    • AgoraLib.js
    • CSInterface.js
    • Vulcan.js
  • Do NOT include this file in your extension project. It is already integrated into CEP.
    • CEPEngine_extensions.js
  • Extension Manifest (unchanged in CEP 6.0)
    • ExtensionManifest_v_5_0.xsd

Samples

Packaging and Signing Tool (ZXPSignCMD)

Extension Installation Tools


For developing CEP 5.x HTML/JavaScript extensions for CC2014 host applications

Documentation

APIs (https://github.com/Adobe-CEP/CEP-Resources/tree/master/CEP_5.x)

  • Include these files in your extension project if you need to use the APIs.
    • AgoraLib.js
    • CSInterface.js
    • Vulcan.js
  • Do NOT include this file in your extension project. It is already integrated into CEP.
    • CEPEngine_extensions.js
  • Extension Manifest
    • ExtensionManifest_v_5_0.xsd
  • PlugPlugExternalObject

Samples

Other Documents


For developing CEP 4.x and extensions for CS6/CC host applications

Documentation

APIs (https://github.com/Adobe-CEP/CEP-Resources/tree/master/CEP_4.x)

  • Include these files in your extension project if you need to use the APIs.
    • CSInterface.js
    • Vulcan.js
  • Do NOT include this file in your extension project. It is already integrated into CEP.
    • CEPEngine_extensions.js
  • Extension Manifest
    • ExtensionManifest_v_4_0.xsd

Tooling


Miscellaneous help