AEUX 项目使用教程
1. 项目目录结构及介绍
AEUX 项目的目录结构如下:
AEUX/
├── Ae/
│ └── AEUX/
├── Documentation/
├── Figma/
├── Sketch/
│ └── AEUX/
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── package-lock.json
└── package.json
目录结构介绍
- Ae/: 包含与 After Effects 相关的文件和脚本。
- Documentation/: 包含项目的文档文件。
- Figma/: 包含与 Figma 相关的文件和脚本。
- Sketch/: 包含与 Sketch 相关的文件和脚本。
- .gitignore: 指定 Git 应该忽略的文件和目录。
- CONTRIBUTING.md: 贡献指南,指导开发者如何为项目做出贡献。
- LICENSE.md: 项目的许可证文件,本项目使用 Apache-2.0 许可证。
- README.md: 项目的介绍文件,包含项目的基本信息和使用说明。
- package-lock.json: 锁定项目依赖的版本。
- package.json: 项目的配置文件,包含项目的依赖和脚本。
2. 项目启动文件介绍
AEUX 项目的启动文件主要集中在 Ae/AEUX/
和 Sketch/AEUX/
目录中。这些文件负责将 Sketch 或 Figma 中的设计转换为 After Effects 中的可编辑图层。
启动文件介绍
- Ae/AEUX/: 包含 After Effects 的脚本文件,用于处理从 Sketch 或 Figma 导入的图层。
- Sketch/AEUX/: 包含 Sketch 插件文件,用于导出设计文件并准备导入到 After Effects。
3. 项目的配置文件介绍
AEUX 项目的主要配置文件是 package.json
,它包含了项目的依赖、脚本和其他配置信息。
package.json
配置文件介绍
{
"name": "aeux",
"version": "0.8.2",
"description": "Editable After Effects layers from Sketch artboards",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "git+https://github.com/google/AEUX.git"
},
"author": "Adam Plouff",
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/google/AEUX/issues"
},
"homepage": "https://github.com/google/AEUX#readme",
"dependencies": {
"axios": "^0.21.1",
"express": "^4.17.1"
}
}
配置文件说明
- name: 项目的名称,这里是
aeux
。 - version: 项目的版本号,当前版本为
0.8.2
。 - description: 项目的描述,说明项目的主要功能。
- main: 项目的入口文件,通常是
index.js
。 - scripts: 定义了一些脚本命令,例如
test
脚本。 - repository: 项目的 Git 仓库地址。
- author: 项目的作者,这里是
Adam Plouff
。 - license: 项目的许可证,使用 Apache-2.0 许可证。
- bugs: 项目的问题跟踪地址。
- homepage: 项目的主页地址。
- dependencies: 项目的依赖包,例如
axios
和express
。
通过以上配置文件和目录结构,开发者可以快速了解 AEUX 项目的组织方式和基本使用方法。