public/propresenter-php
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity
propresenter-php/src
History
Thorsten Bus 9e3e719806 feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 
Add full IO support for every global ProPresenter library file plus
theme folders, and extend the existing Labels/Macros readers with
exporters and editable accessors so every supported document is now a
round-trippable, mutable object.

New library readers/writers (each: FileReader, FileWriter, Library
wrapper, element wrapper where applicable, CLI tool, tests, doc/api/*.md):

- Groups          (ProGroupsDocument)        + GroupDefinition
- ClearGroups     (ClearGroupsDocument)      + ClearGroupDefinition
- CCLI            (CCLIDocument)
- Messages        (MessageDocument)          + Message
- Timers          (TimersDocument + Clock)   + Timer
- Stage           (Stage.Document)           + StageLayout
- Workspace       (ProPresenterWorkspace)    + Screen
- Props           (PropDocument)             + Prop
- TestPatterns    (TestPatternDocument)
- Calendar        (new CalendarDocument)     + CalendarEvent
- KeyMappings     (new KeyMappingsDocument)  + KeyMapping
- CommunicationDevices (JSON file)           + CommunicationDevice
- Theme bundles   (Template.Document folder + Assets/) + ThemeBundle/Slide/Asset

Extensions to existing modules:

- LabelsFileWriter; Label and LabelLibrary gain setters, addLabel,
  removeLabel, setColor / setColorHex helpers
- MacrosFileWriter; Macro/MacroCollection/MacroLibrary gain UUID, name,
  color, image_type, image_data, trigger_on_startup setters plus
  add/remove for macros and collections

Two new minimal proto schemas were defined for documents that lacked
upstream definitions:

- proto/calendar.proto   - CalendarDocument with Event entries, raw
  bytes for the action/macro sub-messages so the schema can evolve
- proto/keyMappings.proto - KeyMappingsDocument with ApplicationInfo
  and a forward-looking Mapping message (sample only carries the info)

The Theme file turned out to be a regular Rv\Data\Template\Document, so
no new proto was required for theme content; ThemeBundle layers folder
+ Assets/ handling on top in the same spirit as PresentationBundle.

GroupDefinition is intentionally distinct from the existing Group class
(which wraps song-level CueGroup) to avoid breaking song APIs.

Verified with the full PHPUnit suite: 370 tests, 9200 assertions, all
green; LSP diagnostics clean across src/. The unmodified reference
samples for Labels, Groups, ClearGroups, TestPatterns, Calendar and
KeyMappings round-trip byte-for-byte; the others round-trip with the
same byte length (PHP protobuf is not canonically deterministic but
re-write-after-write stabilises).

doc/INDEX.md, doc/keywords.md and AGENTS.md updated so every new module
is discoverable from the top level.
2026-05-03 21:40:09 +02:00
..
Arrangement.php refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
CalendarEvent.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
CalendarFileReader.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
CalendarFileWriter.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
CalendarLibrary.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
CCLIFileReader.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
CCLIFileWriter.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
CCLILibrary.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
ClearGroupDefinition.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
ClearGroupsFileReader.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
ClearGroupsFileWriter.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
ClearGroupsLibrary.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
CommunicationDevice.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
CommunicationDevicesFileReader.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
CommunicationDevicesFileWriter.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
CommunicationDevicesLibrary.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
Group.php refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
GroupDefinition.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
GroupLibrary.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
GroupsFileReader.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
GroupsFileWriter.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
KeyMapping.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
KeyMappingsFileReader.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
KeyMappingsFileWriter.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
KeyMappingsLibrary.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
Label.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
LabelLibrary.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
LabelsFileReader.php feat(labels): add reader for global Labels file 2026-05-03 20:53:45 +02:00
LabelsFileWriter.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
Macro.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
MacroCollection.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
MacroLibrary.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
MacrosFileReader.php feat(macros): add reader for global Macros file 2026-05-03 20:38:47 +02:00
MacrosFileWriter.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
Message.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
MessageLibrary.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
MessagesFileReader.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
MessagesFileWriter.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
PlaylistArchive.php refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
PlaylistEntry.php refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
PlaylistNode.php refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
PresentationBundle.php refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
ProBundleReader.php refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
ProBundleWriter.php refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
ProFileGenerator.php refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
ProFileReader.php refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
ProFileWriter.php refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
Prop.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
ProPlaylistGenerator.php refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
ProPlaylistReader.php refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
ProPlaylistWriter.php refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
PropLibrary.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
PropsFileReader.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
PropsFileWriter.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
RtfExtractor.php refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
Screen.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
Slide.php refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
Song.php refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
StageFileReader.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
StageFileWriter.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
StageLayout.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
StageLibrary.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
TestPatternsFileReader.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
TestPatternsFileWriter.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
TestPatternsLibrary.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
TextElement.php refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
ThemeAsset.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
ThemeBundle.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
ThemeFileReader.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
ThemeFileWriter.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
ThemeSlide.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
Timer.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
TimersFileReader.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
TimersFileWriter.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
TimersLibrary.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
WorkspaceFileReader.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
WorkspaceFileWriter.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
WorkspaceLibrary.php feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
Zip64Fixer.php refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00