gxmms2 & gkrellxmms2 Copyright (c) 2005-2010 Johannes Heimansberg

gxmms2 and gkrellxmms2 are XMMS2 clients.
gxmms2 is a GTK2 based XMMS2 client. 
gkrellxmms2 is a gkrellm2 plugin.

Website: http://wejp.k.vu/

gxmms2 and gkrellxmms2 are released under the GNU General Public License
(GPL) Version 2. For details see COPYING file.

Contents
--------

0 Quick start
1 Dependencies
2 gxmms2
3 gkrellxmms2
4 Media library


0 Quick start
-------------

This package contains both gxmms2 and gkrellxmms2 (the xmms2 gkrellm2 plugin).

To build gxmms2 run
	make gxmms2
and
	make install_gxmms2
to install gxmms2.
To build gkrellxmms2 run
	make gkrellxmms2
and
	make install_gkrellxmms2
to install gkrellxmms2. This will install the plugin 
in /usr/lib/gkrellm2/plugins.

If just you run "make", make will build both gxmms2 and gkrellxmms2.
"make install" installs both gxmms2 and gkrellxmms2.


1 Dependencies
--------------

gxmms2:
- xmms2 client lib
- gtk+2.6.0 or higher
gkrellxmms2:
- xmms2 client lib
- gtk+2.6.0 or higher
- gkrellm2 2.2

Please note: If you get lots of errors when trying to build gxmms2 and/or 
gkrellxmms2 please make sure that you have all required dependencies 
installed. Also make sure, that your PKG_CONFIG_PATH is set correctly.
E.g. sometimes /usr/local/lib/pkgconfig is not in pkg-config's path,
although there might be .pc files installed in that location.


2 gxmms2
--------

2.1 Using gxmms2

2.1.0 Getting started

The basic player controls are available through gxmms2's main window.
There are buttons for play, pause, skip, stop, track info, player info 
and one button to open the medialib window. Furthermore you can control 
the volume by moving your mouse over the volume icon (upper right corner) 
and using either the mouse wheel or the left and right buttons to change 
the volume. For details on the keyboard control read section 2.1.1.

For details on media library usage see chapter 4.

2.1.1 Keyboard control

Besides the main window's buttons you can use your keyboard to control 
play, pause, stop, skip and volume. The keys are:
- z for previous track
- x for play
- c for pause
- v for stop
- b for next track
- j for medialib/playlist window
- t for toggle elapsed/remaining time
- +/- to increase/decrease the volume
- 0..4 to rate the current track where 0 is worst and 4 is best

2.2 Customizing gxmms2

There are various options that can be changed. Some of them can be changed
from within gxmms2 itself while others can be changed through editing the
config file only.

2.2.1 Changing settings from within gxmms2

Things you can change in gxmms2 are the visible columns in both
search and playlist view and in gxmms2's main window the time display
whether it should show the elapsed or remaining time.

2.2.2 Editing the config file

The config file's location depends on the operating system gxmms2 
runs on, but it is usually ~/.config/xmms2/clients/gxmms2.conf .
It is a plain text file which you can edit with your favorite text
editor. Make sure gxmms2 is not running while editing the file,
otherwise gxmms2 will overwrite your changes upon exit.

There are things you probably should not change (such as 
ScrollerFontSizePx), because changes can lead to unexpected behaviour
or a strange program layout.
Settings of interest are:

* MediaLibFontSizePt
	Setting this to -1 will tell gxmms2 to use gtk2's default
	font size. Numbers above 0 will tell gxmms2 to use treat
	that number as the new font size.
* RestoreMediaLibSize
	Possible values are "yes" and "no". If set to "yes" gxmms2
	will remember the medialib window's size and restore it
	each time gxmms2 is started.
* RestoreMediaLibPosition
	Possible values are "yes" and "no". If set to "yes" gxmms2
	will remember the medialib window's position and restore it
	each time gxmms2 is started.
* RestoreMainWindowPosition
	Possible values are "yes" and "no". If set to "yes" gxmms2
	will remember the main window's position and restore it
	each time gxmms2 is started.
* OpenMediaLibOnStartup
	Possible values are "yes" and "no". If set to "yes" gxmms2
	will open the medialib window on startup.
* TrayIcon
	Possible values are "yes" and "no". If set to "yes" gxmms2
	puts a tray icon in the window manager's tray icon area.
* AutoReconnect
	Possible values are "yes" and "no". If set to "yes" gxmms2
	will try to reconnect if it looses the connection to the 
	daemon.
* TerminateXmms2dOnExit
	Possible values are "yes" and "no". If set to "yes" gxmms2
	will shut down xmms2d on exit.
* StartLocalXmms2dOnStartup
	Possible values are "yes" and "no". If set to "yes" gxmms2
	tries to start xmms2d if it is not running. Only works
	when the IPCPath is a local path (starting with unix://).
* IPCPath
	By default this is set to the default local ipc path. When
	your xmms2d is running on another computer you need to change
	this. This setting will be overwritten by the XMMS_PATH
	environment variable.


3 gkrellxmms2
-------------

The gkrellxmms2 gkrellm2 plugin has a title scroller with a position marker
and five buttons for playback control. The position marker can be moved
with the mouse to seek in the current track. The M button opens a menu with
two items for opening a trackinfo dialog and the media library window.


4 Media library
---------------

4.1 Getting started

Assuming you have just installed XMMS2 and gxmms2/gkrellxmm2 and started 
the xmms2d daemon, the first thing you want to do is to add some files 
(or better yet all your media files) to XMMS2's media library. 
To add files to XMMS2's media library, start gxmms2/gkrellm2 and open the
medialib/playlist editor by clicking on gxmms2's second button from the 
right or on the M button in gkrellxmms2 and select the media lib from there.
Now select the "MLib Add files" tab. Now you can select one or more
files and/or directories and add the selection to the medialib by clicking
on the "Add" button below. This will only work when both xmms2d and 
gxmms2/gkrellxmms2 are running on the same computer. If that is not the case
use the CLI client to add files to the medialib on the remote computer.
When you are finished with adding files to the media library you can 
search for music within the medialib using the playlist editor's 
"MLib Search" tab or browse through the artists with the "MLib Browser".
When you have found something you want to listen to, you can add it to the 
playlist by either double clicking on the item or by selecting the item or
even multiple items and selecting the "Add" item from the context menu.
If you can't decide what you want to listen to you can use the "+?" button
in the playlist editor to add 10 random songs to the playlist.
If you have created a playlist that you want to keep you can save it by 
clicking on the "Save playlist" button. When you do that you will be asked 
for a playlist name.

4.2 Modifying the playlist

If you want to move a playlist item you can either use the arrow buttons 
in the upper right corner of the playlist tab or use your keyboard by 
pressing ALT + Cursor up/Cursor down key to move the selected item up or 
down.
To remove the selected item(s) from the playlist you can use the delete 
item from the context menu or press the delete key on your keyboard.
