Skip to content
This repository has been archived by the owner on Jan 10, 2020. It is now read-only.

Commit

Permalink
rename exporter filenames
Browse files Browse the repository at this point in the history
  • Loading branch information
renyu-io committed Dec 13, 2016
1 parent 76f5707 commit 001823b
Show file tree
Hide file tree
Showing 21 changed files with 46 additions and 46 deletions.
6 changes: 3 additions & 3 deletions js/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

## How to export animations from After Effects

See [Keyframes After Effects Scripts/README.html](../Keyframes After Effects Scripts/README.html)
See [scripts/README.html](../scripts/README.html)

---

*The following are instructions for making changes to the JS code.*
*The following are instructions for making changes to the JS code.*
***You don't need to do any of this stuff if you just want to run the script.***

## Setup
Expand Down Expand Up @@ -43,4 +43,4 @@ Usage example: *Convert an After Effects Comp JSON file into a Keyframes Animati
fs.writeFileSync(exportPath, JSON.stringify(AECompToKeyframesAnimation(fs.readFileSync(importPath))));

Usually this code is used by the Keyframes After Effects Scripts/FB Keyframes Exporter.jsx run by Adobe After Effects.
`/Keyframes After Effects Scripts/(lib)/keyframes/AECompToKeyframesAnimation.js` is a compiled version of this code. Compile using the instructions in the setup section above.
`/scripts/lib/keyframes/AECompToKeyframesAnimation.js` is a compiled version of this code. Compile using the instructions in the setup section above.
6 changes: 3 additions & 3 deletions js/package.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"private": true,
"name": "keyframes-scripts",
"version": "0.1.0",
"version": "1.0.0",
"description": "Scripts for Facebook Keyframes",
"scripts": {
"test": "jest",
"test-watch": "jest --watch",
"compile": "rm -rf ../Keyframes\\ After\\ Effects\\ Scripts/\\(lib\\)/keyframes/*; babel --ignore 'node_modules,**/__tests__,src/*types.js' src --out-dir ../Keyframes\\ After\\ Effects\\ Scripts/\\(lib\\)/keyframes",
"compile-watch": "rm -rf ../Keyframes\\ After\\ Effects\\ Scripts/\\(lib\\)/keyframes/*; babel --ignore 'node_modules,**/__tests__,src/*types.js' src --out-dir ../Keyframes\\ After\\ Effects\\ Scripts/\\(lib\\)/keyframes --watch"
"compile": "rm -rf ../scripts/lib/keyframes/*; babel --ignore 'node_modules,**/__tests__,src/*types.js' src --out-dir ../scripts/lib/keyframes",
"compile-watch": "rm -rf ../scripts/lib/keyframes/*; babel --ignore 'node_modules,**/__tests__,src/*types.js' src --out-dir ../scripts/lib/keyframes --watch"
},
"devDependencies": {
"babel-cli": "^6.11.4",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ var __dirname = File($.fileName).parent.fsName;

$.level = 0; // disable debugging

// JS alternative to #include "./(lib)/MudBrickLayer/index.jsxinc"
$.evalFile(File(__dirname + '/(lib)/MudBrickLayer/ExtendScript/AE/index-ae.jsxinc'));
// JS alternative to #include "./lib/MudBrickLayer/index.jsxinc"
$.evalFile(File(__dirname + '/lib/MudBrickLayer/ExtendScript/AE/index-ae.jsxinc'));
require.wasIncludedFrom($.fileName); // make relative requires work

;(function(){

var AECompToKeyframesAnimation = require('./(lib)/keyframes/AECompToKeyframesAnimation');
var UI = require('./(lib)/MudBrickLayer/ExtendScript/common/ui');
var AECompToKeyframesAnimation = require('./lib/keyframes/AECompToKeyframesAnimation');
var UI = require('./lib/MudBrickLayer/ExtendScript/common/ui');

// Set this to true if you want to VERY VERY SLOWLY export a "keyframeTweens"
// array with the computed values of every property that has keyframes
Expand Down Expand Up @@ -133,7 +133,7 @@ var Hooks = {
isSupported: function(){
return $.os.indexOf('Macintosh OS') === 0;
},
_file: File(__dirname + '/(lib)/hooks-macos/after-creation.sh'),
_file: File(__dirname + '/lib/hooks-macos/after-creation.sh'),
fire: function(exportedFilePath){
if (!this._file.exists) {
console.error('After Creation Hook disabled. Enable by creating "' + this._file.fsName + '"');
Expand Down
34 changes: 17 additions & 17 deletions Keyframes After Effects Scripts/README.html → scripts/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,33 @@ <h4><a href="https://helpx.adobe.com/after-effects/using/scripts.html" alt="Afte

<blockquote>By default scripts are not allowed to write files or send or receive communication over a network. To allow scripts to write files and communicate over a network, choose Edit > Preferences > General (Windows) or After Effects > Preferences > General (Mac OS), and select the Allow Scripts To Write Files And Access Network option.</blockquote>

<h2>FB Keyframes Exporter.jsx</h2>
<h2>Keyframes_Exporter.jsx</h2>
<p>Export the current After Effects comp to FB Keyframes Animation Descriptor JSON document.

<blockquote><small><i>Requires "<b>Allow Scripts To Write Files And Access Network</b>"</i></small></blockquote>

<h3>How to install</h3>

<ol>
<li>Quit After Effects
<li>Move all the files under this folder into your AE Scripts folder<br>
<small>e.g. <tt>/Applications/Adobe After Effects CC 2015/Scripts/Keyframes</tt> on macOS</small>
<li>Launch After Effects
<li>Open an After Effects project
<li>Menu item: <b>File / Scripts / Keyframes_Exporter.jsx</b><br>
<small>The exporter palette window will open</small>
<li>Press Export
</ol>

<p>You can keep the palette window open and press Export multiple times.

<h3>How to run</h3>

<ol>
<li>Open an After Effects project
<li>Open the comp you want to export
<li>Menu item: <b>File / Scripts / Run Script File…</b>
<li>Choose <tt>FB Keyframes Exporter.jsx</tt><br>
<li>Choose <tt>Keyframes_Exporter.jsx</tt><br>
<small>The exporter palette window will open</small>
<li>Press Export
</ol>
Expand All @@ -44,18 +59,3 @@ <h3>How to run</h3>
Check this file for warnings about incompatible features.<br>
Also useful for diagnosing performance issues.
</ul>

<h3>How to install</h3>

<ol>
<li>Quit After Effects
<li>Move the folder <tt>Keyframes After Effects Scripts</tt> into your AE Scripts folder<br>
<small>e.g. <tt>/Applications/Adobe After Effects CC 2015/Scripts</tt> on macOS</small>
<li>Launch After Effects
<li>Open an After Effects project
<li>Menu item: <b>File / Scripts / FB Keyframes Exporter.jsx</b><br>
<small>The exporter palette window will open</small>
<li>Press Export
</ol>

<p>You can keep the palette window open and press Export multiple times.
36 changes: 18 additions & 18 deletions Keyframes After Effects Scripts/README.md → scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,45 +4,45 @@

> By default scripts are not allowed to write files or send or receive communication over a network. To allow scripts to write files and communicate over a network, choose Edit > Preferences > General (Windows) or After Effects > Preferences > General (Mac OS), and select the Allow Scripts To Write Files And Access Network option.
## FB Keyframes Exporter.jsx
## Keyframes_Exporter.jsx

Export the current After Effects comp to FB Keyframes Animation Descriptor JSON document.

> _Requires "**Allow Scripts To Write Files And Access Network**"_
### How to install

1. Quit After Effects
2. Move all the files under this folder into your AE Scripts folder
_e.g. `/Applications/Adobe After Effects CC 2015/Scripts/Keyframes` on macOS_
3. Launch After Effects
4. Open an After Effects project
5. Menu item: **File / Scripts / Keyframes_Exporter.jsx**
_The exporter palette window will open_
6. Press Export

You can keep the palette window open and press Export multiple times.

### How to run

1. Open an After Effects project
2. Open the comp you want to export
3. Menu item: **File / Scripts / Run Script File…**
4. Choose `FB Keyframes Exporter.jsx`
4. Choose `Keyframes_Exporter.jsx`
_The exporter palette window will open_
5. Press Export

You'll see a bunch of progress messages.
Eventually the folder with the exported JSON will open.
You'll see three new files:

* `Project.aep.comp-###-Comp Name.kf.json`
* `Project.aep.comp-###-Comp Name.kf.json`
FB Keyframes compatible animation descriptor.

* `Project.aep.comp-###-Comp Name.json`
* `Project.aep.comp-###-Comp Name.json`
Raw JSON description.

* `Project.aep.comp-###-Comp Name.log`
* `Project.aep.comp-###-Comp Name.log`
Export progress messages and warnings with timestamps.
Check this file for warnings about incompatible features.
Also useful for diagnosing performance issues.

### How to install

1. Quit After Effects
2. Move the folder `Keyframes After Effects Scripts` into your AE Scripts folder
_e.g. `/Applications/Adobe After Effects CC 2015/Scripts` on macOS_
3. Launch After Effects
4. Open an After Effects project
5. Menu item: **File / Scripts / FB Keyframes Exporter.jsx**
_The exporter palette window will open_
6. Press Export

You can keep the palette window open and press Export multiple times.

0 comments on commit 001823b

Please sign in to comment.