~ubuntu-branches/ubuntu/wily/remuco-server/wily

« back to all changes in this revision

Viewing changes to doc/README

  • Committer: Bazaar Package Importer
  • Author(s): Chow Loong Jin
  • Date: 2009-03-30 00:59:36 UTC
  • Revision ID: james.westby@ubuntu.com-20090330005936-hkxki384hm0d33gj
Tags: upstream-0.8.2.1
Import upstream version 0.8.2.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Remuco - Remote media player control
 
2
 
 
3
Remuco is a duplex remote control system for Linux media players and mobile
 
4
devices equipped with Bluetooth or WiFi. With Remuco, you can remotely control
 
5
your favorite media player. You can switch to the next, previous, or any other
 
6
media within the current playlist, browse your media library and activate other
 
7
playlists, rate your media, adjust volume, and more. On the mobile device (the
 
8
remote control), it displays information about the current media, including
 
9
cover art.
 
10
 
 
11
Getting Started : http://remuco.sourceforge.net/index.php/Getting_Started
 
12
Features        : http://remuco.sourceforge.net/index.php/Features
 
13
Screenshots     : http://remuco.sourceforge.net/index.php/Screenshots
 
14
 
 
15
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
16
 
 
17
Table of Contents
 
18
 
 
19
1. Requirements
 
20
2. Installation
 
21
3. Usage
 
22
4. Player Adapter Development
 
23
5. Packager Information
 
24
A. General Information
 
25
 
 
26
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
27
 
 
28
1. Requirements
 
29
 
 
30
General:
 
31
 * Python >= 2.5 and < 3.0
 
32
 * Python modules: dbus, gobject, xdg, Image, logging, bluetooth
 
33
 
 
34
Amarok:
 
35
 * Amarok >= 2.0
 
36
 
 
37
Audacious:
 
38
 * Audacious >= 1.5.1 (previous versions may work, not tested)
 
39
 
 
40
Banshee:
 
41
 * Banshee >= 1.4
 
42
 
 
43
MPD:
 
44
 * MPD >= 0.13.2
 
45
 * Python modules: mpd (>= 0.2)
 
46
 
 
47
Rhythmbox:
 
48
 * Rhythmbox >= 0.11.5
 
49
 
 
50
Totem:
 
51
 * Totem >= 2.22
 
52
 
 
53
TVtime:
 
54
 * TVtime >= 0.9.11
 
55
 
 
56
VLC:
 
57
 * VLC >= 0.9
 
58
 * If not enabled by default, VLC needs to be started with DBus control:
 
59
   $ vlc --control dbus
 
60
 
 
61
XMMS2:
 
62
 * Python modules: xmmsclient (>= 0.5)
 
63
 
 
64
Client:
 
65
 The client runs on mobile devices with this JavaME configurations:
 
66
 * MIDP >= 2.0
 
67
 * CLDC >= 1.1
 
68
 * JSR-82 (not needed for WiFi mode)
 
69
 
 
70
 
 
71
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
72
 
 
73
2. Installation
 
74
 
 
75
Run
 
76
 
 
77
 $ make help
 
78
 
 
79
to get instructions on how to install Remuco for one or more media players.
 
80
 
 
81
Note: Please remove any Remuco version < 0.8.2. Installation process has
 
82
      changed in 0.8.2 so that you otherwise might end up with multiple Remuco
 
83
      installations on your system. If you do not have the install log files
 
84
      anymore which lists all installed files, then look for files starting
 
85
      with 'remuco-...' in /usr/local/bin and for a directory called 'remuco'
 
86
      and a remuco egg info file in /usr/local/lib/python2.X/site-packages/.
 
87
 
 
88
Next, install the client application on your mobile device. You find the
 
89
required JAR and JAD files in the directory 'client/app'.
 
90
How to install is device dependent - please consult the documentation of your
 
91
mobile device.
 
92
 
 
93
Note: If the client fails to start on your mobile, have a look at
 
94
      http://remuco.sourceforge.net/index.php/Client_Customization
 
95
      for possible reasons and solutions.
 
96
 
 
97
For more information visit:
 
