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.

ยฉ2025 Boris FX, Inc.ย โ€”ย UNOFFICIALย โ€”ย Converted from original PDF.


Please select your language

The website is currently localized into the following languages