diff options
| author | salmonik <raisersoft@proton.me> | 2026-05-18 21:46:26 +0200 |
|---|---|---|
| committer | salmonik <raisersoft@proton.me> | 2026-05-18 21:46:26 +0200 |
| commit | 6cceb3cbfacb6f4416e49321a9b63b4ce7a9f036 (patch) | |
| tree | 9d883ada0e6cfb4fd533635885dfb4459f200128 /README.md | |
| parent | first public release. (diff) | |
| download | rsplayer-6cceb3cbfacb6f4416e49321a9b63b4ce7a9f036.tar.gz rsplayer-6cceb3cbfacb6f4416e49321a9b63b4ce7a9f036.zip | |
fix for new symphony API and less debug info in release
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 66 |
1 files changed, 33 insertions, 33 deletions
| @@ -7,47 +7,47 @@ cd RSPlayer | |||
| 7 | ./install.sh | 7 | ./install.sh |
| 8 | ``` | 8 | ``` |
| 9 | 9 | ||
| 10 | install.sh will: | 10 | install.sh will: |
| 11 | compile RSP (make sure you have rust properly installed!) | 11 | - compile RSP (make sure you have rust properly installed!) |
| 12 | install shell autocompletions (zsh, bash and fish supported) | 12 | - install shell autocompletions (zsh, bash and fish supported) |
| 13 | install user systemd service and activate it | 13 | - install user systemd service and activate it |
| 14 | 14 | ||
| 15 | ## Usage | 15 | ## Usage |
| 16 | 16 | ||
| 17 | configuration is generated at startup in $XDG_CONFIG_HOME/rsplayer/config.toml | 17 | configuration is generated at startup in $XDG_CONFIG_HOME/rsplayer/config.toml |
| 18 | most important values there are: | 18 | - most important values there are: |
| 19 | listenbrainz_token (last.fm scrobbling not yet tested) | 19 | - listenbrainz_token (last.fm scrobbling not yet tested) |
| 20 | display_format (supports $ARTIST $ALBUM and $TRACK) | 20 | - display_format (supports $ARTIST $ALBUM and $TRACK) |
| 21 | music_paths (for DB usage, still WIP) | 21 | - music_paths (for DB usage, still WIP) |
| 22 | scan_interval (same as above) | 22 | - scan_interval (same as above) |
| 23 | 23 | ||
| 24 | all other values can be changed in runtime using commands | 24 | all other values can be changed in runtime using commands |
| 25 | 25 | ||
| 26 | as for commands: | 26 | as for commands: |
| 27 | RSP will be installed as rsp, in this fragment, rsp will be ommited | 27 | RSP will be installed as rsp, in this fragment, rsp will be ommited |
| 28 | 28 | ||
| 29 | these commands should only be used in testing or by systemd service: | 29 | these commands should only be used in testing or by systemd service: |
| 30 | `start-daemon` Start the daemon | 30 | - `start-daemon` Start the daemon |
| 31 | `stop-daemon` Stop the daemon | 31 | - `stop-daemon` Stop the daemon |
| 32 | `restart` Restart the daemon (kill existing and start new) | 32 | - `restart` Restart the daemon (kill existing and start new) |
| 33 | 33 | ||
| 34 | these are normal commands: | 34 | these are normal commands: |
| 35 | `play` Play a track, album, or artist | 35 | - `play` Play a track, album, or artist |
| 36 | `pause` Pause playback | 36 | - `pause` Pause playback |
| 37 | `resume` Resume playback | 37 | - `resume` Resume playback |
| 38 | `toggle` Toggle play/pause | 38 | - `toggle` Toggle play/pause |
| 39 | `stop` Stop playback | 39 | - `stop` Stop playback |
| 40 | `next` Skip to next track | 40 | - `next` Skip to next track |
| 41 | `previous` Skip to previous track | 41 | - `previous` Skip to previous track |
| 42 | `volume` Set volume (0-100) | 42 | - `volume` Set volume (0-100) |
| 43 | `shuffle` Shuffle mode | 43 | - `shuffle` Shuffle mode |
| 44 | `queue` Queue management | 44 | - `queue` Queue management |
| 45 | `status` Show player status | 45 | - `status` Show player status |
| 46 | `scan` Scan music paths to populate database | 46 | - `scan` Scan music paths to populate database |
| 47 | `settings` Settings management | 47 | - `settings` Settings management |
| 48 | `help` Print this message or the help of the given subcommand(s) | 48 | - `help` Print this message or the help of the given subcommand(s) |
| 49 | 49 | ||
| 50 | 50 | ||
| 51 | ## Technical stuff | 51 | ## Technical stuff |
| 52 | The main culprit of this player is lack of integration with programs such as playerctl | 52 | The main culprit of this player is lack of integration with programs such as playerctl |
| 53 | this is due to the daemon not being asynchronous | 53 | this is due to the daemon not being asynchronous |
