=====================
Elisa / Edgy HowTo
=====================

This howto details step by step how to get Elisa running on Ubuntu
Edgy Eft.

.. sectnum::

.. contents::

Requirements
============

Hardware
--------

Elisa should run fine on any nowaday computer. Since it heavily relies
on OpenGL for the GUI rendering, Elisa will run better on computers
equiped with NVidia or ATI video hardware, and the proprietary video
drivers. The purpose of this howto isn't to explain the reader how to
install these drivers, read the Ubuntu docs for that.


Repositories configuration
--------------------------

By default multiverse and some other APT repositories are disabled,
you need to enable everything in the file
/etc/apt/sources.list.


GStreamer
---------

After the repository configuration, you are safe to install packages
that will allow you to play all your multimedia files with GStreamer
on Elisa:

::

  $ sudo apt-get install gstreamer0.10-plugins-bad \
    gstreamer0.10-ffmpeg gstreamer0.10-plugins-ugly gstreamer0.10-alsa \
    gstreamer0.10-gnomevfs gstreamer0.10-pitfdll \
    gstreamer0.10-plugins-bad-multiverse gstreamer0.10-plugins-ugly-multiverse



Miscellaneous
-------------

If you're willing to try the latest bleeding edge code from our
Subversion repository, you need a subversion client:

::
  
  $ sudo apt-get install subversion

To build Elisa source code you'll need to install further more
packages:

::

  $ sudo apt-get install gcc libsdl1.2-dev python2.4-dev \ 
    python2.4-imaging python2.4-twisted python-gst0.10 python2.4-elementtree \
    python2.4-soappy sqlite3 libsqlite3-dev python-celementtree python-pysqlite2


Installing Elisa
================

Checkout the code
-----------------

If you're testing code hosted at our Subversion repository:

::

  $ svn co https://core.fluendo.com/elisa/svn/trunk elisa

Else, you only need to unpack lastest release archive somewhere on your
home directory (for instance)

Running Elisa locally
---------------------

To run Elisa without installing it anywhere, just run elisa.py:

::

  $ python elisa.py

Play with it!
-------------

If you install elisa with the command `python setup.py install`, you
should be able to execute a convenience script nammed `elisa`,
installed on your $PATH:

::

  $ elisa

You should see a window pop up with a menu, use the keyboard shortcuts
to navigate, etc:

- Arrows : for navigation
- Enter : Action (play video ...)
- space : Hide/Show menu.
- p : play
- l : pause
- s : stop
- f : fullscreen toggle
- c : seek+
- x : seek-
- v : next
- w : previous
- m : mute
- u : volume up
- i : volume down

If you want to customize Elisa (media locations for instance), you can
copy the default config file and tell elisa.py to use it:

::

  $ cp elisa.conf local.conf
  $ gedit local.conf
  $ # edit and save local.conf
  $ elisa local.conf

If you don't supply a customized config file, the default one will be
written to $HOME/.elisa/elisa.conf
