Support

Product: Checklist Keys (Stream Deck plugin for Windows) · Provider: GRAMSHIFT (Tokyo, Japan)

Contact

Email contact@gramshift.com in English or Japanese. Requests for features and bug reports are welcome, and every message is read; we do not guarantee a reply time. Please include your Windows version (Settings > System > About), your Stream Deck app version, and a photo or screenshot of the key and of its settings (the Status line says what the plugin counts).

Get started

Install the plugin from the Elgato Marketplace. In the Stream Deck app, find Checklist Keys in the action list.
Drag Check Item onto a key and type a Label, for example Mic on. Do the same for each step of your checklist.
Drag Progress onto a key. It shows how many items are checked, for example 0/5.
Press an item to check it. Press it again to uncheck it.
To start over, hold the Progress key for 1 second, or add a Reset List key and press it twice.

For more than one checklist, type a name in List on each key. Keys with the same list name form one checklist (upper and lower case do not matter). Keys without a list name belong to the list Checklist.

The actions

Check Item: one item. Label can have 2 lines; a long label is drawn smaller, and a very long one is cut. With Uncheck: Only with a long press, a checked item is unchecked only when you hold the key for 1 second, and a short press shows HOLD TO UNCHECK.
Progress: checked items and all items of the list, such as 3/7, with a bar. It counts the items on every page and profile, and turns green when all are checked. Long press: holding the key for 1 second unchecks the whole list (you can switch this off).
Reset List: unchecks every item of the list. Reset with: two presses within 3 seconds (after the first press the key asks SURE?), or a long press of 1 second. A single short press never resets.
Look (every key): Classic, Neon, Ring, Solid or Paper.

Automatic reset

In the settings of a Progress or Reset List key, Auto reset unchecks the whole list automatically:

Every day at the time below: at the Time you set (the clock of your PC). If Stream Deck was closed at that time, the list is unchecked once at the next start. A list is not unchecked twice for the same day, unless you change the clock of the PC by hand.
When the plugin starts: each time the Stream Deck app starts the plugin. That is when Stream Deck starts, and also when Stream Deck restarts the plugin (after an update or an error).
Off (the default): the list changes only when you press keys.

The setting belongs to the list, not to one key: every Progress and Reset List key of the list shows the same setting, and changing it on one key changes it for the list. It works while Stream Deck is running, whatever page is shown. The setting is kept under the name of the list: if you change the list name on your keys, the automatic reset does not follow to the new name and has to be set again.

Where the check marks are kept

The plugin stores your checklists (labels, list names, check marks) in its settings inside the Stream Deck app on your PC. That is why they are still there after the Stream Deck app or the PC restarts. Each Check Item key carries a hidden identifier in its own settings, which ties the key to its check mark.

What you do	What happens
Restart Stream Deck or the PC	Check marks stay, unless the list has an automatic reset (one that is due, or "When the plugin starts").
Switch to another page or profile	Nothing changes. Progress keeps counting the items on the pages you do not see.
Copy and paste a Check Item key	The copy becomes a new item of the same list, unchecked.
Delete a Check Item key	The Stream Deck app does not tell a plugin that a key was deleted. If other keys of this plugin are on the same page, the plugin notices within about 2 seconds that the key is gone and stops counting it. If the item is still counted, open the settings of the Progress key and select Forget next to it. Each row says when the key of that item was last visible ("seen 3 days ago"), which can help you tell items with the same label apart. An item whose key is visible now has no Forget.
Move a Check Item key to another page	The item can leave the count until you open that page once, and it can lose its check mark and start unchecked. If the count is wrong afterwards, select Forget for the extra item in the settings of the Progress key.
Change the list name of a key	The item moves to that list.
Export a profile and import it on another PC	The check marks are stored outside the profile, so we expect the keys, labels and list names to come along and all items to start unchecked.

Compatibility

Tested on Windows 11. Windows 10 is supported by the Stream Deck app but has not been checked by us.

Questions

The Progress key counts one item too many.
A deleted or moved key is still counted. Open the settings of the Progress key and select Forget next to that item (the one that is not "visible now").

The Progress key shows 0/0.
No Check Item key uses that list name yet. Check the spelling in List on both keys.

My list was unchecked when I did not expect it.
Look at Auto reset in the settings of a Progress or Reset List key of that list. "When the plugin starts" also unchecks the list when Stream Deck restarts the plugin after an update or an error. Holding the Progress key for 1 second also unchecks the list; you can switch that off under Long press.

Can a key do something else when I check it, such as start a program?
Not in this version. The keys cannot be used inside a Multi Action.

Does it work on Mac?
No. This plugin is for Windows only (Windows 10 or later).

Privacy

Your checklists stay on your PC. Nothing is sent to us or to any online service. See the Privacy Policy for exactly what is stored.