Skip to content

andrewrbrady/zombietron

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Zombietron - CEP skeleton template

This is my personal boilerplate and build system for creating Adobe Extension Panels.

It is based on Adam Plouff's excellent Skelotron template.

Features/Overview

Most of the Original Skeletor Features

  • Transferring data as JSON from panel to be used within an extendscript function.
  • Modal popup.
  • Automatic detection of host app brightness to match panel - updating with JavaScript.
  • Context and flyout menus.

New Features

  • Rewritten .gulpfile, using Gulp 4.
  • Added development feature to .gulpfile, allowing for quicker panel development with quicker code.
  • Gulp setup for creating certificate for the extension.
  • A "Make New Composition" example feature so there was something besides a blank panel in there.

RIP

  • Removed Vue and Vue-dependent features 😢

How to set up automatically using Videotools

Videotools is a set of Python scripts I wrote to support video pipeline workflows, including some tools to assist with panel development.

The Zombietron Cloner (zombietron-cloner.py) will automatically download the project and configure it correctly.

Manual Setup

If you do not want to use the Zombietron Cloner, you can download and set up manually.

  1. Clone Zombietron from Github.
git clone https://github.com/andrewrbrady/zombietron.git
  1. Rename the Zombietron project folder.
  2. cd into the new project folder.
  3. Install the necessary packages with npm.
npm install
  1. Do a search and replace for all the files in the renamed Zombietron folder for YourNewToolName.
  • You can try the following shell command. OSX users-please note the blank input for the sed command. This was necessary during testing.
cd ../
grep -rl Zombietron . --exclude-dir=.git | xargs sed -i '' 's/Zombietron/YourNewToolName/g'
  1. Create a symlink between the src folder in your new directory. Change 'username' in the command below to match your system username.
ln -s /Users/${USER}/Development/YourNewToolName/src /Users/username/Library/Application Support/Adobe/CEP/extensions/YourNewToolName
  1. Download ZXP Installer. Open it and navigate to settings. In here you can enable extension debugging which allows you to open and use unsigned (in progress) extensions.

  2. Open After Effects and navigate to Window > Extensions > YourNewToolName

  3. Follow the instructions in the "Development" section to use Gulp to develop your panel.

  4. Debugging may be done in Chrome at http://localhost:8073/

  • This address may be set to anything you want in the invisible debug file

Development

I personally find breaking projects down to a more granular level makes them easier to manage and less prone to mistakes. Gulp makes it easy to work on projects in many smaller files, ultimately compiling them into a single file.

How to use the development build feature:

  1. Use Gulp to watch for project changes.
gulp dev
  1. Gulp will begin watching all files the 'dev' directory for changes.
  2. Make changes to your HTML, JS, and/or JSX files in the "dev" folder.
  3. Save your changes.

What does this do?

  1. Gulp combines all files in the dev/jsx folder into one jsx file. It then wraps this .jsx file in an anonymous function.
  2. Gulp combines all files in the dev/js folder into one js file. It then wraps the code within this .js file in an anonymous function.
  3. Gulp builds all the files from the 'dev' directory into the 'src' directory.

Your changes will now be visible in your After Effects panel by right clicking the panel and selecting "Reload", or closing and relaunching from the Window > Extensions menu.

Using Gulp to sign and build a panel for distribution

Once you're all done and want to share with someone else you need to sign the extension. This is for security and means it can't be edited. You need to create a certificate but you only need to do this once. Reuse this certificate for future tools too.

  1. Download ZXPSignCmd and place it in your Applications folder.
  • Type gulp and hit enter
  • A brand new BrutalNameTool.zxp will now be the Zombietron/Install folder
  • Install this new zxp file with ZXP Installer to make sure it works

Thanks

Obviously Adam Plouff, for releasing Skeotron to the public, and everyone else in the After Effects development community.

License

Apache 2.0

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •