scripts/README

   1 Ardour Lua Scripts
   2 ==================
   3
   4 https://manual.ardour.org/lua-scripting/
   5
   6 For upstream script addition, please file a pull-request at
   7 https://github.com/Ardour/ardour/tree/master/scripts
   8
   9 Script Naming conventions:
  10
  11 ^_
  12  A script filename with a leading underscore indicates an example script.
  13  These scripts are only available from ardour's git repository and not
  14  installed nor included with binary bundles.
  15
  16 ^__
  17  Scripts with a filename starting with two underscores are excluded from
  18  unit-tests.  This is currently the case for convolver, fluidsynth and
  19  plugin-modulation.
  20  They depend on external files (soundfont, impulse-response) or a specific
  21  session-setup (plugin-modulation needs an automatable plugin).
  22
  23 ^s_
  24  A filename beginning with "s_" indicates a code snippet.
  25  These scripts can only be used in the interactive interpreter
  26  (Window > Scripting). They may be useful by themselves or handy for copy/edit
  27  to create EditorActions.
  28  The filename prefix is only for convenience, "type" = "Snippet" is used when
  29  scripts are listed at runtime.