README
author Dan
Fri, 12 Jun 2009 13:50:13 -0400
changeset 78 08f8a72b1f7b
parent 65 35fe20340c91
permissions -rw-r--r--
Added Offline Mode - automatically turned on and off based on connectivity to server. Version bumped to 0.1a5.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
6
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
     1
<div align="center">
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
     2
  <b>Greyhound</b><br />
9
63a257541313 Moved all Greyhound output to stderr so it will show up in AmaroK error messages; corrected some HTML bugs in the readme
Dan
parents: 6
diff changeset
     3
  A PHP-based web interface for Amarok<br />
63a257541313 Moved all Greyhound output to stderr so it will show up in AmaroK error messages; corrected some HTML bugs in the readme
Dan
parents: 6
diff changeset
     4
  <br />
63a257541313 Moved all Greyhound output to stderr so it will show up in AmaroK error messages; corrected some HTML bugs in the readme
Dan
parents: 6
diff changeset
     5
  &gt;&gt;&gt; <b>To access this script once started navigate to: &lt;&lt;&lt;<br />
63a257541313 Moved all Greyhound output to stderr so it will show up in AmaroK error messages; corrected some HTML bugs in the readme
Dan
parents: 6
diff changeset
     6
  &gt;&gt;&gt; <a href="http://localhost:7447/">http://localhost:7447/</a> &lt;&lt;&lt;
6
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
     7
</div>
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
     8
<p>I wrote Greyhound because of some issues I was having with other web
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
     9
   interface scripts freezing and not working right. Greyhound is my first
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
    10
   shot at writing Amarok scripts but it seems to work pretty well.
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
    11
   </p>
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
    12
<p>Greyhound's interface is based on the WebControl script by Jonas Christian
9
63a257541313 Moved all Greyhound output to stderr so it will show up in AmaroK error messages; corrected some HTML bugs in the readme
Dan
parents: 6
diff changeset
    13
   Drewsen, Andr&#0233; Kelpe, and Peter C. Ndikuwera. However unlike WebControl
6
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
    14
   Greyhound is written entirely in PHP, making it a bit more portable. This
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
    15
   script doesn't require an external web server to run, it has a relatively
35
8040903d25de Updated readme for imminent release 0.1a3
Dan
parents: 20
diff changeset
    16
   basic built-in (but multi-threaded) server.</p>
6
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
    17
<p>The script needs a browser with XmlHttpRequest (AJAX) support to work. It's
65
35fe20340c91 Updated readme for 0.1a4
Dan
parents: 35
diff changeset
    18
   been tested on Firefox 3.0.5, Safari (Mac and Windows), Google Chrome, and
35fe20340c91 Updated readme for 0.1a4
Dan
parents: 35
diff changeset
    19
   Opera 9.5. It does not work (nor, in my opinion, need to work) under Internet
35fe20340c91 Updated readme for 0.1a4
Dan
parents: 35
diff changeset
    20
   Explorer.</p>
6
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
    21
<p>It uses Smarty templates so you should be able to customize the HTML to
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
    22
   your needs. The template file is /themes/funkymonkey/playlist.tpl. There's
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
    23
   also a theme called iphone which is optimized for use on Apple's touch
65
35fe20340c91 Updated readme for 0.1a4
Dan
parents: 35
diff changeset
    24
   screen based mobile devices. Now your iPod&reg; or iPhone&reg; can control music other than
35fe20340c91 Updated readme for 0.1a4
Dan
parents: 35
diff changeset
    25
   its own. :-P</p>
35fe20340c91 Updated readme for 0.1a4
Dan
parents: 35
diff changeset
    26
