pyLyricFlow/docs/lyricflow.md
2026-02-24 13:22:10 -06:00

51 lines
2.0 KiB
Markdown

# 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
- [x] Phonetic extraction from CMUDict.
- [x] Perfect and Slant rhyme detection logic.
- [x] Mosaic rhyme identification.
- [x] WordNet-based "Vibe" suggestion system.
### ✅ Phase 2: Editor Experience
- [x] Basic text editor with debounced analysis.
- [x] Color-coded rhyme group highlighting.
- [x] Live syllable counts in margins.
### ✅ Phase 3: IDE Layout & Workflow
- [x] VS Code-style three-pane splitter layout.
- [x] Multi-tabbed editor support.
- [x] Project Explorer with right-click file operations.
- [x] `.lyricproject` session persistence (recovery of open tabs).
### ✅ Phase 4: LyricDown Syntax
- [x] Custom syntax highlighting (Headers, Metadata, Comments).
- [x] Context-aware analysis (filtering out non-lyric elements).
- [x] 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.