📱 VlogPrompter
A lightweight, privacy-first iOS teleprompter built for vloggers, content creators, and presenters. Type, paste, import documents, snap photos, or scan paper — and let the prompter scroll your script while you record.
English | 简体中文
✨ Features
📝 Multi-source script input
- Manual typing & pasting — distraction-free editor
- File import —
.txt, .md, .rtf, .docx (legacy .doc not supported by iOS, save as .docx first)
- Photo OCR — pick an image from Photos and extract text via Apple Vision
- Camera OCR — point, shoot, and the text on the page becomes your script
- Document Scanner — multi-page scanning with auto edge detection and perspective correction (powered by VisionKit)
🎬 Full-screen teleprompter
- Adjustable scroll speed (10 – 160 px/s)
- Adjustable font size (16 – 64 pt)
- Mirror mode for use with reflective teleprompter rigs
- Landscape / portrait toggle — force-rotate without unlocking system rotation lock
- Light / dark mode one-tap switch
- Reading guideline — a red baseline marks where you should be looking
- Play / pause / restart / skip-to-end controls
- Screen-stays-on automatically while recording
- Manual scrubbing — drag to reposition while paused
🌏 Language support
OCR recognizes Simplified Chinese, Traditional Chinese, and English out of the box (configurable in OCRService.swift).
🔒 Privacy
- 100% on-device — no network calls, no analytics, no telemetry
- All scripts stored in the app's local Documents directory as JSON
- Camera, Photos, and OCR all powered by Apple Vision frameworks running locally
📷 Screenshots
| Script list |
Editor + import toolbar |
Teleprompter playback |
| coming soon |
coming soon |
coming soon |
🏗️ Architecture
VlogPrompter/
├── VlogPrompter.xcodeproj/
└── VlogPrompter/
├── VlogPrompterApp.swift # @main app entry, injects ScriptStore
├── Info.plist # Permissions, orientations, launch screen
├── Models/
│ ├── Script.swift # Codable script model
│ └── ScriptStore.swift # @MainActor ObservableObject, JSON persistence
├── Views/
│ ├── ContentView.swift # Script list with swipe-to-delete
│ ├── ScriptEditorView.swift # Title + content editor + bottom import toolbar
│ └── TeleprompterView.swift # Full-screen scrolling prompter with controls
├── Services/
│ ├── DocumentImporter.swift # TXT / RTF / DOCX parsing
│ ├── OCRService.swift # Vision-based text recognition
│ ├── DocumentScannerView.swift # VisionKit document scanner wrapper
│ └── CameraPicker.swift # UIImagePickerController for live camera
├── Assets.xcassets/ # AppIcon, AccentColor
└── Preview Content/
Tech stack
| Layer |
Technology |
| UI |
SwiftUI (iOS 17 minimum) |
| Persistence |
Codable + JSONEncoder to local Documents directory |
| OCR |
Vision.VNRecognizeTextRequest (accurate level, language correction) |
| Document scanning |
VisionKit.VNDocumentCameraViewController |
| Photo picker |
PhotosUI.PhotosPicker |
| File picker |
UniformTypeIdentifiers + SwiftUI .fileImporter |
| DOCX parsing |
Custom — minimal ZIP reader + Compression.compression_decode_buffer (zlib inflate) + regex extraction of <w:p> / <w:t> / <w:tab> / <w:br> |
| Forced rotation |
UIWindowScene.requestGeometryUpdate(.iOS(interfaceOrientations:)) (iOS 16+) |
Notable design decisions
- Zero third-party dependencies. No CocoaPods, no SwiftPM packages. Everything is built on Apple frameworks already shipped with iOS.
- Custom DOCX parser.
NSAttributedString.DocumentType.officeOpenXML exists on macOS but not iOS. Rather than pull in a 1-MB Office library, the project ships a ~150-line minimal ZIP-reader + zlib inflate using the system Compression framework, then runs lightweight regex over word/document.xml. Handles ~99% of real-world Word exports.
- Hand-written
Info.plist. Xcode's auto-generated plist double-nests UILaunchScreen on iOS 26, breaking installation via devicectl. The project uses an explicit plist to avoid this.
🚀 Installation (Run on your own iPhone)
Requirements
- macOS with Xcode 15 or later
- iPhone running iOS 17 or later
- A free Apple ID (paid Apple Developer Program is not required)
Steps
-
Clone the repo
git clone https://github.com/<your-username>/VlogPrompter.git
cd VlogPrompter
-
Open the project
open VlogPrompter.xcodeproj
-
Sign in to Xcode
- Xcode → Settings… → Accounts →
+ → Apple ID
- Use a free Apple ID; no paid developer enrollment needed
-
Select your Team
- Click the blue
VlogPrompter project icon in the left sidebar
- TARGETS → VlogPrompter → Signing & Capabilities
- Set Team to your
Personal Team
- If
com.carey.vlogprompter collides with someone else's, change Bundle Identifier to a unique value (e.g. com.<yourname>.vlogprompter)
-
Plug in your iPhone, tap Trust This Computer when prompted
-
Run — press ⌘R in Xcode (or pick your device from the run destination)
-
Trust the developer certificate on iPhone
- Settings → General → VPN & Device Management
- Tap your Apple ID under Developer App → Trust "..."
- Open the app from the Home Screen ✅
Free Apple ID certificates expire every 7 days. Just hit ⌘R again when that happens — the cert auto-renews.
Command-line install (advanced)
If you have signing already configured:
# Build (Release config, signs automatically)
xcodebuild -project VlogPrompter.xcodeproj \
-scheme VlogPrompter \
-configuration Release \
-destination 'generic/platform=iOS' \
-derivedDataPath ./build \
-allowProvisioningUpdates \
-allowProvisioningDeviceRegistration \
build
# Install onto a connected device (note: copy to /tmp first to avoid sandbox issues)
cp -R ./build/Build/Products/Release-iphoneos/VlogPrompter.app /tmp/
xcrun devicectl device install app --device <DEVICE_UDID> /tmp/VlogPrompter.app
Get your device UDID with:
xcrun devicectl list devices
📖 Usage Guide
Creating a script
- Tap + in the top-right of the script list
- Enter a title (optional — defaults to the filename when importing)
- Type, paste, or use the bottom toolbar to import:
| Icon |
Source |
| 📄 File |
TXT / MD / RTF / DOCX from Files app or iCloud Drive |
| 🖼️ Photo |
Pick an image from Photos → automatic OCR |
| 📷 Camera |
Take a photo of a printed page → automatic OCR |
| 📑 Scan |
Multi-page document scanner → OCR all pages and concatenate |
Imported text is appended to the current script (with a blank line separator).
Playing the prompter
- Tap the ▶︎ Play icon in the editor's top-right toolbar
- The script enters full-screen scrolling mode
- Tap anywhere to toggle controls (auto-hide after 4 s)
- Bottom slider controls scroll speed and font size
- Top-right buttons:
- 🔁 Rotate — toggle between landscape and portrait
- ☀️/🌙 — light / dark theme
- ⇄ — mirror text horizontally
- Center bottom: ▶︎ / ⏸ play / pause, ⟲ restart, ⏭ skip to end
- Drag vertically while paused to scrub through the script
Importing tips
- For best OCR results, ensure good lighting and flat pages
- Multi-column layouts may produce interleaved lines — clean them up in the editor afterward
- Old
.doc files: open in Word/Pages on your computer, Save As .docx, then import
🛣️ Roadmap
- Side-by-side recording (camera preview + prompter overlay) using
AVCaptureSession
- Speech-recognition auto-scroll — track your voice with
SFSpeechRecognizer and advance the prompter to match
- iCloud sync of scripts via
NSUbiquitousKeyValueStore or CloudKit
- Export script as
.txt for sharing
- Variable line spacing and custom fonts
- Bluetooth foot pedal support for hands-free pause/resume
Contributions and PRs welcome!
🤝 Contributing
- Fork the repository
- Create your feature branch (
git checkout -b feature/awesome-thing)
- Commit your changes (
git commit -m 'Add awesome thing')
- Push to the branch (
git push origin feature/awesome-thing)
- Open a Pull Request
Please keep pull requests focused and small, and run the project on a real device before submitting.
🙋 FAQ
Q: Does it work offline?
A: Yes — every feature runs fully on-device, including OCR.
Q: Why is .doc not supported?
A: iOS doesn't ship a parser for the legacy binary OLE Word format. .docx (the modern XML-based format) is fully supported via a built-in ZIP+inflate pipeline.
Q: My free certificate expired and the app won't open.
A: That's normal — connect your iPhone to your Mac, open the project in Xcode, and hit ⌘R. The certificate auto-renews for another 7 days.
Q: Can I publish this to the App Store?
A: You can — you'd need a paid Apple Developer Program membership ($99/year), then archive a Release build and upload via Xcode.
Q: Is there an Android version?
A: No, this is an Apple Vision / VisionKit / SwiftUI native app and won't port directly. PRs welcome if you want to start a sister project.
📜 License
MIT License — see LICENSE for details.
Built with ☕ and SwiftUI.