Skip to content

Export notes #1711

@mark-epstein

Description

@mark-epstein

Describe the feature
When exporting a .companionconfig file, notes about the user's changes are included as part of the saved data

This is not to suggest that Companion track the changes, but the user would be prompted with a free-form text field to complete. Whatever they type in that field would be stored with all the button/page date, like this:
{"usernotes":"Reversed order of buttons on camera page\nDuplicated pages 1 and 3 for second audio channel"}

When importing, after a .companionconfig file is selected, the Companion GUI will show the page(s) as it does now, but will also show the notes the user saved with it.

Other fields could be prompted/saved/displayed too, like the users's name, although they could just include that in the notes.

Usecases
Allows the person saving the configuration and the person importing it to communicate through time

potential issues
What would older versions of Companion do if they encounter a value pair they don't recognize?

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    Status

    No status

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions