source: mpd-status/trunk/README

Last change on this file was 25, checked in by simon, 18 years ago

Update README with more general instructions. Add wmii status rc script examples.

File size: 2.5 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 for wmii, check out
8   [3]szs3rd, from which I shamelessly copied and hacked the mpc.py
9   module.
10
11Features
12
13     * Displays currently playing/paused song (that's a given really)
14       with time.
15     * If metadata isn't provided, falls back to the basename of the
16       file.
17
18Requirements
19
20     * [4]Python 2.4.
21     * [5]mpc.
22
23Download
24
25   Checkout mpd-status/trunk/ from the [6]Subversion repository:
26
27 svn co http://svn.bleah.co.uk/repos/misc/mpd-status/trunk
28
29   or, since it is just the one file, grab it via HTTP from:
30
31 [7]http://svn.bleah.co.uk/repos/misc/mpd-status/trunk/mpd-status.py
32
33Usage
34
35   When run, the script simply outputs current track information (or
36   '--Not playing--') to standard output.  To have this update
37   continuously, run it repeatedly inside a loop construct, for
38   example (using sh):
39
40 while true
41 do
42     mpd-status.py
43     sleep 1
44 done
45
46   Some example 'status' rc scripts for wmii 2.5 are contained in the
47   examples directory.
48
49License
50
51   mpd-status is free software; you can redistribute it and/or modify
52   it under the terms of the [9]GNU General Public License as
53   published by the [10]Free Software Foundation; either version 2 of
54   the License, or (at your option) any later version.
55
56   mpd-status is distributed in the hope that it will be useful, but
57   WITHOUT ANY WARRANTY; without even the implied warranty of
58   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
59   [11]GNU General Public License for more details.
60
61Extras
62
63     * [12]wmii-mpd-status.patch (497 bytes) - Example patch to wmii
64       status.sh, added by simon on Mon Nov 7 13:57:32 2005.
65     * [13]mpd-status.png (33 kB) - Screenshot showing status bar
66       while playing, added by simon on Mon Nov 7 14:11:25 2005.
67
68References
69
70  1. http://www.musicpd.org/
71  2. http://wmii.de
72  3. http://wmii.de/index.php/Contrib/Szs3rd
73  4. http://www.python.org/
74  5. http://www.musicpd.org/mpc.shtml
75  6. http://subversion.tigris.org/
76  7. http://svn.bleah.co.uk/repos/misc/mpd-status/trunk/mpd-status.py
77  8. http://www.fsf.org/licensing/licenses/gpl.html
78  9. http://www.fsf.org/
79  10. http://www.fsf.org/licensing/licenses/gpl.html
80  11. http://projects.bleah.co.uk/misc/attachment/wiki/MpdStatus/wmii-mpd-status.patch
81  12. http://projects.bleah.co.uk/misc/attachment/wiki/MpdStatus/mpd-status.png
82
Note: See TracBrowser for help on using the repository browser.