--- name: "build-lives-rfx-plugin" section: "1" platform: "linux" package: "lives-plugins" version: "3.0.2-1.1" release: "Debian 11 (Bullseye)" platforms: ["linux"] url: "https://new.carta.tech/build-lives-rfx-plugin" --- # build-lives-rfx-plugin(1) builds rendered effects for LiVES ## NAME build-lives-rfx-plugin - builds rendered effects for LiVES ## SYNOPSIS **build-lives-rfx-plugin** script\_name \[plugin\_dir\] -get section file ## DESCRIPTION This perl script is used by LiVES to compile an RFX (rendered effect) plugin for LiVES. It is generally called from build-lives-rfx-plugin-multi for a script which has a language code representing LiVES-perl. The script\_name must be the full (absolute) path to the plugin script, and plugin\_dir can be used to specify the output directory where the compiled plugin should be generated. If plugin\_dir is not defined then /tmp is assumed. The second variant with -get is used to print out a script section from a plugin script to stdout. It is generally only used internally by LiVES. Return values The script returns the following values 0 - success 1 - the value of a trigger was greater than the number of parameters 2 - a value could not be read from the script file 3 - the language code of the plugin script was not equivalent to LiVES-perl 4 - the API version level of the plugin script was invalid 5 - the \ section was missing from the plugin script ## SEE ALSO [build-lives-rfx-plugin-multi(1)](/build-lives-rfx-plugin-multi/1.md), [lives(1)](/lives/1.md) ## AUTHOR Gabriel Finch a.k.a Salsaman (salsaman@xs4all.nl)