Teleprompter Plus

Teleprompter Plus

---

What it does

Teleprompter Plus turns any Obsidian note into a professional teleprompter. Auto-scroll at adjustable speed, highlight your reading position, control playback from the keyboard, an Elgato Stream Deck, or a phone, and optionally read your script aloud with high-quality neural voices. Designed for creators who already live in Obsidian and want a teleprompter that speaks the same Markdown they write in.

Key features

• Smooth auto-scroll — variable speed (0.5×–10×), countdown timer, manual scroll, horizontal/vertical flip for camera-rig mirrors
• Hierarchical navigation — collapsible header tree, abstract-scrollbar minimap, click-to-jump, active-section highlighting
• Stream Deck integration — 55+ actions across 8 categories with real-time bidirectional state sync (catalog)
• Mobile remote control — touch-friendly web interface, control from any device on your network
• Neural text-to-speech — Kokoro MLX (22 voices, Apple Silicon), macOS say, Web Speech fallback, sentence-by-sentence highlighting
• Citation resolution — [@ries2011] spoken as "(Ries, 2011)" using your .bib files
• Full Markdown support — Obsidian syntax, math, callouts, code with syntax highlighting, tables, images, internal links
• 8 built-in themes — Professional, Broadcast, Stream, Practice, Accessibility, Cinema, plus custom colors and fonts
• OBS integration — start/stop recording synced with teleprompter playback
• Local WebSocket API — build custom integrations in any language (API reference)

---

Screenshots

Main interface

Clean reading display with hierarchical navigation panel, eyeline guide, and real-time position tracking.

Mobile remote

Touch-friendly remote — phone, tablet, or second computer on the same network.

Stream Deck

55+ hardware actions with live state synchronization across all controls.

Settings

Six-tab settings: Dashboard, Toolbar, Features, Profiles, Connection, About.

---

Installation

Community Plugin browser (recommended once published)

Obsidian → Settings → Community plugins → Browse → search Teleprompter Plus → Install → Enable.

Manual install

1. Download main.js, styles.css, and manifest.json from the latest release.
2. Place them in <your-vault>/.obsidian/plugins/teleprompter-plus/ (create the folder if needed).
3. Obsidian → Settings → Community plugins → Reload → enable Teleprompter Plus.

Build from source

git clone https://github.com/JuracyAmerico/obsidian-teleprompter-plus.git
cd obsidian-teleprompter-plus
bun install
bun run build
# copy dist/main.js, dist/styles.css, and manifest.json into your vault's plugins folder

See CONTRIBUTING.md for the full development setup.

---

Quick start

1. Open — click the teleprompter ribbon icon, or run Open Teleprompter Plus from the command palette (Cmd/Ctrl + P).
2. Pick a note — the active note loads automatically and updates live as you edit.
3. Play — click Play (or press your hotkey). Adjust speed with + / −, font size with Aa+ / Aa−.
4. Navigate — click any header in the side panel to jump there. Click the minimap on the right to scrub.
5. Reset — Reset returns to the top.

For 25+ keyboard commands, see Obsidian → Settings → Hotkeys → Teleprompter Plus.

---

Settings overview

---

Stream Deck

55+ actions across 8 categories — Playback, Speed, Font, Navigation, Display, Utility, Countdown, Flip. Real-time bidirectional state sync: the Stream Deck button updates live when you change the teleprompter from any source.

{ "command": "toggle-play" }
{ "command": "set-speed", "value": 3 }
{ "command": "jump-to-header", "value": 1 }

Full action catalog, configuration steps, and Stream Deck plugin setup: docs/stream-deck-actions.md.

---

WebSocket API

A local-only WebSocket server (default ws://127.0.0.1:8765) lets you build custom controls in any language.

const ws = new WebSocket('ws://127.0.0.1:8765')

ws.onopen = () => ws.send(JSON.stringify({ command: 'play' }))

ws.onmessage = (e) => {
  const msg = JSON.parse(e.data as string)
  if (msg.type === 'state') console.log('speed:', msg.data.speed)
}

Full command list, state shape, and integration examples: docs/websocket-api.md.

Privacy — the server binds to 127.0.0.1 only. No LAN or internet exposure by default. The mobile remote piggy-backs on your existing Obsidian session over the same loopback bridge.

---

Text-to-Speech

Three engines, selected automatically based on availability:

1. Kokoro MLX (best quality, Apple Silicon) — 22 voice presets (male/female, American/British English), audio-synced scrolling, sentence-by-sentence highlighting. See docs/tts-setup.md for the one-time Python venv install.
2. macOS say — built-in system voices (Samantha, Daniel, etc.). No setup.
3. Web Speech API — universal fallback. Quality varies by OS and browser engine.

Pause/resume from the toolbar or keyboard. Citations are resolved from your bibliography (Quarto/Pandoc .bib files).

---

Troubleshooting

Most common issues:

Full troubleshooting guide: docs/troubleshooting.md.

---

Architecture

flowchart TB
    subgraph Obsidian["Obsidian App"]
        Plugin["Teleprompter Plus Plugin"]
        View["Teleprompter View"]
        Settings["Settings Manager"]
        Plugin --> View
        Plugin --> Settings
    end

    subgraph Core["Core Components"]
        Svelte["Svelte 5 UI"]
        Markdown["Markdown Renderer"]
        State["State Management"]
        View --> Svelte
        Svelte --> Markdown
        Svelte --> State
    end

    subgraph Server["WebSocket Server"]
        WS["ws://127.0.0.1:8765"]
        Commands["Command Router"]
        Broadcast["State Broadcaster"]
        WS --> Commands
        WS --> Broadcast
    end

    subgraph Clients["External Clients"]
        StreamDeck["Stream Deck (55+)"]
        Mobile["Mobile Remote"]
        Custom["Custom Scripts"]
    end

    Plugin --> WS
    StreamDeck <--> WS
    Mobile <--> WS
    Custom <--> WS
    Broadcast --> StreamDeck
    Broadcast --> Mobile

Design system, component reference, and icon catalog: docs/.

---

Contributing

Pull requests welcome. See CONTRIBUTING.md for the tech stack, project structure, build workflow, code style, and contribution guidelines.

---

Changelog & roadmap

Full version history in CHANGELOG.md. Latest release: see the Releases page.

Have an idea? Open a discussion or submit an issue.

---

Credits & license

Created by Juracy Américo (@JuracyAmerico).

Built with Obsidian, Svelte 5, TypeScript, Vite, Tailwind CSS, marked.js, highlight.js, and ws.

MIT License. Copyright © 2024–2026 Juracy Américo. See LICENSE.

Support

If this plugin saves you time, you can support continued development: