Documentation / 01
Lyricscroll Docs
Welcome to the full documentation for Lyricscroll, the ultimate mobile-first web application designed for musicians, worship leaders, and singers.
1. Library Management
The Library is where all your songs live. Songs are stored locally on your device for offline use and can be synced to the cloud.
How to Add a New Song
UI Involved: Bottom Navigation (Songs Tab), Floating Action Button (FAB) +, Action Sheet.
1. Navigate to the Library: Tap the Songs icon on the Bottom Navigation bar.
2. Open Add Menu: Tap the floating + button located at the bottom right.
3. Choose an Import Method: An action sheet will slide up with three options: - Search Online: Search by title/artist to automatically fetch lyrics from the web. - Import from Link: Paste a direct URL or raw lyrics text. - Create Manually: Open a blank editor to type or paste your own lyrics.
4. Save: Once you are satisfied with the song's content, tap the Save button. The song will instantly appear in your Library, categorized alphabetically.
Add New Song
Search Online
Auto-fetch lyrics from web
Import from Link
Paste URL or raw text
Create Manually
Type or paste your own lyrics
How to Manage Existing Songs
UI Involved: Top Search Bar, Song Cards, Alphabet Scroller.
- Search: Use the Search Bar at the top of the Library to quickly find a song by title or artist.
- Favorite: Tap the Heart/Star Icon on any Song Card to add it to your favorites.
- Edit: Tap directly on a Song Card to open the Song View Sheet, then tap the Edit button to modify lyrics or details.
- Delete: Long-press any Song Card to trigger the delete confirmation modal.
Amazing Grace
John Newton
Build My Life
Housefires
2. Flows (Setlists) Builder
A Flow is a setlist built for a specific performance. It allows you to queue sections of songs exactly as you plan to play them.
How to Create a New Flow
UI Involved: Bottom Navigation (Flow Tab), Split-Screen Builder, Add Buttons.
1. Navigate to Flows: Tap the Flow icon on the Bottom Navigation bar.
2. Start Building: If your current flow is empty, tap the Add New button. If you have an existing flow, tap Add More.
3. Select a Song: The bottom half of the screen will open the Step Builder Drawer showing your Library. Tap on a song you want to include.
4. Add Sections: The drawer will now display the sections of that song (e.g., Verse 1, Chorus, Bridge). Tap the specific sections you want to add.
5. Watch the Preview: As you tap, you'll see the sections appear as cards in the Horizontal Flow Preview on the top half of the screen.
6. Return to Library: Tap the Back to Songs arrow in the drawer to pick another song and add its sections.
Amazing Grace
Verse 1
Amazing Grace
Chorus
Amazing Grace
How to Edit and Save a Flow
UI Involved: Horizontal Flow Preview, Action Buttons.
- Reorder: Long-press and drag the section cards in the top Horizontal Flow Preview to rearrange your setlist.
- Save Flow: Once your Flow is ready, tap the Save Flow button. Enter a name (e.g., "Sunday Morning Service") to save it for later use.
- Load Flow: Tap Load Flow to pull up a previously saved setlist.
3. Live Mode
Live Mode is the core performance view. It removes distractions, maximizes text size, and provides smooth auto-scrolling.
How to Start Live Mode
UI Involved: Flow Screen "Go Live" Button.
1. Build or load a Flow in the Flow tab.
2. Tap the primary Go Live button at the bottom of the top preview section.
3. The app will enter full-screen mode and display the first lyrics section in large, readable text.
Amazing grace
How sweet the sound
That saved a wretch
like me
How to Control Playback
UI Involved: Hidden Overlay Controls, Touch Gestures.
- Toggle Controls: Tap anywhere on the center of the screen once to reveal (or hide) the hidden control overlay.
- Auto-scroll: If auto-scroll is enabled, the lyrics will begin scrolling automatically.
- Pause/Resume: Long-press anywhere on the screen to temporarily pause the auto-scroll (e.g., if the band extends a bridge). Release your finger to resume.
- Manual Navigation: Swipe up or down to manually scroll through the lyrics. The system will track your position.
Amazing grace
How sweet the sound
That saved a wretch
like me
4. Live Synchronization (SyncHost/SyncJoin)
For bands wanting to stay on the same page, Lyricscroll supports Live Sync. One device acts as the Host, and others follow.
How to Host a Session
1. In Live Mode, open the controls overlay and tap the Sync Icon.
2. Select Host Session.
3. A QR code or a join link will be displayed on your screen.
Host Session
Scan this code to join the live sync session.
How to Join a Session
1. On a secondary device, navigate to the Home screen or Live mode.
2. Choose Join Session.
3. Scan the Host's QR code or enter the session ID.
4. Your device will now automatically scroll and follow the Host's screen in real-time.