98
http://remuco.sourceforge.net/index.php/Getting_Started
 
99
 
 
100
 
 
101
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
102
 
 
103
3. Usage
 
104
 
 
105
3.1 Player Adapters
 
106
 
 
107
Some player adapters need to get started manually, others get started
 
108
automatically when the corresponding player application starts. Please visit
 
109
http://remuco.sourceforge.net/index.php/Getting_Started for player specific
 
110
information.
 
111
 
 
112
Each player adapter has a configuration file ~/.config/remuco/<PLAYER>/conf.
 
113
Edit this file if needed. Logging output of a player adapter goes to
 
114
~/.cache/remuco/<PLAYER>/log.
 
115
 
 
116
3.2 Client
 
117
 
 
118
Using the client is not too complicated, just start and use it ;) .
 
119
 
 
120
Nevertheless, you'll find some usage information here:
 
121
http://remuco.sourceforge.net/index.php/Getting_Started
 
122
 
 
123
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
124
 
 
125
4. Player Adapter Development
 
126
 
 
127
To develop a player adapter, use 'fooplay' as a template and implement it as
 
128
described in the file 'api.html'.
 
129
 
 
130
To test the fooplay adapter, simply run it as a Python script. It requires the
 
131
Python module 'remuco' which is available if you installed another player
 
132
adapter before. Otherwise, just add '<package-root>/base/module' to PYTHONPATH
 
133
before running the fooplay adapter.
 
134
 
 
135
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
136
 
 
137
5. Packager Information
 
138
 
 
139
Packagers should not use the top level make file -- this is a wrapper around
 
140
'setup.py'. Instead use setup.py directly, which install all Remuco components
 
141
(base, player adapters and client binaries) by default. The client installation
 
142
can be suppressed by setting the environment variable 'REMUCO_NO_CLIENT'.
 
143
Additionally some more environment variables may be used to adjust the
 
144
installation process, just grep setup.py for 'os.getenv'.
 
145
 
 
146
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
147
 
 
148
A. General Information
 
149
 
 
150
The Remuco project is hosted on SourceForge at http://remuco.sourceforge.net.
 
151
It is licensed under the GPLv3 or any newer version.
 
152
 
 
153
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
154
 
 
155
A.1. Feedback, Help, Bugs, Discussion etc.
 
156
 
 
157
You can get support and help at the help forum:
 
158
http://sourceforge.net/forum/forum.php?forum_id=568227
 
159
 
 
160
To file bugs please visit the bug tracker:
 
161
http://sourceforge.net/tracker2/?group_id=166515&atid=839315
 
162
 
 
163
If you miss a nice feature, take a look at the feature request tracker:
 
164
http://sourceforge.net/tracker2/?func=browse&group_id=166515&atid=839318
 
165
 
 
166
If you need help on development issues, mainly concerning player adapter
 
167
development, visit the developer forum:
 
168
http://sourceforge.net/forum/forum.php?forum_id=568228
 
169
 
 
170
For all other things to talk about, use the discussion forum:
 
171
http://sourceforge.net/forum/forum.php?forum_id=568226
 
172
 
 
173
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
174
 
 
175
A.2. Source Code Access
 
176
 
 
177
You can get the source code via SVN. The SVN root is:
 
178
https://remuco.svn.sourceforge.net/svnroot/remuco
 
179
 
 
180
To browse the SVN repository visit:
 
181
http://remuco.svn.sourceforge.net/viewvc/remuco
 
182
 
 
183
The most current code is located in "trunk". Note that this code is not always
 
184
stable or in a working state. The sources of specific releases are located in
 
185
"tags" -- getting code from "tags" ensures to have working code.
 
186
 
 
187
Example A-1. Check out the current development version into the
 
188
directory remuco-trunk:
 
189
 
 
190
 $ svn co <SVN-ROOT>/trunk remuco-trunk
 
191
 
 
192
Example A-2. Check out the source from release 0.8.0 into the directory
 
193
remuco-0.8.0:
 
194
 
 
195
 $ svn co <SVN-ROOT>/tags/0.8.0 remuco-0.8.0