How rinkio-lab/lyricex works
LyricEx is a static, browser-based Japanese lyric study and karaoke tool. The main workflow is to load a lyric pack or LRC, view and study timed lyrics, then use the editor to build or modify a pack and export it. Other documented capabilities include AI-assisted word analysis, audio controls and effects, sharing, settings backup, and offline PWA use. The README documents these product flows, but the application modules themselves were not excerpted, so edges describe documented behavior rather than verified source-level calls.
Main entry points: app.js App bootstrap · workspace.js Pack builder · editor.js Editor UI · ai-import.js Word analysis import
Components 24
Application and views
- App bootstrap
assets/scripts/app.js - Workspace UI
assets/scripts/ui/workspace.js - Editor UI
assets/scripts/ui/editor.js - Settings UI
assets/scripts/ui/settings.js - Dialogs
assets/scripts/ui/dialog.js
Lyrics and study
- Lyrics view
assets/scripts/app.js - Study view
assets/scripts/app.js - Mixed view
assets/scripts/app.js - Lyrics and package helpers
assets/scripts/lib.js - Word analysis import
assets/scripts/utils/ai-import.js - AI prompt
assets/scripts/utils/ai-prompt.js
Pack editing
- Pack builder
assets/scripts/ui/workspace.js - Lyric package export
assets/scripts/utils/lyric-package.js
Audio and sharing
- Audio graph
assets/scripts/modules/audio-graph.js - Pitch shift
assets/scripts/modules/pitch-shift.js - Video export
assets/scripts/modules/video.js - Share tools
assets/scripts/ui/share.js
Storage and offline
- Library UI
assets/scripts/library/library-ui.js - Library database
assets/scripts/library/library-db.js - Recent store
assets/scripts/modules/recent-store.js - Offline service worker
sw.js - Service worker registration
assets/scripts/sw-register.js
Other components
- User
- External LLM
Connections 20
- User → App bootstrap: opens tool
README.md - User → Lyrics and package helpers: uploads pack or LRC
README.md - App bootstrap → Lyrics view: shows lyrics
README.md - App bootstrap → Study view: shows study
README.md - App bootstrap → Mixed view: shows mixed view
README.md - User → Editor UI: opens editor
README.md - Editor UI → Pack builder: opens build tab
README.md - Pack builder → Lyric package export: exports pack
README.md - Pack builder → Lyrics and package helpers: imports LRC
README.md - AI prompt → External LLM: copies prompt
README.md - External LLM → Word analysis import: returns JSON
README.md - Word analysis import → Pack builder: adds analysis
README.md - User → Audio graph: plays local audio
README.md - User → Settings UI: backs up settings
README.md - User → Share tools: creates share card
README.md - User → Library UI: uses library
- Library UI → Library database: persists library
- App bootstrap → Service worker registration: enables offline install
README.md - Service worker registration → Offline service worker: registers worker
- Offline service worker → User: serves cached app
sw.js