Skip to content
/ ReaMD Public

Dockable Markdown Viewer for REAPER DAW with scenario linking, teleprompter mode, and AI-powered text formatting. Perfect for voiceover scripts, production notes, and audio post-production workflows.

License

Notifications You must be signed in to change notification settings

b451c/ReaMD

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ReaMD - Markdown Viewer for REAPER

ReaMD

Dockable Markdown Viewer for REAPER DAW
Scenario linking, teleprompter mode, and AI-powered text formatting

FeaturesInstallationUsageAI ParseScreenshotsLicense

REAPER 7.0+ ReaImGui 0.10+ Cross-platform License Release

Note

Tested on macOS Tahoe 26.2. Windows and Linux support is expected but not yet verified. Contributions and feedback from other platforms are welcome!


What is ReaMD?

ReaMD is a dockable markdown viewer designed specifically for audio production workflows in REAPER. It bridges the gap between your scripts, notes, and the timeline - allowing you to link text fragments directly to items on your tracks.

Perfect for:

  • Voiceover production - Link script lines to VO recordings
  • Audio post-production - Sync scene descriptions with sound design
  • Podcast editing - Follow show notes while editing
  • Music production - Keep lyrics and arrangement notes in view

Features

Core Markdown Support

  • Full markdown rendering (headers, lists, tables, code blocks, blockquotes)
  • Edit mode - Write and modify markdown directly in REAPER
  • Dark & Light themes - Seamlessly match your REAPER theme
  • Dockable window - Integrate into your workflow

Scenario Linking

  • Link text fragments to timeline items - Click a paragraph, jump to the item
  • Multi-item support - One fragment can reference multiple items
  • Category colors - V (Voiceover), M (Music), F (FX), O (Other)
  • Group awareness - REAPER item groups treated as single units
  • Visual feedback - Linked fragments highlighted, playback position tracked

Teleprompter Mode

  • VO-focused display - Shows only voiceover text, large and centered
  • Auto-scroll - Follows playback position automatically
  • Progress indicator - Orange (next cue) / Green (current item ending)
  • Semi-transparent overlay - 50% opacity, stays out of the way

AI Parse (Claude Integration)

  • Paste unformatted text - Meeting notes, raw scripts, brain dumps
  • AI formats to markdown - Clean structure with proper headings and lists
  • Customizable prompt - Tailor the AI behavior to your workflow
  • Non-blocking - Async processing, UI stays responsive

Installation

Requirements

Component Version Required
REAPER 7.0+ Yes
ReaImGui 0.10+ Yes
js_ReaScriptAPI Latest Recommended
SWS Extension Latest Recommended

Method 1: ReaPack (Recommended)

  1. Add ReaMD repository to ReaPack:

    • Open REAPER → Extensions → ReaPack → Import repositories...
    • Paste: https://github.com/b451c/ReaMD/raw/main/index.xml
    • Click OK
  2. Install ReaMD:

    • Extensions → ReaPack → Browse packages
    • Search for "ReaMD" → Right-click → Install
    • Apply and restart REAPER
  3. Run:

    • Actions → Show action list
    • Search for "ReaMD"
    • Double-click to run (or assign shortcut)

Method 2: Manual Install

  1. Download the latest release or clone:

    git clone https://github.com/b451c/ReaMD.git
  2. Copy to REAPER Scripts folder:

    Windows: %APPDATA%\REAPER\Scripts\ReaMD\
    macOS:   ~/Library/Application Support/REAPER/Scripts/ReaMD/
    Linux:   ~/.config/REAPER/Scripts/ReaMD/
    
  3. Load the script:

    • REAPER → Actions → Load ReaScript
    • Select Main/ReaMD.lua

Tip: For full functionality, install ReaImGui, js_ReaScriptAPI, and SWS Extension.


Usage

Basic Workflow

  1. Open a markdown file - Click "Open..." or drag & drop
  2. Dock the window - Right-click title bar → Dock
  3. Browse your script - Scroll, search, navigate headings

Scenario Linking

  1. Enter Scenario Mode - Toggle "Scenario" in toolbar
  2. Select items on timeline - The items you want to link
  3. Click [+] on a text fragment - Links selected items to that text
  4. Click linked text - Jumps to and selects the items
  5. Play - Text highlights follow playback position

Scenario Linking Demo

Teleprompter

  1. Set up scenario links - At least link your VO items
  2. Click "Teleprompter" - Opens focused display window
  3. Start playback - Text auto-scrolls with timeline

Teleprompter Demo


AI Parse

Transform unstructured text into clean markdown using Claude AI.

Setup

  1. Get an API key from Anthropic Console
  2. In ReaMD, open Settings (gear icon)
  3. Paste your API key in the "AI Parser Settings" section

Usage

  1. Click New → AI Parse...
  2. Paste your unformatted text
  3. Click Parse with AI
  4. Review the result → Save As...

Customize the Prompt

Click Edit Prompt in settings to modify prompts/ai_format_prompt.txt. Tailor it for your specific use case (voiceover scripts, technical docs, meeting notes, etc.).

AI Parse Demo

Note: AI Parse requires an internet connection and uses the Claude Haiku model for fast, cost-effective processing.


Screenshots

Dark & Light Themes

Dark and Light Themes

Settings Panel

Settings

AI Parse Window

AI Parse Window


File Structure

ReaMD/
├── Main/
│   └── ReaMD.lua           # Main script (run this)
├── Libs/
│   ├── ai_parser.lua       # AI integration module
│   ├── config.lua          # Settings management
│   ├── json.lua            # JSON encoder/decoder
│   ├── md_parser.lua       # Markdown parser
│   ├── md_renderer.lua     # ReaImGui renderer
│   ├── scenario_engine.lua # Timeline linking engine
│   ├── teleprompter.lua    # Teleprompter mode
│   └── utils.lua           # Utility functions
└── prompts/
    └── ai_format_prompt.txt # Customizable AI prompt

Troubleshooting

"ReaImGui not found"

Install ReaImGui via ReaPack: Extensions → ReaPack → Browse packages → Search "ReaImGui"

AI Parse not working

  • Verify your API key is correct in Settings
  • Check internet connection
  • On Windows, ensure curl is available (comes with Windows 10+)

Teleprompter not following playback

  • Ensure scenario links are set up (fragments linked to timeline items)
  • Check that linked items exist on the timeline

Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.


Acknowledgments

  • ReaImGui by cfillion - Amazing ImGui bindings for REAPER
  • REAPER by Cockos - The best DAW for scripting
  • Anthropic - Claude AI for text formatting

Made with ❤️ for the REAPER community

Buy Me a Coffee

About

Dockable Markdown Viewer for REAPER DAW with scenario linking, teleprompter mode, and AI-powered text formatting. Perfect for voiceover scripts, production notes, and audio post-production workflows.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages