Devel Manual:Writing a custom User Script

From KLFWiki

...... WRITE ME ..............

In short:

• look at examples in src/plugins/userscripts
• a normal (e.g. python) script
• data may be passed as files or stdin/stdout; arguments and metainformation usually as environment variables
• script will be called once initially as the-user-script.py --scriptinfo <KLF_VERSION>, and should return useful metainformation about the script (see examples)
• a userscript, currently, may be either (category):
  • a script describing a backend workflow (e.g. klffeynmf)
  • a script generating a custom export format (e.g. svg-dvisvgm)
• scripts may provide Qt designer UI forms for their config and/or additional input arguments. Widgets named INPUT_xyz will have their value passed as arguments in environment variables to the user scripts (see examples, e.g. custominput.py)