DISCLAIMER:

THIS SOFTWARE IS PROVIDED BY SGS "AS IS" AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL SGS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

---------------------------------------------------------------------------
GuideR 0.1

This module implements an XMLTV based programme guide for DVB Dream 
modelling the visual style of the windows media centre guide.

---------------------------------------------------------------------------
Requirements
---------------------------------------------------------------------------

Windows 7 or later
DVB Dream (Minimum version unknown, tested with 2.5a and 2.6)
XMLTV file (See XMLTV section for further requirements)

---------------------------------------------------------------------------
Installation
---------------------------------------------------------------------------
Copy the GuideR.mod file to your modules directory.
Optionally copy the GuideR.xml file to the DVB Dream working directory.

---------------------------------------------------------------------------
Configuration
---------------------------------------------------------------------------

Configuration is stored in the file Guider.xml. If this file or any settings
withing the file are not found defaults values will be use.

Currently the following settings can be configured:

<XMLTVFilename>
the path and name of the XMLTV file to use, this can be absolute or relative 
to the DVBDream working directory.
default: TVGuide.xml

<ShowOnlyMappedChannels>
Controls whether channels from the XMLTV file which cannot be matched with 
channels in DVB Dream will be shown.
default: true

<ShowOnlyFavourites>
Controls whether to show only channels which are in DVB Dream favourites 
(Not quick favourites).
default: true

<ChannelListFilename>
the path and name of the DVB Dream channel list file, this can be absolute or 
relative to the DVBDream working directory.
default: chlist.chl

---------------------------------------------------------------------------
Usage
---------------------------------------------------------------------------

ArrowKeys: Navigate
Enter:     Change programme
F9:        Close the epg window

---------------------------------------------------------------------------
XMLTV File requirements
---------------------------------------------------------------------------

Guider currently imposes some contraints on the XMLTV file format:

1) Channel IDs must be of the format "<nid>:<tid>:<sid>:<name>"
   where: <nid> = network id
          <tid> = transponder id
		  <sid> = station id
	      <name> = channel name
   This is referred to as the 'Full' channel id in EPG Collector

   e.g: 

2) Guider cannot handle datetimes with named time zones, e.g, 'CST' time zones
   must be specified as a numeric offset.

3) Guider requires start and stop times. XMLTV only reaquires the start time
   attribute for programmes.

---------------------------------------------------------------------------
Notes
---------------------------------------------------------------------------

The software is very immature and has been tested on one system
(Win7 x64, DVBDream 2.5a/2.6, EPG Collector generated XMLTV file)
It is quite possible that you will encounter bugs with the guide, the 
following outlines some possible issues you may encounter.

1) Missing files. Guider does not currently handle missing files (e.g, 
   TVGuide.xml and chllist.chl). This may cause DVBDream to crash on startup.

2) Incorrectly formatted XMVTV file. Refer to the notes on XMLTV file 
   requirements. Failure to meet these requirements could result in crashes
   or no guide data.

3) Old version of DVBDream. GuideR may work with versions older than 2.5a
   however it reads the channel list file directly so this must be compatible
   with the channel list from version 2.5a.

4) Guider has only been tested with one XMLTV file in one time zone. If the
   times in the guide are incorrect please leaev a post on the GuideR thread on
   the DVBDream forums.

5) The Guider dialog exists from the first time that it is shown until the point
   that DVBDream is closed. When 'closing' the GuideR window is is only hidden.
   Actually closing the window (e.g, alt-F4 etc..) will require DVB Dream to be
   restarted.

6) Note that if 'ShowOnlyMappedChannels' and 'ShowOnlyFavourites' is disabled,
   it will not be possible to change to channels which cannot be mapped to
   DVB Dream channels.

7) Channels are sorted alphabetically by name

8) The channel list is read when the guide is shown for the first time. 
   DVBDream will have to be restarted for any changes to the channel list
   (including favourites) after the GuideR window has been shown.

---------------------------------------------------------------------------
Future directions
---------------------------------------------------------------------------

The following features are planned for the future, Although since I don't
have much time for this now (and it does mostly what I need) don't hold your
breath waiting for them!

The source will be released once I have had time to tidy/comments things
and check through any licensing issues, this could take a while.

Desrired features (no particular order):

- Bug fixes
- Add channel logos
- Colour channels by category
- Schedule recordings
- Filtering/Sorting channels, e.g, filter by DVBDream favourite category.
- Searching programmes
- Configurable layout( number of visible channels, time range, font sizes..
  , colours)
- Display as an OSD
- Use epg from DVBDream instead of XMLTV if available.
- Use now/next from DVBDream for more up to date data

... probably more I can't think of, please place any feedback and suggestions
on the GuideR thread at DVBDream.org
