source: mpd-status/trunk/README @ 24

Last change on this file since 24 was 19, checked in by simon, 19 years ago

Reformatting and correct program name in license blurb.

File size: 2.8 KB
Line 
1MPD Status
2
3   MPD Status is a quick Python script to display some details about
4   the track currently playing in [1]MPD. It is intended for use in
5   [2]wmii's status bar.
6
7   If you want a more featureful status bar, check out [3]szs3rd, from
8   which I shamelessly copied and hacked the mpc.py module.
9
10Features
11
12     * Displays currently playing/paused song (that's a given really)
13       with time.
14     * If metadata isn't provided, falls back to the basename of the
15       file.
16
17Requirements
18
19     * [4]Python 2.4.
20     * [5]mpc.
21
22Download
23
24   Checkout mpd-status/trunk/ from the [6]Subversion repository:
25
26 svn co http://svn.bleah.co.uk/repos/misc/mpd-status/trunk
27
28   or, since it is just the one file, grab it via HTTP from:
29
30 [7]http://svn.bleah.co.uk/repos/misc/mpd-status/trunk/mpd-status.py
31
32Installation and Usage
33
34   (Instructions are based around the setup for wmii 2 in [8]Debian)
35
36    1. Place mpd-status.py somewhere, like /usr/local/bin/ or
37       ~/.wmii/scripts/
38    2. Copy /etc/wmii/status.sh to ~/.wmii/status.sh and edit it, or
39       edit /etc/wmii/status.sh directly.
40    3. Edit the following line to include "`python2.4
41       /path/to/mpc.py`" (see patch below for an example):
42
43 text="`date` `uptime | sed -e 's/.*://' -e 's/,//g'`"
44
45    4. Restart wmii: /etc/wmii/rc restart
46
47   You should see some extra text on your wmibar, either "--Not
48   playing--" or your currently playing/paused track.
49
50License
51
52   mpd-status is free software; you can redistribute it and/or modify
53   it under the terms of the [9]GNU General Public License as
54   published by the [10]Free Software Foundation; either version 2 of
55   the License, or (at your option) any later version.
56
57   mpd-status is distributed in the hope that it will be useful, but
58   WITHOUT ANY WARRANTY; without even the implied warranty of
59   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
60   [11]GNU General Public License for more details.
61
62Extras
63
64     * [12]wmii-mpd-status.patch (497 bytes) - Example patch to wmii
65       status.sh, added by simon on Mon Nov 7 13:57:32 2005.
66     * [13]mpd-status.png (33 kB) - Screenshot showing status bar
67       while playing, added by simon on Mon Nov 7 14:11:25 2005.
68
69References
70
71  1. http://www.musicpd.org/
72  2. http://wmii.de
73  3. http://wmii.de/index.php/Contrib/Szs3rd
74  4. http://www.python.org/
75  5. http://www.musicpd.org/mpc.shtml
76  6. http://subversion.tigris.org/
77  7. http://svn.bleah.co.uk/repos/misc/mpd-status/trunk/mpd-status.py
78  8. http://www.debian.org/
79  9. http://www.fsf.org/licensing/licenses/gpl.html
80  10. http://www.fsf.org/
81  11. http://www.fsf.org/licensing/licenses/gpl.html
82  12. http://projects.bleah.co.uk/misc/attachment/wiki/MpdStatus/wmii-mpd-status.patch
83  13. http://projects.bleah.co.uk/misc/attachment/wiki/MpdStatus/mpd-status.png
84
Note: See TracBrowser for help on using the repository browser.