DuAEF.Ramses

Ramses
Author:
  • Nicolas Dufresneand contributors
License:
  • GPL-3.0
    DuAEF is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    DuAEF is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with DuAEF. If not, see http://www.gnu.org/licenses/.

Members

static, readonly ArchiveModes :int

Enum for archiving modes.
Properties:
Name Type Description
ONE_FOR_ALL int
ONE_PER_FOLDER int
ONE_PER_AEP int

static versionFolderName

Name of the folder for version history

static wipName

Suffix for wip files

Methods

static archiveFolder(inputFolder, outputFolder, recursiveopt, zipopt, reduceopt, archiveModeopt)

Reduces and collects the files for all projects in a given folder. Keeps only the comps at the root of the project.
Parameters:
Name Type Attributes Default Description
inputFolder Folder The folder to scan for projects
outputFolder Folder The folder where to save the archives
recursive boolean <optional>
true Scan for subfolders too. Folders named '_versions' and 'old' will be ignored, as long as auto-save folders from After Effects
zip boolean <optional>
false Set to true to automatically zip the archives.
reduce boolean <optional>
true Will reduce the project before collecting files, using all comps found at first level in the project (not in subfolders)
archiveMode DuAEF.Ramses.ArchiveModes <optional>
DuAEF.Ramses.ArchiveModes.ONE_PER_FOLDER Creates only one archive for each subfolder. This is a nice way to not duplicate dependencies, as they will be shared between projects from the same folder.

static archiveProject(destinationopt, reduceopt, selectedCompsopt, zipopt, projectFileopt, createProjectFolderopt) → {File|Folder}

Collect the files from the current project. Gets both the WIP and the publish versions.
Parameters:
Name Type Attributes Default Description
destination Folder <optional>
The folder where to save the files. The project files will be collected in a subfolder called "project name.aep.archive" or "project name.aep.zip". If not provided, will use the current folder.
reduce boolean <optional>
true Will reduce the project before collecting files, using all comps found at first level in the project (not in subfolders)
selectedComps boolean <optional>
false Use selected comps to reduce the project, if any.
zip boolean <optional>
false Set to true to automatically zip the archive.
projectFile File <optional>
app.project.file The project to archive. The currently opened project if omitted.
createProjectFolder boolean <optional>
true Wether to create a folder for this project or use the destination as is.
Returns:
File | Folder - Thwe zip file or the folder containing the collected files.

static getCurrentProjectVersion() → {int}

Gets the current version number of the project
Returns:
int

static getProjectName() → {string}

Gets the name of the project, without the wip part
Returns:
string

static getVersionFolder() → {Folder}

Gets the folder used to store version history
Returns:
Folder

static saveProject(incrementopt, publishopt) → {File}

Saves the current project, and copies a backup file.
Parameters:
Name Type Attributes Default Description
increment boolean <optional>
false Set to true to increment the current version.
publish boolean <optional>
false Set to true to publish the current project (remove the WIP part)
Returns:
File - The backup file.