Thorsten Buss 4d10db4f17 Initial public release

PHP 8.4 library and CLI tools to read, modify, and generate ProPresenter 7
files: songs (.pro), playlists (.proplaylist), bundles (.probundle), themes,
and the global library files (Macros, Labels, Groups, ClearGroups, CCLI,
Messages, Timers, Stage, Workspace, Props, TestPatterns, Calendar,
KeyMappings, CommunicationDevices).

Built on the MIT-licensed ProPresenter7-Proto schema by greyshirtguy
(v7.16.2). Includes 18 CLI parsers, comprehensive API docs in doc/,
binary-format specs, and a synthetic 369-test PHPUnit suite covering
RTF extraction, translation slides, ZIP64 repair, round-trip fidelity,
and end-to-end generation.

2026-05-03 22:21:01 +02:00

1.7 KiB

Raw Blame History

Stage Library API

PHP module for reading, modifying, and writing the global ProPresenter Stage file.

Quick Reference

use ProPresenter\Parser\StageFileReader;
use ProPresenter\Parser\StageFileWriter;

$library = StageFileReader::read('/path/to/Stage');

foreach ($library->getLayouts() as $layout) {
    $layout->getName();
    $layout->getUuid();
    $layout->getSlide(); // ?\Rv\Data\Slide
}

StageFileWriter::write($library, '/path/to/Stage');

File Layout

The Stage file is the protobuf-serialised Rv\Data\Stage\Document from stage.proto.

Field	Type	Description
`application_info`	`ApplicationInfo`	ProPresenter metadata
`layouts`	repeated `Stage.Layout`	Stage display layouts

StageLibrary

$library->getDocument();
$library->getLayouts();
$library->getLayoutByUuid('0455...'); // case-insensitive
$library->getLayoutByName('Default StageDisplay');
$library->addLayout($layout);
$library->removeLayout($uuid);
$library->count();
$library->getApplicationInfo();

StageLayout

$layout->getName();
$layout->setName('New name');
$layout->getUuid();
$layout->setUuid('...');
$layout->getSlide();
$layout->getProto();

The slide is exposed as the raw Rv\Data\Slide protobuf because stage layouts can contain complex arrangements.

CLI Tool

php bin/parse-stage.php /path/to/Stage

Key Files

File	Purpose
`src/StageFileReader.php`	Reads the `Stage` file
`src/StageFileWriter.php`	Writes the `Stage` file
`src/StageLibrary.php`	Document wrapper and indexes
`src/StageLayout.php`	Single layout wrapper
`bin/parse-stage.php`	CLI summary tool

1.7 KiB Raw Blame History