Python plugin reference - Revision history

Admin: Add Category:Python at page end (bot)

2026-08-08T15:33:32Z

← Older revision		Revision as of 17:33, 8 August 2026
Line 532:		Line 532:
	* '''Media shows black''' — <code>onRenderFrame</code> returned a buffer of the wrong size (must be <code>widthheight4</code> bytes), or a GL plugin created its own context instead of attaching to MXWendler's (see the OpenGL rules).		* '''Media shows black''' — <code>onRenderFrame</code> returned a buffer of the wrong size (must be <code>widthheight4</code> bytes), or a GL plugin created its own context instead of attaching to MXWendler's (see the OpenGL rules).
	* '''Missing packages''' — install them with mxw-pip (see [[#Installing own modules with mxw-pip\|Installing own modules with mxw-pip]]) and make sure '''Prepend user site-path''' is enabled: the embedded interpreter does not see a system-wide Python installation's packages.		* '''Missing packages''' — install them with mxw-pip (see [[#Installing own modules with mxw-pip\|Installing own modules with mxw-pip]]) and make sure '''Prepend user site-path''' is enabled: the embedded interpreter does not see a system-wide Python installation's packages.
			[[Category:Python]]
	[[Category:Reference]]		[[Category:Reference]]

Admin: Update links after removing '3.' prefix from reference titles (bot)

2026-08-08T15:28:30Z

Update links after removing '3.' prefix from reference titles (bot)

Admin: Admin moved page 3. Python plugin reference to Python plugin reference: Remove nonsensical '3.' numbering prefix from reference titles

2026-08-08T15:27:40Z

Admin moved page 3. Python plugin reference to Python plugin reference: Remove nonsensical '3.' numbering prefix from reference titles

← Older revision	Revision as of 17:27, 8 August 2026
(No difference)

Admin: Add to Category:Reference (bot)

2026-08-08T14:45:09Z

Add to Category:Reference (bot)

← Older revision		Revision as of 16:45, 8 August 2026
Line 532:		Line 532:
	* '''Media shows black''' — <code>onRenderFrame</code> returned a buffer of the wrong size (must be <code>widthheight4</code> bytes), or a GL plugin created its own context instead of attaching to MXWendler's (see the OpenGL rules).		* '''Media shows black''' — <code>onRenderFrame</code> returned a buffer of the wrong size (must be <code>widthheight4</code> bytes), or a GL plugin created its own context instead of attaching to MXWendler's (see the OpenGL rules).
	* '''Missing packages''' — install them with mxw-pip (see [[#Installing own modules with mxw-pip\|Installing own modules with mxw-pip]]) and make sure '''Prepend user site-path''' is enabled: the embedded interpreter does not see a system-wide Python installation's packages.		* '''Missing packages''' — install them with mxw-pip (see [[#Installing own modules with mxw-pip\|Installing own modules with mxw-pip]]) and make sure '''Prepend user site-path''' is enabled: the embedded interpreter does not see a system-wide Python installation's packages.
			[[Category:Reference]]

Admin: unify python docs: fix cross-links to command/imgui reference pages

2026-08-08T12:17:21Z

unify python docs: fix cross-links to command/imgui reference pages

Admin: Add plugin_playlist_playbackmode_default manifest key; sync trigger-connection keys, media param hooks and plugin-repo links from repo doc

2026-07-13T21:11:53Z

Add plugin_playlist_playbackmode_default manifest key; sync trigger-connection keys, media param hooks and plugin-repo links from repo doc

← Older revision		Revision as of 23:11, 13 July 2026
Line 78:		Line 78:
	\|-		\|-
	\| <code>plugin_media_create_uri</code> \|\| The URI used when the user creates this media from the menu / Create button.		\| <code>plugin_media_create_uri</code> \|\| The URI used when the user creates this media from the menu / Create button.
			\|-
			\| <code>plugin_playlist_playbackmode_default</code> \|\| Optional. The clip playback mode a freshly added clip of this media starts in: <code>stop</code>, <code>loop</code>, <code>oneshot</code>, <code>bounce</code>, <code>jitter</code> or <code>random</code>. Omitted or unknown defaults to <code>loop</code>. Only seeds the initial mode - a project reload restores the clip's own saved mode.
	\|}		\|}

Line 86:		Line 88:
	\|-		\|-
	\| <code>plugin_grid_bg_color</code> \|\| Item background color as <code>r g b a</code> floats, e.g. <code>0.05 0.05 0.45 1.0</code>		\| <code>plugin_grid_bg_color</code> \|\| Item background color as <code>r g b a</code> floats, e.g. <code>0.05 0.05 0.45 1.0</code>
			\|-
			\| <code>plugin_accepts_trigger</code> \|\| <code>true</code>/<code>false</code> (default <code>false</code>). When <code>true</code>, dragging a TRIGGER item onto this item's grid cell connects it (the drag shows a green "connect" outline) instead of moving/swapping cells, and the plugin can read the connection with <code>mxw.pending_trigger_drop(item_id)</code>. Set it for a timeline; see [[#Connecting to a TRIGGER item]].
			\|-
			\| <code>plugin_cell_scrub</code> \|\| <code>true</code>/<code>false</code> (default <code>false</code>). When <code>true</code>, ALT + left-drag across this item's grid cell scrubs instead of moving the item: the host draws a playhead line and stashes the 0..1 fraction of the cell width each frame, readable with <code>mxw.pending_cell_scrub(item_id)</code>. Set it for a timeline; see [[#Connecting to a TRIGGER item]].
	\|}		\|}

Line 173:		Line 179:
	\|-		\|-
	\| <code>onDisplayName()</code> \|\| returns string \|\| Optional live display name (e.g. the web plugin reports the current page URL).		\| <code>onDisplayName()</code> \|\| returns string \|\| Optional live display name (e.g. the web plugin reports the current page URL).
			\|-
			\| <code>onGetParams()</code> \|\| returns a list of dicts \|\| Declare addressable parameters, called once per instance and cached: <code>{"name": str, "type": "float"\|"string", "min": float, "max": float, "default": float\|str}</code> (<code>min</code>/<code>max</code> ignored for <code>"string"</code>; <code>type</code> defaults to <code>"float"</code>).
			\|-
			\| <code>onParamChanged(index, value)</code> \|\| — \|\| A parameter was set via OSC, Python or JS at <code>.../clip/media/1/param/<index+1></code> (0-based <code>index</code>). Store or apply it — the host never caches the value itself.
	\|}		\|}

			Parameters are addressed exactly like shader effect parameters, e.g. <code>/mxw/track/2/layer/1/clip/media/1/param/1 0.8</code> or, for a <code>"string"</code>-typed param, <code>/mxw/track/2/layer/1/clip/media/1/param/2 "https://www.mxwendler.net"</code>. The <code>media/1</code> segment reflects the clip's single active media slot (any other index is out of range). Because the host does not persist a param's value, a plugin that wants one to survive a project reload must fold it into its own <code>onSave()</code>/<code>onLoad()</code> and hand the restored value back as <code>onGetParams()</code>'s <code>"default"</code> — which runs after <code>onLoad()</code> already restored the instance state.

	=== OpenGL rules for media plugins ===		=== OpenGL rules for media plugins ===
Line 374:		Line 386:
	\| <code>getProgress()</code> \|\| no \|\| Return <code>0.0 .. 1.0</code> to fill the cell's bottom progress bar (the same bar the built-in advance/fade items draw); <code><= 0</code> draws nothing.		\| <code>getProgress()</code> \|\| no \|\| Return <code>0.0 .. 1.0</code> to fill the cell's bottom progress bar (the same bar the built-in advance/fade items draw); <code><= 0</code> draws nothing.
	\|}		\|}

			=== Connecting to a TRIGGER item ===

			A playlist plugin (e.g. a keyframe timeline) can bind to a TRIGGER item and animate its layer/clip controls. The user drops a trigger either onto the plugin's settings panel or onto its grid cell; the plugin resolves the connection to the trigger's grid <code>(col, row)</code> and enumerates its controls from there. No need to play the trigger first — the controls are read from the connected preload's fixture layer, and the very same <code>(col,row)</code> address resolves the ''live'' layer during playout.

			{\| class="wikitable"
			! Function !! Meaning
			\|-
			\| <code>mxw_imgui.accept_trigger_drop()</code> \|\| Makes the current panel window a drop target for a trigger; returns the dropped trigger's 1-based <code>(col, row)</code>, or <code>(-1, -1)</code>. Handles the "drop onto the panel" route.
			\|-
			\| <code>mxw.pending_trigger_drop(item_id)</code> \|\| Returns a <code>(col, row)</code> stashed by the host when a trigger was dropped onto ''this'' plugin item's grid cell (pass your own <code>item_id</code>), or <code>(-1, -1)</code>. Handles the "drop onto the grid cell" route.
			\|-
			\| <code>mxw.trigger_controls(col, row)</code> \|\| Returns the trigger's animatable (slider) controls as <code>(label, address)</code> pairs — layer, clip, effect and media params. Re-read it every frame: controls the user swaps on the clip appear/vanish live. Each <code>address</code> is usable with <code>mxw.widget(address).setValue()</code>.
			\|-
			\| <code>mxw.pending_cell_scrub(item_id)</code> \|\| Returns the 0..1 fraction of an ALT + left-drag across ''this'' plugin item's grid cell (stashed by the host each frame while dragging, consumed on read), or <code>-1.0</code>. Needs the <code>plugin_cell_scrub</code> manifest opt-in. Poll it in <code>onNewFrameAlways()</code> so scrubbing also works while the panel is closed.
			\|}

			Poll both drop routes at the top of <code>onRenderPanel()</code> and store the resulting <code>(col,row)</code>; then call <code>mxw.trigger_controls()</code> to (re)build your control list each frame.

			A time connection between the connected clip and the plugin follows from these pieces: the clip's <code>.../clip/Position</code> control (normalized 0..1) is the clip's own time axis. Write it when your playhead moves (scrub → seek) and read it every frame to follow the clip when it is scrubbed — or simply playing. See the timeline plugin's <code>sync_time_link()</code> for a worked example including the echo filtering (a written Position reads back frame-quantized).

	=== Minimal example ===		=== Minimal example ===
Line 425:		Line 457:
	</syntaxhighlight>		</syntaxhighlight>

	Bundled references: <code>plugins/playlist/python/plugin_advance_datetime</code> (timed playlist navigation, rich settings panel ~~— [https://github.com/mxwendler/plugin_advance_datetime github]~~), <code>plugin_video_writer</code> ~~([https://github.com/mxwendler/plugin_video_writer github])~~, <code>~~plugin_ping~~</code>.		Bundled references, all in the [https://github.com/mxwendler/mxw-plugins-playlist mxw-plugins-playlist] repository: <code>plugins/playlist/python/plugin_advance_datetime</code> (timed playlist navigation, rich settings panel), <code>plugin_video_writer</code>, <code>plugin_comment</code> (a minimal example: a no-op annotation item).

	== Example plugins on GitHub ==		== Example plugins on GitHub ==

	The bundled example plugins are maintained as public repositories under [https://github.com/mxwendler github.com/mxwendler] — good starting points to fork for an own plugin:		The bundled example plugins are maintained as public repositories under [https://github.com/mxwendler github.com/mxwendler], grouped by type — good starting points to fork for an own plugin:

	{\| class="wikitable"		{\| class="wikitable"
	! Plugin !! Type !! Approach / purpose !! Repository		! Plugin !! Type !! Approach / purpose !! Repository
	\|-		\|-
	\| <code>plugin_opengl_cube</code> \|\| media \|\| Approach 2: ModernGL cube into an offscreen FBO, streamed \|\| [https://github.com/mxwendler/mxw-~~plugin~~-~~opengl~~-cube mxw-plugin-~~opengl~~-~~cube~~]		\| <code>plugin_opengl_cube</code> \|\| media \|\| Approach 2: ModernGL cube into an offscreen FBO, streamed \|\| [https://github.com/mxwendler/mxw-plugins-media mxw-plugins-media]
			\|-
			\| <code>plugin_opengl_cube_direct</code> \|\| media \|\| Approach 3: same cube rendered directly into the media texture \|\| [https://github.com/mxwendler/mxw-plugins-media mxw-plugins-media]
			\|-
			\| <code>plugin_web_media</code> \|\| media \|\| A web browser as media source (whole-scheme <code>web://</code> plugin) \|\| [https://github.com/mxwendler/mxw-plugins-media mxw-plugins-media]
	\|-		\|-
	\| <code>~~plugin_opengl_cube_direct~~</code> \|\| media \|\| ~~Approach 3: same cube rendered directly into the~~ media ~~texture~~ \|\| ~~ships with the installation~~		\| <code>plugin_fragcoord</code>, <code>plugin_shadertoy</code> \|\| media \|\| Shader-as-generative-media (FragCoord.xyz / Shadertoy) \|\| [https://github.com/mxwendler/mxw-plugins-media mxw-plugins-media]
	\|-		\|-
	\| <code>~~plugin_web_media~~</code> \|\| ~~media~~ \|\| ~~A web browser as media source (whole-scheme <code>web://</code> plugin)~~ \|\| [https://github.com/mxwendler/mxw-~~plugin~~-~~web-media~~ mxw-~~plugin-web~~-~~media~~]		\| <code>plugin_advance_datetime</code> \|\| playlist \|\| Timed playlist navigation with a rich settings panel \|\| [https://github.com/mxwendler/mxw-plugins-playlist mxw-plugins-playlist]
	\|-		\|-
	\| <code>~~plugin_advance_datetime~~</code> \|\| playlist \|\| ~~Timed~~ playlist ~~navigation with a rich settings panel~~ \|\| [https://github.com/mxwendler/~~plugin_advance_datetime plugin_advance_datetime~~]		\| <code>plugin_video_writer</code> \|\| playlist \|\| Write video files from the playlist \|\| [https://github.com/mxwendler/mxw-plugins-playlist mxw-plugins-playlist]
	\|-		\|-
	\| <code>~~plugin_video_writer~~</code> \|\| playlist \|\| ~~Write video files from the playlist~~ \|\| [https://github.com/mxwendler/~~plugin_video_writer plugin_video_writer~~]		\| <code>plugin_comment</code> \|\| playlist \|\| Minimal example: a no-op text annotation item \|\| [https://github.com/mxwendler/mxw-plugins-playlist mxw-plugins-playlist]
	\|}		\|}

Admin at 12:43, 5 July 2026

2026-07-05T12:43:12Z

Admin at 20:34, 3 July 2026

2026-07-03T20:34:28Z

← Older revision		Revision as of 22:34, 3 July 2026
Line 36:		Line 36:
	# The installation / resource directory: <code>plugins/media/python/</code>		# The installation / resource directory: <code>plugins/media/python/</code>

	Playlist plugins:		Playlist plugins, descending precedence:

			# The open <code>.mxw</code> project's <code>plugins/playlist/python/</code> tree (opt-in via settings, highest precedence)
			# Directories configured explicitly in the settings (Python tab)
	# The per-user data directory: <code>.../plugins/playlist/python/</code>		# The per-user data directory: <code>.../plugins/playlist/python/</code>
	# The installation / resource directory: <code>plugins/playlist/python/</code>		# The installation / resource directory: <code>plugins/playlist/python/</code>

Admin at 16:43, 3 July 2026

2026-07-03T16:43:35Z

@@ Line 439: / Line 439: @@
 | <code>plugin_video_writer</code> || playlist || Write video files from the playlist || [https://github.com/mxwendler/plugin_video_writer plugin_video_writer]
 |}
 == Persistence ==

Admin at 16:31, 3 July 2026

2026-07-03T16:31:54Z

← Older revision		Revision as of 18:31, 3 July 2026
Line 113:		Line 113:
	=== Installing own modules with mxw-pip ===		=== Installing own modules with mxw-pip ===

	Plugins may use third-party packages (<code>numpy</code>, <code>moderngl</code>, <code>opencv-python</code>, ...). ~~MXWendler bundles an ''embeddable'' Python 3.12 without its own <code>python.exe</code>, so packages~~ are not installed into the installation folder — ~~instead~~ the '''mxw-pip''' helper (shipped next to the StageDesigner executable) installs them into the current user's writable folder, '''no administrator rights required''':		Plugins may use third-party packages (<code>numpy</code>, <code>moderngl</code>, <code>opencv-python</code>, ...). Packages are not installed into the installation folder — the '''mxw-pip''' helper (shipped next to the StageDesigner executable) installs them into the current user's writable folder, '''no administrator rights required''':

	<pre>		<pre>
Line 120:		Line 120:

	This is exactly the directory StageDesigner prepends to <code>sys.path</code> when the option '''Prepend user site-path''' is enabled (Settings → Python tab).		This is exactly the directory StageDesigner prepends to <code>sys.path</code> when the option '''Prepend user site-path''' is enabled (Settings → Python tab).

			mxw-pip runs <code>pip</code> with the '''Python 3.12 shipped with StageDesigner''' (<code>python.exe</code> in the installation folder / in its <code>python312/</code> subfolder) — nothing else needs to be installed. Only when the shipped interpreter is missing does it fall back to a system Python (<code>py -3.12</code>, then <code>python</code> on <code>PATH</code>), which must be 3.12 so binary wheels match the runtime ABI.

	Step by step:		Step by step:

	# Make sure a system '''Python 3.12''' is installed — mxw-pip uses it to run <code>pip</code> (install it via the StageDesigner dependencies installer, or from [https://www.python.org/ python.org] with ''Add python.exe to PATH'' ticked). It must be 3.12 so binary wheels match the embedded interpreter's ABI.
	# Open '''Settings → Python''' and enable '''Prepend user site-path'''. The two installer buttons below are only active while this option is on, because mxw-pip installs into exactly that folder. Enabling applies immediately; disabling takes full effect after a restart.		# Open '''Settings → Python''' and enable '''Prepend user site-path'''. The two installer buttons below are only active while this option is on, because mxw-pip installs into exactly that folder. Enabling applies immediately; disabling takes full effect after a restart.
	# Click '''Launch CMD window with mxw-pip module installer..''' — this opens the installer shell (<code>mxw-pip-shell.bat</code>). In the shell, type:		# Click '''Launch CMD window with mxw-pip module installer..''' — this opens the installer shell (<code>mxw-pip-shell.bat</code>). In the shell, type:

← Older revision		Revision as of 17:28, 8 August 2026
Line 1:		Line 1:
	<!-- MXWendler wiki page: How to create a Python plugin (media and playlist) -->		<!-- MXWendler wiki page: How to create a Python plugin (media and playlist) -->
	<!-- Intended location: https://wiki.mxwendler.net/index.php?title=~~3._Python_plugin_reference~~ -->		<!-- Intended location: https://wiki.mxwendler.net/index.php?title=Python_plugin_reference -->
	<!-- See also: https://wiki.mxwendler.net/index.php?title=~~3._Python_command_reference~~ -->		<!-- See also: https://wiki.mxwendler.net/index.php?title=Python_command_reference -->
	<!-- See also: https://wiki.mxwendler.net/index.php?title=~~3._Python_imgui_reference~~ -->		<!-- See also: https://wiki.mxwendler.net/index.php?title=Python_imgui_reference -->

	MXWendler StageDesigner can be extended with '''Python plugins'''. A plugin is a plain folder containing a manifest file and a Python module; MXWendler discovers it at startup, shows it in the user interface and calls a defined set of Python functions (''hooks'') at the right moments.		MXWendler StageDesigner can be extended with '''Python plugins'''. A plugin is a plain folder containing a manifest file and a Python module; MXWendler discovers it at startup, shows it in the user interface and calls a defined set of Python functions (''hooks'') at the right moments.
Line 11:		Line 11:
	* '''Playlist plugins''' are items in the playlist grid: they run logic when their cue plays. Examples: advance the playlist at a given time of day, write video files, ping a host.		* '''Playlist plugins''' are items in the playlist grid: they run logic when their cue plays. Examples: advance the playlist at a given time of day, write video files, ping a host.

	The embedded interpreter is '''Python 3.12'''. The general Python command interface (module <code>mxw</code>) is documented in the [[3. Python command reference\|Python command reference]].		The embedded interpreter is '''Python 3.12'''. The general Python command interface (module <code>mxw</code>) is documented in the [[Python command reference\|Python command reference]].

	== Plugin anatomy ==		== Plugin anatomy ==
Line 117:		Line 117:
	=== Host modules ===		=== Host modules ===

	* <code>mxw</code> — the MXWendler command interface (playlist control, layers, clips, ...), see the [[3. Python command reference\|Python command reference]].		* <code>mxw</code> — the MXWendler command interface (playlist control, layers, clips, ...), see the [[Python command reference\|Python command reference]].
	* <code>mxw_imgui</code> — Dear ImGui bindings for drawing settings panels inside MXWendler (used by <code>onRenderPanel()</code>), documented in the [[3. Python imgui reference\|Python ImGui Reference]].		* <code>mxw_imgui</code> — Dear ImGui bindings for drawing settings panels inside MXWendler (used by <code>onRenderPanel()</code>), documented in the [[Python imgui reference\|Python ImGui Reference]].

	=== Installing own modules with mxw-pip ===		=== Installing own modules with mxw-pip ===
Line 341:		Line 341:
	== Playlist plugins ==		== Playlist plugins ==

	A playlist plugin is an item placed in the playlist grid. It participates in the cue lifecycle: it can run logic when its cue is played, every frame while its cue is active, or every frame globally. Playlist control functions (<code>mxw.playlist.play()</code>, <code>mxw.playlist.navigate_index()</code>, ...) are documented in the [[3. Python command reference\|Python command reference]].		A playlist plugin is an item placed in the playlist grid. It participates in the cue lifecycle: it can run logic when its cue is played, every frame while its cue is active, or every frame globally. Playlist control functions (<code>mxw.playlist.play()</code>, <code>mxw.playlist.navigate_index()</code>, ...) are documented in the [[Python command reference\|Python command reference]].

	=== Hooks ===		=== Hooks ===
Line 506:		Line 506:
	Reference: the bundled example in <MXWendler install dir>/plugins/media/python/		Reference: the bundled example in <MXWendler install dir>/plugins/media/python/
	plugin_opengl_cube_direct/ - follow its structure and hook usage exactly, and the		plugin_opengl_cube_direct/ - follow its structure and hook usage exactly, and the
	plugin howto at https://wiki.mxwendler.net/index.php?title=~~3._Python_plugin_reference~~.		plugin howto at https://wiki.mxwendler.net/index.php?title=Python_plugin_reference.

	The plugin is a generative OpenGL particle system, addressed as		The plugin is a generative OpenGL particle system, addressed as

← Older revision		Revision as of 14:17, 8 August 2026
Line 1:		Line 1:
	<!-- MXWendler wiki page: How to create a Python plugin (media and playlist) -->		<!-- MXWendler wiki page: How to create a Python plugin (media and playlist) -->
	<!-- Intended location: https://wiki.mxwendler.net/index.php?title=~~Python_Plugin_Howto~~ -->		<!-- Intended location: https://wiki.mxwendler.net/index.php?title=3._Python_plugin_reference -->
	<!-- See also: https://wiki.mxwendler.net/index.php?title=~~Python_Reference~~ -->		<!-- See also: https://wiki.mxwendler.net/index.php?title=3._Python_command_reference -->
	<!-- See also: https://wiki.mxwendler.net/index.php?title=~~Python_ImGui_Reference~~ -->		<!-- See also: https://wiki.mxwendler.net/index.php?title=3._Python_imgui_reference -->

	MXWendler StageDesigner can be extended with '''Python plugins'''. A plugin is a plain folder containing a manifest file and a Python module; MXWendler discovers it at startup, shows it in the user interface and calls a defined set of Python functions (''hooks'') at the right moments.		MXWendler StageDesigner can be extended with '''Python plugins'''. A plugin is a plain folder containing a manifest file and a Python module; MXWendler discovers it at startup, shows it in the user interface and calls a defined set of Python functions (''hooks'') at the right moments.
Line 11:		Line 11:
	* '''Playlist plugins''' are items in the playlist grid: they run logic when their cue plays. Examples: advance the playlist at a given time of day, write video files, ping a host.		* '''Playlist plugins''' are items in the playlist grid: they run logic when their cue plays. Examples: advance the playlist at a given time of day, write video files, ping a host.

	The embedded interpreter is '''Python 3.12'''. The general Python command interface (module <code>mxw</code>) is documented in the [[~~Python_Reference~~\|Python ~~Reference~~]].		The embedded interpreter is '''Python 3.12'''. The general Python command interface (module <code>mxw</code>) is documented in the [[3. Python command reference\|Python command reference]].

	== Plugin anatomy ==		== Plugin anatomy ==
Line 117:		Line 117:
	=== Host modules ===		=== Host modules ===

	* <code>mxw</code> — the MXWendler command interface (playlist control, layers, clips, ...), see the [[~~Python_Reference~~\|Python ~~Reference~~]].		* <code>mxw</code> — the MXWendler command interface (playlist control, layers, clips, ...), see the [[3. Python command reference\|Python command reference]].
	* <code>mxw_imgui</code> — Dear ImGui bindings for drawing settings panels inside MXWendler (used by <code>onRenderPanel()</code>), documented in the [[~~Python_ImGui_Reference~~\|Python ImGui Reference]].		* <code>mxw_imgui</code> — Dear ImGui bindings for drawing settings panels inside MXWendler (used by <code>onRenderPanel()</code>), documented in the [[3. Python imgui reference\|Python ImGui Reference]].

	=== Installing own modules with mxw-pip ===		=== Installing own modules with mxw-pip ===
Line 341:		Line 341:
	== Playlist plugins ==		== Playlist plugins ==

	A playlist plugin is an item placed in the playlist grid. It participates in the cue lifecycle: it can run logic when its cue is played, every frame while its cue is active, or every frame globally. Playlist control functions (<code>mxw.playlist.play()</code>, <code>mxw.playlist.navigate_index()</code>, ...) are documented in the [[~~Python_Reference~~\|Python ~~Reference~~]].		A playlist plugin is an item placed in the playlist grid. It participates in the cue lifecycle: it can run logic when its cue is played, every frame while its cue is active, or every frame globally. Playlist control functions (<code>mxw.playlist.play()</code>, <code>mxw.playlist.navigate_index()</code>, ...) are documented in the [[3. Python command reference\|Python command reference]].

	=== Hooks ===		=== Hooks ===
Line 506:		Line 506:
	Reference: the bundled example in <MXWendler install dir>/plugins/media/python/		Reference: the bundled example in <MXWendler install dir>/plugins/media/python/
	plugin_opengl_cube_direct/ - follow its structure and hook usage exactly, and the		plugin_opengl_cube_direct/ - follow its structure and hook usage exactly, and the
	plugin howto at https://wiki.mxwendler.net/index.php?title=~~Python_Plugin_Howto~~.		plugin howto at https://wiki.mxwendler.net/index.php?title=3._Python_plugin_reference.

	The plugin is a generative OpenGL particle system, addressed as		The plugin is a generative OpenGL particle system, addressed as

← Older revision		Revision as of 14:43, 5 July 2026
Line 2:		Line 2:
	<!-- Intended location: https://wiki.mxwendler.net/index.php?title=Python_Plugin_Howto -->		<!-- Intended location: https://wiki.mxwendler.net/index.php?title=Python_Plugin_Howto -->
	<!-- See also: https://wiki.mxwendler.net/index.php?title=Python_Reference -->		<!-- See also: https://wiki.mxwendler.net/index.php?title=Python_Reference -->
			<!-- See also: https://wiki.mxwendler.net/index.php?title=Python_ImGui_Reference -->

	MXWendler StageDesigner can be extended with '''Python plugins'''. A plugin is a plain folder containing a manifest file and a Python module; MXWendler discovers it at startup, shows it in the user interface and calls a defined set of Python functions (''hooks'') at the right moments.		MXWendler StageDesigner can be extended with '''Python plugins'''. A plugin is a plain folder containing a manifest file and a Python module; MXWendler discovers it at startup, shows it in the user interface and calls a defined set of Python functions (''hooks'') at the right moments.
Line 34:		Line 35:
	# Directories configured explicitly in the settings (Python tab)		# Directories configured explicitly in the settings (Python tab)
	# The per-user data directory, e.g. <code>%APPDATA%/MXWendler/plugins/media/python/</code>		# The per-user data directory, e.g. <code>%APPDATA%/MXWendler/plugins/media/python/</code>
	# The installation / resource directory: <code>plugins/media/python/</code>		# The installation / resource directory: <code>plugins/media/python/</code> (also <code>plugins/media/python_dev/</code>, same precedence, for internal/unpublished plugins)

	Playlist plugins, descending precedence:		Playlist plugins, descending precedence:
Line 41:		Line 42:
	# Directories configured explicitly in the settings (Python tab)		# Directories configured explicitly in the settings (Python tab)
	# The per-user data directory: <code>.../plugins/playlist/python/</code>		# The per-user data directory: <code>.../plugins/playlist/python/</code>
	# The installation / resource directory: <code>plugins/playlist/python/</code>		# The installation / resource directory: <code>plugins/playlist/python/</code> (also <code>plugins/playlist/python_dev/</code>, same precedence, for internal/unpublished plugins)

	=== The manifest: mxw_plugin.ini ===		=== The manifest: mxw_plugin.ini ===
Line 111:		Line 112:

	* <code>mxw</code> — the MXWendler command interface (playlist control, layers, clips, ...), see the [[Python_Reference\|Python Reference]].		* <code>mxw</code> — the MXWendler command interface (playlist control, layers, clips, ...), see the [[Python_Reference\|Python Reference]].
	* <code>mxw_imgui</code> — Dear ImGui bindings for drawing settings panels inside MXWendler (used by <code>onRenderPanel()</code>).		* <code>mxw_imgui</code> — Dear ImGui bindings for drawing settings panels inside MXWendler (used by <code>onRenderPanel()</code>), documented in the [[Python_ImGui_Reference\|Python ImGui Reference]].

	=== Installing own modules with mxw-pip ===		=== Installing own modules with mxw-pip ===
Line 370:		Line 371:
	\|-		\|-
	\| <code>renderBlinking()</code> \|\| no \|\| Return <code>True</code> to make the grid cell blink.		\| <code>renderBlinking()</code> \|\| no \|\| Return <code>True</code> to make the grid cell blink.
			\|-
			\| <code>getProgress()</code> \|\| no \|\| Return <code>0.0 .. 1.0</code> to fill the cell's bottom progress bar (the same bar the built-in advance/fade items draw); <code><= 0</code> draws nothing.
	\|}		\|}