search

bitfocus / companion

Bitfocus Companion enables the reasonably priced Elgato Stream Deck and other controllers to be a professional shotbox surface for an increasing amount of different presentation switchers, video playback software and broadcast equipment.
http://bitfocus.io/companion
Other
1.61k stars 503 forks source link

A "notes" section in the button editor #760

Open officialmattsnyder opened 5 years ago

officialmattsnyder commented 5 years ago

Describe the feature A simple text box in the button editor to be used to write and store notes for future button editing. This would be especially helpful for buttons with more extensive action sequences. Possibly even an option for notes on each individual action?

Is this platform dependent (windows, mac, ..)? nope

If documentation is required to implement, do you know where to find it? n/a

Usecases This is really just about clarifying things for my future self. I'll frequently run into things where I have an action that triggers some random slide or cue somewhere and I can't remember what's on that slide. A notes box would let me type something like "This does X" so that I can quickly remember what it's all doing after the fact.

josephdadams commented 5 years ago

This would actually be really nice. +1

stevespaw commented 4 years ago

+1 For leaving notes about things like delay timings !!

gitgonow commented 2 years ago

Because of the complexity of some of my buttons, having the ability to add some sort of a comment would save many hours. Hopefully this is coming soon...

MyNameisStitch commented 2 years ago

I'd also like to see this, perhaps a small text box above the Delay field or make the name of the function editable once it's added to the button editor

sbswin commented 2 years ago

Please implement for buttons, triggers, variables and even connections and surfaces. The first three can be used to implement complex function and being able to add and change notes as you go would help considerably when you return to the implementation some weeks later.

Coupe70 commented 2 months ago

Maybe I'm late to the party, but just in case... As comments in actions are there in the meantime and might solve the problem for many buttons: Would it be an option to create a "comment action" that only contains a text field and that you can add to a button only when needed? That way a comment field would not eat up space on EVERY button. Or at least make the comment field only being created when you click a comment icon, like with the note feature in actions?