PrompterKit

Manage your Elgato Prompter scripts from the command line or a local web GUI. Camera Hub stores scripts in opaque JSON with no import, export, rename, reorder, or backup path. PrompterKit fills every gap.

Site: https://prompterkit.app/ Repo: https://github.com/snapsynapse/prompter-kit

Based on spieldbergo/elgato_prompter_text_importer (MIT).

Requirements

• Python 3.10+
• Elgato Camera Hub installed
• Flask (GUI only): pip install flask

Close Camera Hub before any write operation, or use --restart / the camerahub subcommand to have PrompterKit do it for you.

Quick start

CLI

# Import a .txt or .md file (one line per chapter)
python3 prompter_kit.py import script.md --name "My Script"

# Import and auto-restart Camera Hub around the write
python3 prompter_kit.py import script.txt --name "My Script" --restart

# List registered scripts
python3 prompter_kit.py export --list

# Export one script by name or GUID
python3 prompter_kit.py export --name "My Script" --output my_script.txt

# Export every script to a directory
python3 prompter_kit.py export --all --output ./exported/

# Rename, delete, reorder
python3 prompter_kit.py rename "Old Name" "New Name"
python3 prompter_kit.py delete "My Script"
python3 prompter_kit.py reindex "Intro" "Act One" "Outro"

# Edit chapters in $EDITOR
python3 prompter_kit.py edit "My Script"

# Back up and restore the whole library
python3 prompter_kit.py backup --output backup.zip
python3 prompter_kit.py restore backup.zip           # replaces library
python3 prompter_kit.py restore backup.zip --merge   # adds new only

# Quit or relaunch Camera Hub
python3 prompter_kit.py camerahub stop
python3 prompter_kit.py camerahub start

GUI

python3 prompter_kit_gui.py

Opens a local web app in your browser for import, export, rename, delete, reorder, backup, and restore, with drag-and-drop file input.

Commands

Command	What it does
import	Register a .txt or .md file as a Prompter script. Markdown formatting is stripped.
export	Write a script, or all scripts, back to .txt. Supports --list, --name, --guid, --all.
delete	Remove a script from Texts/ and AppSettings.json.
rename	Change a script's friendly name.
reindex	Reorder the library. Pass names/GUIDs in desired order, or no args to normalize.
edit	Open a script's chapters in $EDITOR and re-save on close.
backup	Zip all scripts plus AppSettings.json into a timestamped archive.
restore	Restore from a backup zip. --merge keeps existing scripts.
camerahub stop / start	Quit or relaunch Camera Hub (macOS osascript, Windows taskkill).

Script format

Plain .txt or .md. Each non-empty line becomes one chapter.

# Act One

- Welcome to the show.
- **Tonight** we cover three topics.

imports as three plain chapters. Markdown headings, bold, italic, links, images, inline code, blockquotes, list bullets, and strikethrough are stripped.

Safety

• Atomic writes: JSON is written to a temp file then renamed, so an interrupted write cannot corrupt AppSettings.json.
• Rollback: if updating AppSettings.json fails after writing a new script JSON, the script JSON is removed.
• Validation: restore rejects zips missing AppSettings.json or with unexpected paths.

Data locations

Platform	Path
macOS	~/Library/Application Support/Elgato/CameraHub/
Windows	%APPDATA%\Elgato\CameraHub\

Running tests

python3 -m pytest tests/ -v

71 tests cover import, export, CRUD, backup/restore, Markdown stripping, and atomic-write rollback.

Contributing

See CONTRIBUTING.md.

License

MIT. See LICENSE.