Documentation

Quickstart

Write a script, open a room and drive it from your phone, in about three minutes.

Before you start

You need two things: a Google or GitHub account, and two devices you can sign into with it. That is the entire pairing model: a room is the set of devices signed in as you, so there is no invite to send and no link to leak.

The two devices do not have to be on the same network. Same Wi-Fi gives the lowest latency and the best chance of a direct peer-to-peer route, but a phone on mobile data and a laptop on venue Wi-Fi will pair perfectly well.

1. Write something

Sign in and press New script. If it is your first one, Teleprompt seeds a short sample that walks through this same process while you read it.

The editor is Markdown. Four pieces of syntax do most of the work:

  • ## Section splits the script into parts.
  • - bullet gives you one beat per line, which is what a remote steps through.
  • :: cue is a note to yourself, shown in orange on the prompter, never counted as a spoken word.
  • --- draws a hard break.

Saving is automatic. The sidebar counts your words and tells you how long the script runs at 130 words per minute, which is a comfortable spoken pace rather than a silent-reading one.

2. Open a room

Press Start a session. Teleprompt takes a snapshot of the script, opens a room and gives you a six-character join code such as K7M-2QF.

On the room page, choose Use this device as the display. That screen goes full width, holds a screen wake lock so it will not dim, and starts listening for a remote.

Why a snapshot

A room holds a copy of the script rather than a live reference, because both devices have to render byte-identical text for their block indices to line up. Keeping that copy current is the app’s job: edit the script and every device in the room picks the change up within a few seconds, carrying your reading position across rather than resetting it.

3. Pair the second device

On your phone, open Teleprompt and sign in to the same account. Either provider works, as long as the verified email address matches. Go to Join a room, type the code, and choose Be the remote.

The two devices find each other within a second or so. The badge in the header tells you which path they found:

  • Direct: a WebRTC data channel straight between the devices. Nothing sits in between.
  • Relay: no direct route was possible, so messages go through the realtime relay. Everything still works.

4. Read

Press play on the phone. The display starts scrolling, and the phone shows you the same words moving at the same rate, laid out for a phone, not shrunk down from the display.

While you are reading, the remote can:

  • Change the pace, in words per minute, without stopping.
  • Step to the previous or next block.
  • Tap any visible line to jump the display straight to it.
  • Drag the text to scrub, exactly like a scroll wheel.
  • Change type size, mirroring and the reading surface on the display, from your hand.

Where to go next