build-lives-rfx-plugin(1)

📦 version 3.0.2, in ubuntu jammy

💖 build-lives-rfx-plugin(1) 💖

okay bestie, sit down, we're building rendered effects today and honestly? iconic. this is a page from the General Commands Manual, and it's all about build-lives-rfx-plugin — the little script that 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 💅

so. this is a perl script, and LiVES uses it to compile an RFX (that's rendered effect, keep up 💖) plugin for LiVES. it's not really the main character that gets called directly — nope, it's generally called from build-lives-rfx-plugin-multi, for a script whose language code represents LiVES-perl. iykyk.

a couple things you gotta know about the arguments:

  • script_name has to be the full (absolute) path to the plugin script. no shortcuts, no relative-path shenanigans, we're being precise here 💅
  • plugin_dir is optional and lets you pick the output directory where the compiled plugin should get generated.
  • if plugin_dir isn't defined, then /tmp is assumed. (yes, /tmp. it's giving "temporary but make it fashion".)

then there's the second variant, the one with -get. that one prints out a script section from a plugin script to stdout. it's generally only used internally by LiVES — so like, not your business, but now you know 🫶.

🍓 Return values 🍓

the script returns these values, and bestie, each one is a whole mood:

  • 0 — success ✨ (we love to see it)
  • 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 <define> section was missing from the plugin script 💀

🌈 SEE ALSO 🌈

👑 AUTHOR 👑

Gabriel Finch a.k.a Salsaman (salsaman@xs4all.nl) 💜

and that's the whole page, no cap. this lil manual is from May 9 2010, and it's the build-lives-rfx-plugin(1) page — go forth and render those effects, you absolute icon 🧚💖

📦 where this page comes from