aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorsalmonik <raisersoft@proton.me>2026-05-18 21:46:26 +0200
committersalmonik <raisersoft@proton.me>2026-05-18 21:46:26 +0200
commit6cceb3cbfacb6f4416e49321a9b63b4ce7a9f036 (patch)
tree9d883ada0e6cfb4fd533635885dfb4459f200128 /README.md
parentfirst public release. (diff)
downloadrsplayer-6cceb3cbfacb6f4416e49321a9b63b4ce7a9f036.tar.gz
rsplayer-6cceb3cbfacb6f4416e49321a9b63b4ce7a9f036.zip
fix for new symphony API and less debug info in release
Diffstat (limited to '')
-rw-r--r--README.md66
1 files changed, 33 insertions, 33 deletions
diff --git a/README.md b/README.md
index 2092f2a..7826c41 100644
--- a/README.md
+++ b/README.md
@@ -7,47 +7,47 @@ cd RSPlayer
7./install.sh 7./install.sh
8``` 8```
9 9
10install.sh will: 10install.sh will:
11compile RSP (make sure you have rust properly installed!) 11- compile RSP (make sure you have rust properly installed!)
12install shell autocompletions (zsh, bash and fish supported) 12- install shell autocompletions (zsh, bash and fish supported)
13install user systemd service and activate it 13- install user systemd service and activate it
14 14
15## Usage 15## Usage
16 16
17configuration is generated at startup in $XDG_CONFIG_HOME/rsplayer/config.toml 17configuration is generated at startup in $XDG_CONFIG_HOME/rsplayer/config.toml
18most important values there are: 18- most important values there are:
19listenbrainz_token (last.fm scrobbling not yet tested) 19- listenbrainz_token (last.fm scrobbling not yet tested)
20display_format (supports $ARTIST $ALBUM and $TRACK) 20- display_format (supports $ARTIST $ALBUM and $TRACK)
21music_paths (for DB usage, still WIP) 21- music_paths (for DB usage, still WIP)
22scan_interval (same as above) 22- scan_interval (same as above)
23 23
24all other values can be changed in runtime using commands 24all other values can be changed in runtime using commands
25 25
26as for commands: 26as for commands:
27RSP will be installed as rsp, in this fragment, rsp will be ommited 27RSP will be installed as rsp, in this fragment, rsp will be ommited
28 28
29these commands should only be used in testing or by systemd service: 29these 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
34these are normal commands: 34these 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
52The main culprit of this player is lack of integration with programs such as playerctl 52The main culprit of this player is lack of integration with programs such as playerctl
53this is due to the daemon not being asynchronous 53this is due to the daemon not being asynchronous