ae-to-json 项目技术文档

ae-to-json 项目技术文档

【免费下载链接】ae-to-json will export an After Effects project as a JSON object 项目地址: https://gitcode.com/gh_mirrors/ae/ae-to-json

1. 安装指南

1.1 使用 after-effects 模块

首先，你需要安装 ae-to-json 和 after-effects 模块。你可以通过以下命令进行安装：

$ npm i ae-to-json after-effects --save

安装完成后，你可以在 JavaScript 代码中使用这些模块：

var aeToJSON = require('ae-to-json/after-effects');
var ae = require('after-effects');

ae.execute(aeToJSON)
.then(function(json) {
  // 处理 JSON 输出
})
.catch(function(e) {
  throw e;
});

1.2 在 After Effects 脚本工具中使用

你可以将 dist/index.js 的内容复制到 After Effects 的脚本编辑器中。具体步骤如下：

1. 打开 After Effects。
2. 选择 文件 -> 脚本 -> 打开脚本编辑器。
3. 将 dist/index.js 的内容粘贴到脚本编辑器中。

之后，你可以在脚本编辑器中使用以下代码：

JSON.stringify(aeToJSON(), null, '  ');

1.3 构建并使用自己的 JSX 脚本

由于 After Effects 目前使用的是 Ecma Script 3 引擎，你需要引入 Ecma Script 5 的 shim 和 JSON shim。你可以通过以下命令进行安装：

$ npm i ae-to-json es5-shim JSON2 --save

然后在 JavaScript 代码中引入这些 shim：

// 引入 es5 功能
require('es5-shim');

// 你可能希望将 JSON 设为全局变量
JSON = require('JSON2');

var aeToJSON = require('ae-to-json');

// 使用 aeToJSON 函数

最后，你可以使用 browserify 将 JavaScript 文件打包：

$ browserify index.js -o bundle.js

2. 项目使用说明

ae-to-json 模块的主要目的是将 After Effects 文件导出为 JSON 格式的对象。它标准化了 After Effects 到 JSON 的导出过程，并创建了一个平台，可以在其上构建渲染器。此外，它还提供了适当的单元测试，以捕获 After Effects 中的重大更改。

3. 项目 API 使用文档

3.1 aeToJSON 函数

aeToJSON 函数用于将 After Effects 文件导出为 JSON 格式的对象。你可以通过以下方式使用该函数：

var aeToJSON = require('ae-to-json');

// 使用 aeToJSON 函数
var jsonOutput = aeToJSON();

3.2 after-effects 模块

after-effects 模块允许你在 After Effects 中运行函数，并返回 Node.js 中的值。你可以通过以下方式使用该模块：

var ae = require('after-effects');

ae.execute(aeToJSON)
.then(function(json) {
  // 处理 JSON 输出
})
.catch(function(e) {
  throw e;
});

4. 项目安装方式

你可以通过以下命令安装 ae-to-json 模块：

$ npm i ae-to-json --save

如果你需要使用 after-effects 模块，可以同时安装：

$ npm i ae-to-json after-effects --save

安装完成后，你可以在 JavaScript 代码中引入并使用这些模块。

【免费下载链接】ae-to-json will export an After Effects project as a JSON object 项目地址: https://gitcode.com/gh_mirrors/ae/ae-to-json