$Id: README,v 1.6 2006/09/16 11:54:18 toad32767 Exp $
UModPlayer B5
Getting Started
1. System requirements
- LibAo
- LibAiff >= 1.1
- LibModPlug >= 0.8
- UNIX system and development tools
2. Building UModPlayer
First of all, make sure you have installed the above-listed libraries.
2.1. Configuring LibAo
In the case of LibAo, note that you need the core library plus the audio drivers you want (i.e., 'alsa09' if you want ALSA 0.9+ support for Linux; or 'sun' if you are a SunOS/NetBSD/OpenBSD user ).
In the case of Linux, many Linux distributions come already with LibAo installed. In that case you need to install only the development packages, such as `libao-dev'.
In the case of NetBSD, you have LibAo in pkgsrc: audio/libao + audio/libao-sun.
You might want to specify a default audio driver for LibAo. Please refer to libao.conf(5). Usually the libao.conf file is stored in /etc.
In example:
default_driver=esound
for using ESound as a default audio driver for all LibAo applications, including UModPlayer.
2.2. Compiling UModPlayer
You can compile UModPlayer as usual:
$ ./configure
$ make
UModPlayer will be configured by default to be installed on '/usr/local/bin'. Use the `--prefix' option of the <configure> script to change this:
$ ./configure --prefix=/usr # to install in /usr/bin $ ./configure --prefix=/home/user # to install in /home/user/bin
2.3. Installing UModPlayer
To install UModPlayer:
# make install
(The above command must be run as 'root', or as a user who have write-access to the installation directory).
3. Using UModPlayer
To get help about command line options, you can take a look a the man page:
$ man umodplayer
Or the built-in UModPlayer help:
$ umodplayer --help
To get help about interactive interface, use the 'help' command:
$ umodplayer
umodplayer[/home/user]% help
umodplayer[/home/user]% quit
$
Please remember to configure UModPlayer. Use the configuration commands such as 'volume', 'surround', 'samplerate', etc.; as well as the 'setadvanced' command for the advanced configuration.
You can save the config with the 'saveconfig' command, and reset it to the default settings with the 'reset' command.
4. Reporting bugs, sending patches, fixes, etc:
Any contribution would be welcomed and appreciated. Please mail them to the project mantainer. As of UModPlayer B4, the maintainer is:
Marco Trillo <marcotrillo@gmail.com>
5. Licensing of UModPlayer
UModPlayer is released by its autors to the Public Domain. In case this is not legally possible, its authors grant anyone the right to use, redistribute and modify it for any purpose without any conditions (unless such conditions are required by law).