propresenter7-php-lib/proto/keyMappings.proto
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

40 lines
1.2 KiB
Protocol Buffer

syntax = "proto3";
package rv.data;
option cc_enable_arenas = true;
option csharp_namespace = "Pro.SerializationInterop.RVProtoData";
option swift_prefix = "RVData_";
import "applicationInfo.proto";
import "hotKey.proto";
import "uuid.proto";
// KeyMappingsDocument is the global ProPresenter `KeyMappings` file. The
// reference sample on disk is just an `ApplicationInfo` envelope with an
// otherwise empty body — ProPresenter seeds the file at startup. Once the
// user binds hot keys we expect them in `mappings`.
message KeyMappingsDocument {
message Mapping {
// Optional stable identifier for the mapping.
.rv.data.UUID uuid = 1;
// The hot key combo that fires the action.
.rv.data.HotKey hot_key = 2;
// Action target — typically a macro UUID, a control identifier, or any
// other reference ProPresenter chooses to encode. Kept as bytes so we
// round-trip cleanly while ProPresenter's internal schema evolves.
bytes target = 3;
// Display name (optional).
string name = 4;
}
// Application metadata of the writer.
.rv.data.ApplicationInfo application_info = 1;
// Configured key bindings. Empty in the reference sample.
repeated Mapping mappings = 2;
}