Essentials

Group Options

Group settings allow you to override package-specific settings for templates and all their elements, as well as have custom settings.

You can add parameters separated by commas after the preview block and only if such a block exists in the current group/template - the final part of the structure.

Example

"Instagram Stories": {
    "preview": {
        "INST_2":   {"enabled": true, "name": "Instagram Stories 02", "options": false},
        "INST_3":   {"enabled": true, "name": "Instagram Stories 03", "options": false}
    },
    "preview_name_instead_id": true,
    "custom_preview_res_thumbnail": "VERTICAL"
}

preview_name_instead_id

boolean

Allows you to use the element name for file previews instead of its ID. See details here.

custom_preview_res_thumbnail

string

Changes the visual display of the preview - the standard value DEFAULT - does not need to be specified. See details here.

There are both global parameters and individual ones related to a specific application.

Common Options

custom_folder

This option allows using another name for a folder with preview files of the template (inside the main folder Atom Preview Assets).

"custom_folder": "Special"

Example

"Basic": {
    "preview": {
        "HTKB_1": {"enabled": true,"name": "Basic 1","options": false}
    },
    "custom_folder": "Special"
}

├── Package Folder/
│   ├── ...
│   ├── Atom Preview Assets/
│   │   └── Basic
│   │       └── HTKB_1.png
│   │       └── HTKB_1.gif
│   │       └── ...

├── Package Folder/
│   ├── ...
│   ├── Atom Preview Assets/
│   │   └── Special
│   │       └── HTKB_1.png
│   │       └── HTKB_1.gif
│   │       └── ...

Please note that we have changed the folder content hierarchy for preview files only; the template file hierarchy remains the same.

preview_name_instead_id

This option allows you to use the element name instead of its ID (identity value) for preview files (which are located in the Atom Preview Assets folder).

"preview_name_instead_id": true

Example

"Basic": {
    "preview": {
        "HTKB_1": {"enabled": true,"name": "Element Name 1","options": false}
    },
    "preview_name_instead_id": true
}

├── Package Folder/
│   ├── ...
│   ├── Atom Preview Assets/
│   │   └── Basic
│   │       └── HTKB_1.png
│   │       └── HTKB_1.gif
│   │       └── ...

├── Package Folder/
│   ├── ...
│   ├── Atom Preview Assets/
│   │   └── Basic
│   │       └── Element Name 1.png
│   │       └── Element Name 1.gif
│   │       └── ...

is_audio

Specifies that all files in the folder are audio files in .WAV format - and should play when you hover over them.

Audio files have to be placed in the preview folder Atom Preview Assets, with classic hierarchy (as for the template), and be disposed in a folder with files of elements (instead of preview images).

"is_audio": true

Example

"My Sound FX": {
    "preview": {
        "SOUND_1_NAME_AS_ID": {"enabled": true,"name": "Sound Fx 1","options": false}
    },
    "is_audio": true
}

File Structure

├── Package Folder/
│   ├── ...
│   ├── Atom Preview Assets/
│   │   └── My Sound FX 
│   │       └── SOUND_1_NAME_AS_ID.wav
│   │       └── ...

Please note that in the example the file name is used from its ID, you can override this and use the element names using the preview_name_instead_id parameter.

is_footage

Indicates that all files in the folder are assets (images/videos footages) in the specified formats.

JPG – group with images .jpg
PNG – group with images .png
MOV – group with videos .mov
MP4 – group with videos .mp4

"is_footage": "JPG"

Example

"My Footages": {
    "preview": {
        "Image_1": {"enabled": true,"name": "My Image 1","options": false}
    },
    "is_footage": "JPG"
}

File Structure

├── Package Folder/
│   ├── ...
│   ├── Atom Preview Assets/
│   │   └── My Footages
│   │       └── Image_1.jpg
│   │       └── ...

If a group of elements requires an application version higher than the one specified in the package, you can specify this version, and then if the application is lower than the specified version, the elements will not be applied and the user will see a message about this.

In the example below, CC25 or higher is required for the elements to be usable.

