pyLyricFlow/docs/lyricflow.md

LyricFlow IDE Roadmap

Project Overview

A professional songwriting environment providing real-time rhyme density visualization and phonetic analysis for songwriters and poets.

Core Goals

• Phonetic Highlighting: Use CMUDict to highlight perfect and near rhymes.
• IDE Experience: Tabbed editing, project explorer, and session persistence.
• LyricDown Syntax: A proprietary syntax for structured lyric drafting.
• Offline First: No cloud dependency; all analysis performed locally.

Technology Stack

• Base: Python 3.14+
• UI Framework: PyQt6
• Linguistic Engine: NLTK (WordNet, CMUDict)
• Styles: Custom Dracula-inspired CSS

Project Status: Active Development

✅ Phase 1: Core Engine

• Phonetic extraction from CMUDict.
• Perfect and Slant rhyme detection logic.
• Mosaic rhyme identification.
• WordNet-based "Vibe" suggestion system.

✅ Phase 2: Editor Experience

• Basic text editor with debounced analysis.
• Color-coded rhyme group highlighting.
• Live syllable counts in margins.

✅ Phase 3: IDE Layout & Workflow

• VS Code-style three-pane splitter layout.
• Multi-tabbed editor support.
• Project Explorer with right-click file operations.
• .lyricproject session persistence (recovery of open tabs).

✅ Phase 4: LyricDown Syntax

• Custom syntax highlighting (Headers, Metadata, Comments).
• Context-aware analysis (filtering out non-lyric elements).
• Integration of structural tags [...].

🚀 Upcoming Features (Next Steps)

• Near-Rhyme Sensitivity: A slider to adjust the strictness of slant rhymes.
• Density Mapping: Visual representation of phonetic density throughout a verse.
• BPM/Metronome: Integrated metronome for rhythmic drafting.
• Selection Analysis: Perform rhyme check strictly on a selected block of text.
• Binary Builds: Standalone executables for Windows and Linux.