Script-Folder-Relative Include Files

< Previous | Contents | Manuals Home | Boris FX | Next >

‌Script-Folder-Relative Include Files

Script-folder-relative names start with “$/” and are evaluated relative to one of the script folders, ie “$/foo.szl” means a file directly in the folder, while “$/Lens/lensdefs.szl” means look for lensdefs.szl in the script folder’s Lens subfolder.

Tip: We recommend using Script-Folder-Relative include file paths in most cases, instead of relative or absolute paths!

SynthEyes looks for the file first in the “Script/User script folder”. If the file isn’t found in the user area, then SynthEyes looks in any user-specified script directories, in reverse order to match “ PATH Environment Variable and Multiple Script Directories.” If the file still isn’t found, it looks in the preference’s scripts folder, if present, or in the “Script/System script folder” if not.

Script-folder-relative names are good for files like lensdefs that are independent of the file including it. Using “$/” specifications, a script containing an INCLUDE continues to work if it is moved to a subfolder or from the system area to the user area, without requiring the path to be adjusted or the target file to be brought along.

< Previous | Contents | Manuals Home | Boris FX | Next >