<p>It advertises itself on your LAN using Avahi (if it's available on your computer).
35fe20340c91 Updated readme for 0.1a4
Dan
parents: 35
diff changeset
    27
   All of its control interfaces as well as authentication services are available via
35fe20340c91 Updated readme for 0.1a4
Dan
parents: 35
diff changeset
    28
   JSON, so it should be possible to write a custom (desktop) client. I have a script
35fe20340c91 Updated readme for 0.1a4
Dan
parents: 35
diff changeset
    29
   called grey-pidgin that I use internally that can update your Pidgin status to reflect
35fe20340c91 Updated readme for 0.1a4
Dan
parents: 35
diff changeset
    30
   the song currently playing <b>on your Greyhound server</b>. This means that if you're
35fe20340c91 Updated readme for 0.1a4
Dan
parents: 35
diff changeset
    31
   like me and you have to run your IM from one box and your music from another, you can
35fe20340c91 Updated readme for 0.1a4
Dan
parents: 35
diff changeset
    32
   still show off your music collection to all your buddies. The possibilities for clients
35fe20340c91 Updated readme for 0.1a4
Dan
parents: 35
diff changeset
    33
   are practically endless. I haven't released grey-pidgin because it lacks a GUI, but
35fe20340c91 Updated readme for 0.1a4
Dan
parents: 35
diff changeset
    34
   I may soon. We'll see. It's a bit rough around the edges for sure.</p>
6
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
    35
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
    36
<p>
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
    37
  <b>License</b><br />
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
    38
  I was originally planning to place this into the public domain but decided to
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
    39
  make it <b>GPLv2</b> because it uses so many GPLv2 components.
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
    40
</p>
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
    41
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
    42
<p>
20
bb8237ca678d Updated the readme with known bugs
Dan
parents: 9
diff changeset
    43
  <b>Known issues</b><br />
bb8237ca678d Updated the readme with known bugs
Dan
parents: 9
diff changeset
    44
  There are a few bugs in Greyhound that I haven't been able to iron out.
bb8237ca678d Updated the readme with known bugs
Dan
parents: 9
diff changeset
    45
</p>
bb8237ca678d Updated the readme with known bugs
Dan
parents: 9
diff changeset
    46
bb8237ca678d Updated the readme with known bugs
Dan
parents: 9
diff changeset
    47
<ul>
65
35fe20340c91 Updated readme for 0.1a4
Dan
parents: 35
diff changeset
    48
  <li>Sometimes the server freezes up and requests either take forever or
35fe20340c91 Updated readme for 0.1a4
Dan
parents: 35
diff changeset
    49
      partial pages are returned. I know this is due to a lack of experience with
35fe20340c91 Updated readme for 0.1a4
Dan
parents: 35
diff changeset
    50
      socket programming on my part, but it seems to be aggravated by slow
35fe20340c91 Updated readme for 0.1a4
Dan
parents: 35
diff changeset
    51
      and/or lossy connections. There's a fix for this but it isn't 100%
35fe20340c91 Updated readme for 0.1a4
Dan
parents: 35
diff changeset
    52
      reliable yet.</li>
35fe20340c91 Updated readme for 0.1a4
Dan
parents: 35
diff changeset
    53
  <li>Reloading the configuration doesn't always work automatically yet.</li>      
20
bb8237ca678d Updated the readme with known bugs
Dan
parents: 9
diff changeset
    54
</ul>
bb8237ca678d Updated the readme with known bugs
Dan
parents: 9
diff changeset
    55
bb8237ca678d Updated the readme with known bugs
Dan
parents: 9
diff changeset
    56
<p>
6
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
    57
  <b>Author</b><br />
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
    58
  Dan Fuhry &lt;<a href="mailto:dan@enanocms.org">dan@enanocms.org</a>&gt;<br />
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
    59
  If you like this script be sure to check out my other projects:
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
    60
    <a href="http://enanocms.org/">Enano CMS</a> and
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
    61
    <a href="http://lifecodeidiocy.enanocms.org/">my blog</a>.
5f35ebc4f9bb First release version. Renamed to Greyhound and readme/license files added.
Dan
parents:
diff changeset
    62
</p>