helpers

The helpers folder sits alongside the app.yml file in your application folder. The helpers folder is for files that work together to add a specific piece of functionality to an application. The folder can contain stack files meant to be used for UI, libraries, frontscripts, or backscripts. It can also contain externals or extensions.

Update helpers section in app.yml

Whenever you add or remove a helper be sure to update the helpers section of app.yml. This enables the framework to properly load your helpers at startup.

# app.yml
...
helpers:
  1:
    filename: [relative path to folder containing helper]
    encrypt: Optional parameter that can override the `encrypt stacks` setting for this stack.
  2:
    folder: [relative path a folder with helper folders]
    encrypt: Optional parameter that can override the `encrypt stacks` setting for all stacks in the folder.
  ...
...

Helpers consist of a folder with a helper.yml file in it. The helper.yml file specifies what the other files in the folder should be used for. A helper can be made up of the following:

• stacks
• libraries
• backscripts
• frontscripts
• behaviors
• externals
• extensions

If no helper.yml file is found then the framework will try to load up each file in the folder as a stack.

If your helper includes an extension then you can also specify a resource folder for the extension. This is the folder where any resources that your widget loads will come from. For example, if you use image from resource file mResource and it is a relative reference then the LiveCode engine will look in the resource folder.

If no resource file is specified and a ./resources folder exists alongside your app.yml file then that folder will be used.