1. Controlling MXW through Python: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 16: | Line 16: | ||
|+ Caption text | |+ Caption text | ||
|- | |- | ||
! | ! Tag !! Use !! Values/Example | ||
|- | |- | ||
| | | plugin_version || Plugin Version || 1 | ||
|- | |- | ||
| | | plugin_script_language || Plugin Script Language || Python | ||
|- | |- | ||
| Example || Example || Example | | Example || Example || Example | ||
|} | |} | ||
<syntaxhighlight lang=" | <syntaxhighlight lang="ini" line> | ||
[mxw_plugin] ; must be here | [mxw_plugin] ; must be here | ||
plugin_version = 1 ; must be V1 (as of 2023) | plugin_version = 1 ; must be V1 (as of 2023) | ||
Revision as of 18:07, 3 December 2023
Python is used in MXW trough a plugin interface. Specified program paths are searched for plugins which are registered, and then loaded through the user interface.
As of version 7.2., plugins are available in the playlist. There are two paths searched during program startup, the program folder and the user folder:
- (Program folder)/plugins/playlist/python/
- ~.StageDesigner/plugins/playlist/python/ (Unix)
- ~.StageDesigner/plugins/playlist/python/ (Windows)
Each plugin resides in a folder. Inside this folder, two files have to be present,
- mxw_plugin.ini
- mxw_main.py
The file mxw_plugin.ini defines the registration of the plugin. The following fields are valid:
| Tag | Use | Values/Example |
|---|---|---|
| plugin_version | Plugin Version | 1 |
| plugin_script_language | Plugin Script Language | Python |
| Example | Example | Example |
[mxw_plugin] ; must be here
plugin_version = 1 ; must be V1 (as of 2023)
plugin_script_language = Python ; must be Python (as of 2023)
plugin_menu_parent = AI
plugin_menu_name = NeuronalNet(Dlib) Face Detect Plugin
plugin_grid_name = Face Detect Plugin
plugin_grid_bg_color = 0.950000 0.050000 0.450000 1.000000 ; set plugin color.
plugin_tooltip = This plugin triggers the playlist when it finds a Face using a neuronal net (Dlib)