Examples - frankischilling/crust GitHub Wiki
Example Plugins
The repository includes focused example plugins you can copy into your local plugin directory.
Included Examples
hello_plugintimer_pluginclock_usage_pluginapi_tour_pluginevent_callback_demo_pluginloader_progress_demo_pluginstateful_counter_pluginchannel_toolbox_pluginui_window_showcase_pluginui_settings_demo_pluginui_host_panels_demo_plugin
What They Show
hello_plugin: the smallest possible command registration and completion exampletimer_plugin: delayed local work withc2.laterclock_usage_plugin: a retained clock window with local time, session time, lifetime Crust time, and focused per-channel trackingapi_tour_plugin: broad coverage of the Lua API surface, including account lookups, channel lookups, reply-capable chat actions, reward-redemption updates, fetch helpers, and event callbacksevent_callback_demo_plugin: a focused callback example for profile, preview, and stream-status eventsloader_progress_demo_plugin: low-level loader notifications, includingImagePrefetchQueued,EmoteImageReady, andEmoteCatalogUpdatedstateful_counter_plugin: persistent plugin state and completion hookschannel_toolbox_plugin: channel lookup, sending messages, local notes, and clearing message buffersui_window_showcase_plugin: floating plugin window, host-form fields, submit events, retained updates, and alink_buttonthat still emits callbacks; see UIui_settings_demo_plugin: plugin-owned settings page in the shared Plugins area of the Settings window with host-form submit handling; see UIui_host_panels_demo_plugin: plugin-owned host panels rendered insettings.appearance,sidebar.top, andchannel_header; see UI
Suggested Reading Order
hello_plugintimer_pluginchannel_toolbox_pluginevent_callback_demo_pluginloader_progress_demo_pluginui_window_showcase_pluginui_settings_demo_pluginui_host_panels_demo_pluginapi_tour_plugin
Install
See Installation.