GMC Progress Tracker

[avanwinkle]

The following outline covers the core functionality that the Godot MC will need to be a usable replacement for the old Kivy MC.

MVP Requirements

Core

• [x] Godot Plugin with custom classes and singletons
• [x] BCP Interface to communicate with MPF
• [x] Keyboard input support for events and switches
• [x] Basic logging support
• [x] Logging levels with verbose and production flags

Slides

• [x] [MPF] SlidePlayer plugin
• [x] Base class for MPFSlide
• [x] User-generated slides with default fallbacks
• [x] Play slides from slides_play event
• [x] Update slides from action: update arg
• [x] Remove slides from action: remove arg
• [x] Remove slides from expire: <secs> arg
• [x] Remove slides from slides_clear event
• [x] Support for action: method calls to slide methods
• [x] Events for slide active, inactive, and removed
• [x] Stack slides by priority
• [x] Target slides to a specific display
• [x] Override mode context to prevent auto-removal
• [x] Reset expiration time if slide is re-played

Widgets

• [x] [MPF] WidgetPlayer plugin
• [x] Base class for MPFWidget
• [x] Play widgets from widgets_play event
• [x] Update widgets from action: update arg
• [x] Remove widgets from action: remove arg
• [x] Remove widgets from expire: <secs> arg
• [x] Remove widgets from widgets_clear event
• [x] Support for action: method calls to widget methods
• [x] Support for x/y coordinates to position widgets
• [x] Support for key config for unique instances of the same widget
• [x] Target widgets to a specific display
• [x] Target widgets to a specific slide

Variables

• [x] Base class for MPFVariable
• [x] Text nodes for player, machine, and event arg values
• [x] Options for comma separation, minimum digits, and initialize empty
• [x] Custom text formatting with injection of variable value
• [x] Dynamic values from vars, events, and event settings
• [x] Update text on player variable changes
• [x] Update text on action: update arg
• [x] Subscribe to custom events and update

Window

• [x] Base class for MPFWindow
• [x] Pass slide events to target display
• [x] Support multiple displays/monitors
• [x] Flag for fullscreen mode
• [x] Configurable DMD dot shader

Widget Types and Behaviors

• [x] Video widget auto-removal after playback
• [x] Video widget events_when_stopped
• [x] Carousel widget with child toggling based on event item

Sounds

• [x] [MPF] SoundPlayer plugin
• [x] Base class for SoundPlayer
• [x] Playback of sounds from sounds_play event
• [x] Stop sounds from action: stop arg
• [x] Stop sounds from sounds_clear event
• [x] Dynamic allocation of tracks and channels from config
• [x] Track types for solo, simultaneous, and sequential
• [x] Support events_when_started and events_when_stopped
• [x] Support for sound pools and randomizer
• [x] Support for fade_out value persisting life of sound and applying on stop
• [x] Support for sound looping
• [x] Automatic cross-fading of solo tracks
• [x] Max queue time

Editor Integration

• [x] Editor plugin with custom classes

Usability

• [x] Sample project with demos for all features
• [x] Installation & Setup guide
• [x] Tutorials for common scenarios

[avanwinkle]

Future Features (post MVP)

Slides

• [x] Delay clearing of only slide until next one arrives
• [x] Transitions for slide entry/exit
• [x] Queue player for sequential playback

Variables

• [ ] Base class for MPFRichTextVariable
• [ ] Parse RichText to substitute multiple MPF values
• [x] Advanced string formatting with key/value substitution

Sounds

• [x] Markers and marker-based events
• [x] Sound loop mixing
• [ ] Support explicit number of loops rather than just loop on/off

Editor Integration

• [x] Custom icons for custom classes
• [x] Spawn MPF with project launch
• [x] Configure launch flags via UI tab
• [x] Render MPF log output in UI tab
• [x] Logging levels with verbose, debug, info
• [ ] Production optimization

[ecurtz]

Random links on various in progress items: Logging: https://godotengine.org/asset-library/asset/2381 Variable formatting: https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/gdscript_format_string.html Fullscreen display: https://docs.godotengine.org/en/latest/classes/class_displayserver.html#class-displayserver-method-window-set-mode Sound mixing: https://github.com/godotengine/godot-proposals/issues/3286