summaryrefslogtreecommitdiff
path: root/README
blob: 79131c33d7e6ca400501801356184ef791c1bd00 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
vdr-scripting
=============

(C) 2009 Tobias Grimm <vdr@e-tobi.net>

Project's homepage:
  http://projects.vdr-developer.org/projects/show/plg-scripting

Latest version available at:
  http://projects.vdr-developer.org/projects/list_files/plg-scripting

License:
  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  at your option) any later version.
  See the file COPYING for more information.


Description
-----------

vdr-scripting is a VDR plug-in, which hosts other plug-ins written in
a dynamic scripting language. Currently only Ruby is supported.


Limitations
-----------

Currently this is just a proof-of-concept release with only a very
limited set of functionality!


Installation
------------

To compile vdr-scripting Ruby 1.8.6 or 1.9 and with the Ruby heades and
libraries is required.

Besides the VDR plugin you must install the libraries from lib/ to VDR's
configuration directory:

   <vdr-config-dir>/plugins/scripting/libs


Usage
-----

Ruby plug-ins must me located in:

   <vdr-config-dir>/plugins/scripting/plugins

You will find some sample plug-ins in the examples directory. Just
copy the *.rb files from there to the above directory and restart VDR.