Integrating with CueScript

TinkerList can be integrated with the Shared Folder mechanism of CueScript. Here you can read how.

Erik Hauters avatar
Written by Erik Hauters
Updated over a week ago

TinkerList Desktop app

As it is not possible to directly write files from the Chrome browser to your filesystem you need our Desktop App to achieve the integration with CueScript.

You can download it here: https://software.tinkerlist.tv

Our Desktop App looks completely the same as our webapp, but it has the possibility to write files to your filesystem. And that's what we need to be able to write to the shared folder of the teleprompter software.

Configuration

  1. Open the TinkerList Desktop app and log in in your project.

  2. In your TinkerList project, open a script from the calendar or sidebar

  3. Click the three vertical dots in the top right corner of the script to open the menu

  4. Select 'Teleprompter'

A panel will open on the side, allowing you to configure the teleprompter output. Here you can configure your device as well as which cards, fields and markers to show or hide in the prompter output.

Different tabs available in the prompter configuration panel

Device:

As it is possible to create multiple configurations, each with their own set of cards, fields and markers to show or hide, the first step is to give your configuration a name.

Next, set your Device Type to CueScript Shared Folder in the dropdown menu.

If this option is not yet enabled for your project, a message will be shown - please contact our Sales colleagues for more information.

Now we can select the shared folder at the bottom of the Device tab. This is the same folder that the CueScript application needs to be pointed to as well.

If you turn on Sync (red 'off', green 'on' switch at the top) files will be created in the Shared Folder. And the list-titles will appear in the teleprompter software.

Every letter you type in the script, every change you make to the configuration will immediately reflect in the prompter from the moment you turn on the sync.

At the bottom of the panel you find a "Duplicate" button, this duplicates the whole setup as is now. Rename it under "Configuration Name" and then you can switch top left between Configurations.

All configurations are stored in the cloud, so when you open the panel on another computer you will find the same settings. They are stored per project.
โ€‹
When you close this panel or the script, the system stops syncing with the Shared Folder.

You can minimize the prompt panel by clicking on the arrow next to the panels title:

You can still control syncing on or of by the small menu on the right:

General:

Here you can change settings for List Titles Format, Card Titles Format, Remove everything between {}, Float everything between [], and set a Character That Will Be Replaced With A Line Feed.

Lists:

Lines Before Every List: allows you to add empty lines before a script List.

Lines After Every List: allows you to add empty lines after a script List.

Remove Lists (Separate With Comma): allows you to hide certain lists on the prompter.

Cards:

The Cards tab will give you an overview of all of the different card types that are being used in your TinkerList project. For each of these card types you can select whether or not you want to see them on the prompter by simply enabling or disabling them here - click the eye-icon in front of the card type you want to enable.

Once a card has been enabled, you can unfold it for more options. These options are configurable per card type and can vary based on the available card fields:

  • Use Badge numbers (off/on to hide/show badge numbers)

  • Text Before (show custom text before each card of this type)

  • Empty Lines Before (add empty lines before each card of this type)

  • Empty Lines After (add empty lines after each card of this type)

  • Replace With (replace each card of this type with custom text)

  • Remove strikethrough text (hide strikethrough text)

  • No slugline for this card (select to hide slugline)

  • Title Field (select which card field to use as the title field on the prompter)

  • Show Field ... (separately enable/disable each available card field)

  • Empty Lines After Field: ... (add empty lines after a field, configurable per field)

  • Label Before Field: ... (add a label before a field, configurable per field)

Markers:

Markers can be configured in a way similar to the card configuration. For each available Marker, you have to option to enable or disable it, as well as do custom configuration. Click the eye-icon in front of the marker you want to enable.

Once a marker has been enabled, you can unfold it for more options. These options are configurable per marker:

  • Lines Before (add empty lines before each marker of this type)

  • Lines After (add empty lines after each marker of this type)

  • All Caps (put marked text in ALL CAPS)

  • Bold (put marked text in bold)

  • Italics (put marked text in italics)

  • Replace With (replace marked text with custom text)

  • Text Before (show custom text before each marker of this type)

  • Text After (show custom text after each marker of this type)

  • Remove Everything After Character (remove all other marked text after the specified character)

  • Prompter Surrounding Tags (add specific tags around the marked text, allowing you to further style text in CueScript)

  • Remove and keep line breaks (remove the marked text but keep the line breaks)

Did this answer your question?