"group_req_soft_version": "СС24"

Example

"Basic": {
    "preview": {
        "HTKB_1": {"enabled": true,"name": "Element Name 1","options": false}
    },
    "group_req_soft_version": "СС24"
}

disable_webm_preview

Disable preview files .WEBM/.MP4 from the package settings for the specified group and use standard GIF preview elements.

"disable_webm_preview": true

Example

"Basic": {
    "preview": {
        "HTKB_1": {"enabled": true,"name": "Element Name 1","options": false}
    },
    "disable_webm_preview": true
}

change_engine

This option allows to reassign the global engine type for a certain group. You can use it if you know the operation of other engines, or created your own engine for the package.

"change_engine": "_COMPOSER"

Example

"Basic": {
    "preview": {
        "HTKB_1": {"enabled": true,"name": "Element Name 1","options": false}
    },
    "change_engine": "_COMPOSER"
}

custom_preview_res_thumbnail

The option allows to change a display appearance (aspect ratio) for a certaim group of elements. In default, all the elements have aspect ratio 16:9. You can find out about the available options here.

"custom_preview_res_thumbnail": "VERTICAL"

Example

"Basic": {
    "preview": {
        "HTKB_1": {"enabled": true,"name": "Element Name 1","options": false}
    },
    "custom_preview_res_thumbnail": "VERTICAL"
}

change_auto_size_footage

Overrides the auto_size_footage parameter with its own for a specific group of elements.

See Package Options for this parameter for available values.

"change_auto_size_footage": "ALL_ITEMS"

Example

"Basic": {
    "preview": {
        "HTKB_1": {"enabled": true,"name": "Element Name 1","options": false}
    },
    "change_auto_size_footage": "ALL_ITEMS"
}

After Effects only

aep_file_name

This option allows using another name for template file .AEP (inside the general folder with templates: Atom After Effects).

By default the element name should be the same as the AEP file name, this option allows you to override that.

"aep_file_name": "Not Basic"

Example

"Basic": {
    "preview": {
        "HTKB_1": {"enabled": true,"name": "Composition Name 1","options": false}
    },
    "aep_file_name": "Not Basic"
}

├── Package Folder/
│   ├── ...
│   ├── Atom After Effects/
│   │   └── Basic.aep

├── Package Folder/
│   ├── ...
│   ├── Atom After Effects/
│   │   └── Not Basic.aep

label_color_num

Allows to assign the color of the layer (composition/any layer) for the element applied on the timeline. The color will be assigned to all of the elements of the group, where the option assigned.

