How maxcodl/paperplay works
PaperPlay is a cross-platform music player whose library is sourced from the user’s Telegram chats and bots. Users configure access, scan chats and local folders, then browse and play the resulting library; playback is coordinated by a shared controller and platform-specific engines. Other major branches include metadata and lyrics, recommendations, library management, device sync and network play, backup, and updates. The README documents these capabilities; sampled code confirms selected startup, playback, service, and cover-fetch relationships, so unsampled connections are omitted rather than inferred.
Main entry points: App.kt Compose UI · LibraryRepository.kt Library repository · AppServices.kt App services · Scanner.kt Chat scanning
Components 27
App and UI
- Compose UI
ui/src/commonMain/kotlin/io/max/paperplay/ui/App.kt - Core backend
ui/src/commonMain/kotlin/io/max/paperplay/ui/app/CoreBackend.kt - App services
core/src/commonMain/kotlin/io/max/paperplay/core/app/AppServices.kt
Library and discovery
- Library repository
core/src/commonMain/kotlin/io/max/paperplay/core/app/LibraryRepository.kt - Library model
core/src/commonMain/kotlin/io/max/paperplay/core/library/LibraryRepo.kt - Telegram clients
core/src/commonMain/kotlin/io/max/paperplay/core/telegram/TdClient.kt - Chat scanning
core/src/commonMain/kotlin/io/max/paperplay/core/app/Scanner.kt - Local folders
core/src/commonMain/kotlin/io/max/paperplay/core/app/LocalFolders.kt - Metadata and lyrics
core/src/commonMain/kotlin/io/max/paperplay/core/metadata/SongSearch.kt - Cover service
core/src/commonMain/kotlin/io/max/paperplay/core/app/CoverService.kt - Topics and filing
core/src/commonMain/kotlin/io/max/paperplay/core/filing/Topics.kt - Duplicate cleanup
core/src/commonMain/kotlin/io/max/paperplay/core/dupes/Duplicates.kt
Playback
- Playback controller
core/src/commonMain/kotlin/io/max/paperplay/core/app/PlaybackController.kt - Player engine
player/src/commonMain/kotlin/io/max/paperplay/player/PlayerEngine.kt - Android player
player/src/androidMain/kotlin/io/max/paperplay/player/AndroidPlayerEngine.kt - Desktop player
player/src/jvmMain/kotlin/io/max/paperplay/player/MpvPlayerEngine.kt - USB audio
player/src/androidMain/kotlin/io/max/paperplay/player/usb/UsbAudioManager.kt
Connected features
- Mixes and discovery
core/src/commonMain/kotlin/io/max/paperplay/core/recs - Music integrations
core/src/commonMain/kotlin/io/max/paperplay/core/integrations - Device sync
core/src/commonMain/kotlin/io/max/paperplay/core/sync/LanSync.kt - Network play
core/src/commonMain/kotlin/io/max/paperplay/core/sync/netplay/NetplaySync.kt - Backup and restore
core/src/commonMain/kotlin/io/max/paperplay/core/backup/BackupWriter.kt
Platform services
- Library database
core/src/commonMain/kotlin/io/max/paperplay/core/db/LibrarySchema.kt - Android host
androidApp/src/main/kotlin/io/max/paperplay/compose/MainActivity.kt - Desktop host
desktopApp/src/jvmMain/kotlin/io/max/paperplay/desktop/Main.kt - Update service
core/src/commonMain/kotlin/io/max/paperplay/core/update/UpdateService.kt
Other components
- Listener
Connections 30
- Listener → Compose UI: uses
README.md - Compose UI → Core backend: builds
ui/src/commonMain/kotlin/io/max/paperplay/ui/App.kt - Core backend → App services: creates
ui/src/commonMain/kotlin/io/max/paperplay/ui/App.kt - App services → Library repository: provides
core/src/commonMain/kotlin/io/max/paperplay/core/app/AppServices.kt - App services → Telegram clients: configures
core/src/commonMain/kotlin/io/max/paperplay/core/app/AppServices.kt - Listener → Chat scanning: starts scans
README.md - Chat scanning → Telegram clients: reads chats
README.md - Chat scanning → Library repository: indexes songs
- Listener → Local folders: chooses folders
README.md - Listener → Library repository: browses library
README.md - Library repository → Library model: stores library
core/src/commonMain/kotlin/io/max/paperplay/core/app/LibraryRepository.kt - Library repository → Library database: persists data
- Listener → Metadata and lyrics: searches songs
README.md - Listener → Cover service: views covers
README.md - Cover service → Telegram clients: fetches thumbnails
core/src/commonMain/kotlin/io/max/paperplay/core/app/CoverService.kt - Listener → Topics and filing: manages topics
README.md - Listener → Duplicate cleanup: cleans duplicates
README.md - Compose UI → Playback controller: controls playback
- Playback controller → Player engine: commands
core/src/commonMain/kotlin/io/max/paperplay/core/app/PlaybackController.kt - Player engine → Android player: implemented by
player/src/androidMain/kotlin/io/max/paperplay/player/AndroidPlayerEngine.kt - Player engine → Desktop player: implemented by
player/src/jvmMain/kotlin/io/max/paperplay/player/MpvPlayerEngine.kt - Listener → USB audio: enables bit-perfect
README.md - Listener → Mixes and discovery: explores mixes
README.md - Listener → Music integrations: imports and enriches
README.md - Listener → Device sync: syncs devices
README.md - Listener → Network play: joins session
README.md - Listener → Backup and restore: backs up library
README.md - Android host → Compose UI: hosts
androidApp/src/main/kotlin/io/max/paperplay/compose/MainActivity.kt - Desktop host → Compose UI: hosts
desktopApp/src/jvmMain/kotlin/io/max/paperplay/desktop/Main.kt - Listener → Update service: checks updates
README.md