Script Writing & Breakdown Library

An advanced, React and Next.js-based script writing and breakdown analysis library for the web.

This package provides developers with an intuitive suite of tools to draft, edit, and format scripts according to industry standards, alongside powerful script breakdown utilities to highlight, tag, and analyze scene elements.

Features

• Screenplay Editor Component: Fully-featured WYSIWYG editor for screenplays.
• Industry-Standard Formatting: Automatically formats text to screenplay guidelines including Scene Headings, Action, Character, Parenthetical, Dialogue, and Transitions.
• Smart Auto-Suggestions: Intelligently suggests previously used Characters, Locations, and Character Extensions (like V.O., O.S.) as you type.
• PDF Import & Export: Built-in tools to import and parse existing scripts from PDFs (pdfjs-dist) and export your drafts into perfectly formatted screenplay PDFs (jsPDF).
• Scene Management: Easily toggle Scene Types (INT./EXT.) and Time of Day (DAY/NIGHT) alongside Scene Numbering features.
• Script Breakdown & Tagging: Interactive scene viewer with auto-character tagging, text selection, and customizable element tagging (e.g., Cast, Props, Wardrobe).
• Keyboard Shortcuts: Fluid writing experience using keyboard shortcuts (e.g., Ctrl + ↑/↓ to change block types, Enter to create new blocks).
• Headless Architecture: Core logic is exposed via hooks (useScreenplayEditor and useScriptBreakdownScene), allowing complete customizability over the UI.

Installation

Install the package via npm or yarn:

npm install @vishu1301/script-writing