# README
# $Id: README,v 1.4 2002/11/08 05:13:18 andy Exp $

PROJECT NAME:

    xpyre


WEBSITE:

    http://ioioio.net/devel/xpyre/


AUTHOR(S):

    Andy Goth <unununium@openverse.com>


PURPOSE:

    I dunno...


REQUIREMENTS:

    xmms:    http://www.xmms.org/
    Allegro: http://alleg.sourceforge.net/

    These packages have their own dependencies as well, so watch out.  But if
    you downloaded xpyre, you probably already have xmms working, and if xmms
    is satisfied, Allegro is too.


INSTALLATION:

    make install


CONFIGURATION:

    Edit ~/.xmms/xpyre/config :

        width                      : Screen size in pixels.
        height                     : Screen size in pixels.
        fps                        : Maximum frames per second.

        draw_title                 : Automatically draw track title?
        title_bg_color             : If so, what background color?

        draw_pos                   : Draw track time and position?

        draw_top                   : Draw top of PCM wave?
        randomize_top              : Make it jitter and writhe?

        draw_fill                  : Fill the PCM wave?
        randomize_fill             : Make it spiky and violent?

    The screen size must be at least 80x80.  For fullscreen mode to work
    correctly, your X server must support the exact resolution requested.

    Colors are specified as RGB hex triplets prefixed by a hash mark.

    Read config in the source distribution to see the defaults.


KEYS:

    z:   prior track
    x:   play/restart
    c:   pause/resume
    v:   stop
    b:   next track
    esc: fullscreen/window
    t:   display track title


DEVELOPER TRICKS:

    make clean                     : Removes all generated files.
    make run                       : Rebuilds, installs, and runs xmms.
    make tar                       : Makes a distribution tarball.

    make HUSH=0      ...           : Print detailed build information.
    make DEBUG=1     ...           : Use -g -ggdb -Lefence.
    make VERSION=xxx tar           : Override version number.

    Edit global.mk to change the defaults.

# vim: set ts=4 sts=4 sw=4 tw=80 et syntax=off:
# EOF
