Skip to content

Folders and files

Folders

When launched, the application searches for plugins in the following folder:

A.V.A.T.A.R
    ├── resouces
        ├── app
            ├── core
                ├── plugins
Folder
 Auto
creation(1)
Mandatory
 Description
assets yes yes Includes:
- The mandatory information file ìnfos.md or infos_<application language>.md in Markdown format appearing in the plugin's Ìnformation tab in Plugin Studio. This file must be modified to add the information required to use the plugin.

- A non-mandatory images folder for plugin images. A creation by Plugin Studio stores the image file <myPlugin>.png. If the images folder does not exist, a default image is displayed.
documentation yes no Includes:
- The documentation.ini documentation configuration file.
- Place any html documentation you can create in this folder.
locales yes no If you're locating plugin messages, create your <lang>.pak files to this folder.
Creation by Plugin studio automatically deposits a <lang>.pak file for the current application language.
node_modules no no Folder automatically created if you add npm modules to your plugin.
... N/A no Any other folder useful to your plugin.

(1) Folder created automatically if you use Plugin Studio to create the plugin.

Folder
Mandatory
 Description
assets yes Includes:
- The mandatory information file ìnfos.md or infos_<application language>.md in Markdown format appearing in the plugin's Ìnformation tab in Plugin Studio. This file must be modified to add the information required to use the plugin.

- A non-mandatory images folder for plugin images. A creation by Plugin studio stores the image file <myPlugin>.png. If the images folder does not exist, a default image is displayed.
locales no If you're locating plugin messages, create your <lang>.pak files to this folder.
node_modules no Folder automatically created if you add npm modules to your plugin.
... no Any other folder useful to your plugin.
Note

If you decide to create the folders yourself (whether mandatory or not), use the same writing convention.

Files

Type
File
 Auto
creation(1)		 Mandatory Description
Intention intent.<plugin>.js yes no The intention allows to check whether the sentence you are speaking validates a voice rule defined for the plugin.
intents.<name>.js no no It is possible to have several intention files. For example, if you want to break down the check into several files.

Let's take the example of a TV plugin that has 2 intention files, one for TV channel rules and another for controls (volume, on/off, etc.), , the intention files will be:
- intents.tvChannels.js
- intents.tvCommands.js
Action action.<plugin>.js yes no If the sentence is verified by the intention file and validates a voice rule, then the associated action file is called.
The action file is a pre-processor that gathers information sent by the intention file and calls the plugin's script file.
actions.<name>.js no no If you have chosen to have multiple intention files, then there must be the same number of actions files.

Let's take the same example of a TV plugin (see above) that has 2 intention files, one for TV channel rules and another for controls (volume, on/off, etc.), the action files will be:
- actions.tvChannels.js
- actions.tvCommands.js
Script <plugin>.js yes yes Main script file in which the plugin is developed.
Properties <plugin>.prop yes yes The plugin properties file in json format.
Package package.json yes no npm package control file.
Language locales/<lang>.pak yes no Language localization file.
Information assets/infos.md
or
infos_<application language>.md		 yes yes Information file in Markdown format to be displayed on the plugin information page in Plugin Studio.

application language: Short code of the application language
If this file exists, it is used otherwise info.md is used.
Image assets/<plugin>.png yes no Plugin image file in .png format.
... ... N/A no Any other file useful to your plugin.

(1) File created automatically if you use Plugin Studio to create the plugin.

Type
File
 Mandatory Description
Script <plugin>.js yes Main script file in which the plugin is developed
Properties <plugin>.prop yes The plugin properties file in json format
Package package.json no npm package control file
Language locales/<lang>.pak no Language localization file
Information assets/infos.md
or
infos_<application language>.md		 yes Information file in Markdown format to be displayed on the plugin information page in Plugin Studio.

application language: Short code of the application language
If this file exists, it is used otherwise info.md is used
Image assets/<plugin>.png no Plugin image file in .png format
... ... no Any other file useful to your plugin



Create a pluginNatural Language Processing