https://github.com/rse/rundown
Generate Rundown Scripts for Teleprompting
https://github.com/rse/rundown
cue prompter rundown
Last synced: 5 months ago
JSON representation
Generate Rundown Scripts for Teleprompting
- Host: GitHub
- URL: https://github.com/rse/rundown
- Owner: rse
- License: gpl-3.0
- Created: 2023-12-10T10:29:11.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-01-06T09:56:57.000Z (over 1 year ago)
- Last Synced: 2025-03-10T10:46:47.887Z (over 1 year ago)
- Topics: cue, prompter, rundown
- Language: Vue
- Homepage: https://npmjs.com/@rse/rundown
- Size: 1.68 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Rundown
=======
**Render Rundown Scripts for Teleprompting**
[](https://github.com/rse)
[](https://github.com/rse)
[](https://github.com/rse/rundown)
Abstract
--------
**Rundown** is a toolkit for rendering *rundown scripts* for
teleprompting. It reads a style-driven *Microsoft Word* format file
(`*.docx`) as its "single source of truth", extracts columns of a
particular table from it, and renders a typographically strong and
smooth scrolling HTML output for use in a browser-based teleprompting
scenario.
**Rundown** consists of a library, providing the base functionality, and
both a command-line interface and Web user interface for driving
the functionality. The teleprompting view can be rendered ad-hoc in batch,
continuously in batch, or interactively.
Additionally, **Rundown** can remote control *Microsoft PowerPoint* for
driving a companion slideset, or remote control *Bitfocus Companion* for
driving dependent aspects of an event, like audio and video. Finally,
**Rundown** optionally provides a auto-scrolling functionality, based on
client-side Speech-to-Text conversion and fuzzy text matching.
**Rundown** is a rather opinionated solution from *Dr. Ralf S.
Engelschall*, CTO of the msg group, based on years of experience
with live events at his *msg Filmstudio*. It is provided as
[Open Source](https://opensource.org/) software under the
[General Public License](LICENSE.txt).
Impressions
-----------
The following is the rundown script input in Microsoft Word:
The following is a side-by-side view of the Microsoft Word rundown
script input on the left, and the rendered teleprompter view on the
right:
The following is the rendered prompting view in the original 16:9 aspect ratio,
as shown in the studio on the teleprompters:
The following are two screenshots of the interactive web user interface,
showing the buttons to download and upload the rundown script, and the
supported keystrokes for controlling the scrolling of the rendered
teleprompter view:
Central Application
-------------------
Visit the URL https://rundown.studio.msg.team/ to load a centrally
deployed **Rundown** as a Web UI application into your local browser
and then, fully offline, use local download and upload operations from
within this application.
NOTICE: This application is a client-side-only application, i.e., once
the application is loaded, there is no more server communication, as
the DOCX to HTML conversion is performed directly within this Web
application. As a consequence, your DOCX input and the corresponding
rendered HTML output never leave your local browser sandbox. Also, the
application, once loaded, can operate fully offline.
Installation
------------
```
$ git clone https://github.com/rse/rundown
$ npm install
$ npm start build
```
Usage
-----
- **CMD** Mode (One-Shot Conversion)
Render the DOCX input to an HTML output in a one-shot conversion mode.
The conversion itself is performed locally in the started tool process.
```
# with Rundown source tree
$ npm run rundown -o rundown-1-doc/rundown-template.html rundown-1-doc/rundown-template.docx
$ npm run rundown -o - - >rundown-1-doc/rundown-template.html rundown-template.html rundown-template.html
Licensed under [GPL 3.0](https://spdx.org/licenses/GPL-3.0-only)