Compare commits

...

1 Commits

Author SHA1 Message Date
ef1935c5cf Update README with current features
- Add media browser, scripts, callbacks to top-level features
- Document vinyl record mode, accent color picker, light theme
- Document mini player, tab navigation
- Document browser view modes, search, pagination, play all, download
- Mention Web UI script/callback management (CRUD)
- Update platform and authentication details

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-02-25 01:59:12 +03:00

View File

@@ -5,14 +5,19 @@ A REST API server for controlling system media playback on Windows, Linux, macOS
## Features
- **Built-in Web UI** for real-time media control and monitoring
- **Media Browser** - Browse and play media files from configured folders
- **Quick Actions & Scripts** - Execute custom scripts with one click
- **Callbacks** - Trigger commands on media events (play, pause, volume, etc.)
- Control any media player via system-wide media transport controls
- Play/Pause/Stop/Next/Previous track
- Volume control and mute
- Seek within tracks
- Get current track info (title, artist, album, artwork)
- WebSocket support for real-time updates
- Token-based authentication
- Cross-platform support
- Token-based authentication with multi-token support
- Dark/light theme with customizable accent colors
- Multi-language support (English, Russian)
- Cross-platform support (Windows, Linux, macOS, Android)
## Web UI
@@ -23,14 +28,18 @@ The media server includes a built-in web interface for controlling and monitorin
### Features
- **Real-time status updates** via WebSocket connection
- **Album artwork display** with automatic updates
- **Album artwork display** with glow effect and automatic updates
- **Vinyl record mode** - Album art displayed as a spinning vinyl disc with grooves and center spindle
- **Playback controls** - Play, pause, next, previous
- **Volume control** with mute toggle
- **Seekable progress bar** - Click to jump to any position
- **Mini player** - Sticky compact player that appears when scrolling away from the main player
- **Connection status indicator** - Know when you're connected
- **Token authentication** - Saved in browser localStorage
- **Responsive design** - Works on desktop and mobile
- **Dark theme** - Easy on the eyes
- **Dark and light themes** - Toggle between dark and light modes
- **Accent color picker** - Choose from 9 preset accent colors (green, blue, purple, pink, orange, red, teal, cyan, yellow)
- **Tab-based navigation** - Player, Browser, Quick Actions, Scripts, and Callbacks tabs
- **Multi-language support** - English and Russian locales with automatic detection
### Accessing the Web UI
@@ -101,11 +110,15 @@ The Media Browser feature allows you to browse and play media files from configu
- **Folder Configuration** - Mount multiple media folders (music/video directories)
- **Recursive Navigation** - Browse through folder hierarchies with breadcrumb navigation
- **Thumbnail Display** - Automatically generated thumbnails from album art
- **Metadata Extraction** - View title, artist, album, duration, bitrate, and more
- **Multiple View Modes** - Grid, compact grid, and list views with toggle buttons
- **Thumbnail Display** - Automatically generated thumbnails from album art (lazy-loaded)
- **Metadata Extraction** - View title, artist, album, duration, bitrate, file size, and more
- **Remote Playback** - Play files on the PC running the media server (not in the browser)
- **Play All** - Play all media files in the current folder
- **File Download** - Download individual media files directly from the browser
- **Search & Filter** - Real-time search across files in the current folder
- **Pagination** - Navigate large folders with configurable page sizes (25, 50, 100, 200, 500)
- **Last Path Memory** - Automatically returns to your last browsed location
- **Lazy Loading** - Thumbnails load only when visible for better performance
### Configuration
@@ -379,7 +392,7 @@ All control endpoints require authentication and return `{"success": true}` on s
### Script Execution
The server supports executing pre-defined scripts via API.
The server supports executing pre-defined scripts via API and the Web UI. Scripts and callbacks can be managed directly from the Web UI — add, edit, delete, and execute with real-time output display.
![Script and Callback Management](docs/scripts-management.PNG)