Getting started

You can use package for only one certain application (After Effects, Premiere Pro, Photoshop, ...), you should point the application in settings of the package.
If you need several packages, for ex. one for After Effects, another for Premiere Pro - you have to create two separate packages (due to it's impossible to combine templates for divers apps in one package).

Base structure

The base structure of package contains: the package itself (file format .ATOM) and additional folders with files.

Example of packages and files structure

  • Package File.atom - The file with settings and the package structure in JSON language (more on that see further). The name of the package can be of any kind of correspondent format (.ATOM).

  • Atom Preview Assets - A folder with preview files (see the detales here)

  • Atom [Software Name] - A folder with templates files / presets / other elements of corresponding app.

    note
    Inscription [Software Name] has to be changed to the name of the application:
    After Effects -> Atom After Effects,
    Premiere Pro -> Atom Premiere Pro and so on.

The folder with preview files and templates folder have to correspond to the hierarchy you point while creating the package structure.

Package creation

A file of the package represents a system of organized data storing on JSON language (JavaScript Object Notation).

You may need a text editor with syntax highlighting to make a code of the package more convenient in use.
Editors examples: Sublime, Notepad++, Visual Studio Code, or any other with the highlighting JSON syntax.

DefaultHighlighted JSON (Visual Code)
Example of code without syntaxExample of code with syntax
note

There's no need to be a programmer to be able to work with the package code, thus the code is just a tool to structure adn store the data, it's not a fullfledged programming language.

Moreover, you can operate the structure and settings of the package not using the code, just using a tree panel. More details learn in the chapter code checkout.

File creation (.ATOM)

Create a file in a format .ATOM (create a text file first, then change its format to .atom) in any directory, or use a ready-made package template (you can test it right from inside the extansion).

The package file stores the data:

  1. settings - package settings (details are here).
  2. structure - package structure (details are here).
Structure example
{
"settings": {
},
"structure": {
}
}
warning

The syntax JSON abide strict hierarchy that you have to keep also.

For ex.: after a group settings we have a comma, but after a group structure there is no comma for there is no elements further. However, there has to be a comma if there are other groups after the group structure (and vice versa).

The features abowe are relevant throughout the code: if there are elements inside the group - list them with comma (if one element deleted , delete the comma).

note

More details: The option values have olways be written with double quotes " ", except of spetial parametrs - true / false and numerical values where needed.

You can copy the code below and paste it into your .ATOM file, or, as we've already discussed, use a ready-made package that already includes all the files and a ready-made code.

The entire code example
{
"settings": {
"main": {
"name" : "Your Package Name",
"version" : "1.0",
"required_app_version": "3.0",
"software_id" : "AE",
"software_version" : "CC19",
"engine_pack" : "_COMPOSER",
"inside_security" : "",
"required_purchase_code" : false,
"cc_author_username" : "Author Name"
},
"inside_option_sets": {
"auto_fps_composition": "NONE",
"duplicate_origin_setting": "ALL_COMPS"
},
"stylization": {
"header_color_hex": "#021523"
}
},
"structure": {
"Grand Folder": {
"Folder with Audio": {
"InsideFX": {
"preview": {
"SD1": {"enabled": true, "name": "sd", "options": false},
"TOT": {"enabled": true, "name": "ToT", "options": false}
},
"is_audio": true,
"preview_name_instead_id": true
},
"MisterPack": {
"preview": {
"AUDIOX_11": {"enabled": true, "name": "AUDIOX_1", "options": false},
"AUDIOX_22": {"enabled": true, "name": "AUDIOX_2", "options": false}
},
"is_audio": true,
"preview_name_instead_id": true
}
}
}
}
}

Here are all the main package data are described (settings and structure; surely you'll have to have our own data). Now all you need to do to finish the package is to mate all this with a file system.

More on how to mate the package structure with preview files and your template see in a chapter package structure.

After the work is done you can checkout the package (more on the chekout here).

Ready-made examples

We recommend you to download a full package example to make its operating clear to you (it's fully functional and ready for use, includes all the neсessary files).
You can rely on it every time you have errors in running your package, or you'd like to learn more with the help of a ready-made examle.

Press here to see the chapter with additional information and download the package example.