Use numeric from 0 to 16 (color #2 - yellow is in default).

"label_color_num": 9

Example

"Basic": {
    "preview": {
        "HTKB_1": {"enabled": true,"name": "Composition Name 1","options": false}
    },
    "label_color_num": 9
}

├── Package Folder/
│   ├── ...
│   ├── Atom After Effects/
│   │   └── Basic.aep

├── Package Folder/
│   ├── ...
│   ├── Atom After Effects/
│   │   └── Not Basic.aep

is_presets

Specifies that the entire group are .FFX preset files and will apply the elements as presets.

"is_presets": true

Example

"My Presets Folder": {
    "preview": {
        "PRST_1": {"enabled": true,"name": "My Preset Name","options": false}
    },
    "is_presets": true
}

File Structure

├── Package Folder/
│   ├── ...
│   ├── Atom After Effects/
│   │   └── My Presets Folder/
│   │──    └── My Preset Name.ffx

change_auto_size_composition

Overrides the auto_size_composition parameter with its own for a specific group of elements.

See Package Options for this parameter for available values.

"change_auto_size_composition": "ALL_COMPS"

Example

"Basic": {
    "preview": {
        "HTKB_1": {"enabled": true,"name": "Element Name 1","options": false}
    },
    "change_auto_size_composition": "ALL_COMPS"
}

change_duplicate_origin_setting

Overrides the duplicate_origin_setting parameter with its own for a specific group of elements.

See Package Options for this parameter for available values.

"change_duplicate_origin_setting": "ONLY_MAIN"

Example

"Basic": {
    "preview": {
        "HTKB_1": {"enabled": true,"name": "Element Name 1","options": false}
    },
    "change_duplicate_origin_setting": "ONLY_MAIN"
}

change_use_start_timeline_pointer

Overrides the use_start_timeline_pointer parameter with its own for a specific group of elements.

See Package Options for this parameter for available values.

"change_use_start_timeline_pointer": "START_POINT"

Example

"Basic": {
    "preview": {
        "HTKB_1": {"enabled": true,"name": "Element Name 1","options": false}
    },
    "change_use_start_timeline_pointer": "START_POINT"
}

change_layer_index_position

Overrides the layer_index_position parameter with its own for a specific group of elements.

See Package Options for this parameter for available values.

"change_layer_index_position": "MOVE_BELOW"

Example

"Basic": {
    "preview": {
        "HTKB_1": {"enabled": true,"name": "Element Name 1","options": false}
    },
    "change_layer_index_position": "MOVE_BELOW"
}

Premiere Pro only

custom_assets_folder

Using an additional folder up to auxiliary sequence files, inside the main folder _Assets.

Without this option, the main folder for searching files will be _Assets.

"custom_assets_folder": "Insta Assets"

Example

"Basic": {
    "preview": {
        "HTKB_1": {"enabled": true,"name": "Element Name 1","options": false}
    },
    "custom_assets_folder": "Insta Assets"
}

├── Package Folder/
│   ├── ...
│   ├── Atom Preview Assets/
│   │   └── _Assets/

├── Package Folder/
│   ├── ...
│   ├── Atom Preview Assets/
│   │   └── Insta Assets/

custom_files_folder

Use a different folder for your Premiere Pro project.

"custom_files_folder": "Custom Folder Assets"

Example

"Basic": {
    "preview": {
        "HTKB_1": {"enabled": true,"name": "Element Name 1","options": false}
    },
    "custom_files_folder": "Custom Folder Assets"
}

├── Package Folder/
│   ├── ...
│   ├── Atom Premiere Pro/
│   │   └── ...

├── Package Folder/
│   ├── ...
│   ├── Atom Premiere Pro/
│   │   └── _Files/Custom Folder Assets

group_resize_properties

Allows you to specify which parameters from MOGRT effects to use for auto-resize width and height.

Specify the name of your effect for each argument.

For example, if your MOGRT file contains effects (controls) for auto-resizing with names other than WIDTH/HEIGHT, you can specify them.

"group_resize_properties": {"Width": "My Width", "Height": "My Height"}

Example

"Basic": {
    "preview": {
        "HTKB_1": {"enabled": true,"name": "Element Name 1","options": false}
    },
    "group_resize_properties": {"Width": "My Width", "Height": "My Height"}
}

mogrt_transition_system

A special system for using MOGRT as an object transition system. It's created separately in After Effects.

"mogrt_transition_system": true

Example

"Basic": {
    "preview": {
        "HTKB_1": {"enabled": true,"name": "Element Name 1","options": false}
    },
    "mogrt_transition_system": true
}

custom_source_type

Overrides the source_type parameter with its own for a specific group of elements.

See Package Options for this parameter for available values.

"custom_source_type": "MOGRT"

Example

"Basic": {
    "preview": {
        "HTKB_1": {"enabled": true,"name": "Element Name 1","options": false}
    },
    "custom_source_type": "MOGRT"
}

change_auto_size_footage

Overrides the auto_size_sequence parameter with its own for a specific group of elements.

See Package Options for this parameter for available values.

"change_auto_size_sequence": "MOGRT"

Example

"Basic": {
    "preview": {
        "HTKB_1": {"enabled": true,"name": "Element Name 1","options": false}
    },
    "change_auto_size_sequence": "MOGRT"
}

Package Options

Custom package options allow you to apply specific parameters to the extension; these settings are linked to and work only with a specific application (After Effects, Premiere Pro, etc.) or globally.

Element Options

Parameters for individual elements.