-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathreadme.html
669 lines (634 loc) · 28.1 KB
/
readme.html
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
<html>
<head>
<title>Jumpy</title>
<style type="text/css">
.black {
color: black;
}
.orange {
color: #ff6600;
}
.comment, .comment a {
color: dimgrey;
}
ul {
list-style-type: disc;
}
.comment a:link a:visited a:hover a:active {
text-decoration:none;
}
pre, code {
-moz-tab-size: 4;
-o-tab-size: 4;
tab-size: 4;
/*color:darkblue;*/
color:#0000BB;
text-decoration: none;
/*font-weight: bold;*/
}
code {
white-space: pre;
}
kbd {
/*color:darkblue;*/
color:#0000BB;
text-decoration: none;
font-weight: bold;
}
body {
font-family: sans-serif;
padding-left: 2em;
width: 50em;
}
table {
border-collapse:collapse;
}
td {
vertical-align:top;
padding-right: 1em;
}
div.contents {
position: fixed;
height: auto;
width: 12em;
top: 2em;
left: 2em;
right: 5px;
/* text-align: right;*/
font-size: small;
}
div.main {
width: 45em;
margin-left: 15em;
}
</style>
</head>
<body>
<div class="contents">
<ul style="list-style-type:none;padding:0px;margin:10px;white-space:nowrap;">
<center><a href="#TOP">BASICS</a></center><br/>
<li><a href="#QUICKSETUP">Quick Setup</a></li>
<li><a href="#REQUIREMENTS">Requirements</a></li>
<li><a href="#XBMC">Kodi Installation</a></li>
<li><a href="#PHANTOMJS">PhantomJS Installation</a></li>
<li><a href="#INSTALLATION">Plugin Installation</a></li>
<li><a href="#SHORTPATHS">Windows Short Paths</a></li>
<li><a href="#BOOKMARKS">Bookmarks</a></li>
<li><a href="#LOGCONF">Log and Conf</a></li>
<li><a href="#BUGS">Bugs</a></li>
<li><a href="#SCRIPTSINI">jumpy-scripts.ini</a></li>
<li><a href="#WEBREADER">Webreader</a></li>
<li><a href="#FEEDREADER">Feedreader</a></li>
<li><a href="#RESOLVER">Resolver</a></li>
<li><a href="#EARMARKER">Earmarker</a></li>
<li><a href="#CAPTURE">Capture</a></li>
<br/>
<center><a href="scripts.html">SCRIPTS</a></center><br/>
<li><a href="scripts.html#QUICKSTART">Quick Start</a></li>
<li><a href="scripts.html#QUICKSTARTPLAYER">Quick Start - Players</a></li>
<li><a href="scripts.html#API">API</a></li>
<li><a href="scripts.html#OTHERSCRIPTS">Other Languages</a></li>
<!--<li><a href="scripts.html#ARRAY">Array Notation</a></li>-->
<li><a href="scripts.html#PLAYERS">Players</a></li>
<li><a href="scripts.html#INTERPRETERS">Interpreters</a></li>
<li><a href="scripts.html#ICONS">Icons</a></li>
<li><a href="scripts.html#JUMPSTART">Jumpstarting Scripts</a></li>
<li><a href="scripts.html#EXAMPLES">Examples</a></li>
<!--<ul>-->
<!--<a href="scripts.html#HELLOPY">py</a></li> <a href="scripts.html#HELLOSH">sh</a>-->
<!--<a href="scripts.html#HELLOPL">pl</a> <a href="scripts.html#HELLOBAT">bat</a</li>-->
<!--</ul>-->
<!--<center>LINKS</center><br/>-->
<br/>
<li><a href="http://sourceforge.net/projects/jumpy-plugin/files/">Download</a></li>
<li><a href="http://www.universalmediaserver.com/forum/viewtopic.php?f=6&t=288">Forum</a></li>
<li><a href="https://github.com/skeptical/jumpy">Code</a></li>
</ul>
</div>
<div class="main">
<a name="TOP"><H3 style="color:darkblue"><span class="orange">Jumpy</span> - Jump into Python (and onto Kodi)</H3></a>
Jumpy (<span class="orange">J</span>ava <span class="orange">U</span>nderlay for <span class="orange">M</span>odules in <span class="orange">PY</span>thon) is a framework for scripts or other external processes to plug into <a href="http://www.ps3mediaserver.org/">PS3 Media Server</a> (or its cousin <a href="http://www.universalmediaserver.com/">UMS</a>) and mainly
<ul>
<li>add folders and media items to the xmb.</li>
<li>act as user-defined external players.</li>
</ul>
The API is accessible from python via jumpy's python module, or from other languages via system calls. Interaction is through a localhost socket managed by <a href="http://py4j.sourceforge.net">py4j</a>.
<br/><br/>
Jumpy began with my having grown tired of occasionally poaching stuff 'by hand' from <a href="http://xbmc.org">xbmc (Kodi)</a> addons for use in PMS, and deciding to see if I could mock the xbmc plugin API itself so as to run these addons under PMS as-is. The result is Jumpy plus <a href="https://github.com/skeptical/jumpy-xbmc">jumpy-xbmc</a>, an included set of python modules to 'jump' the xbmc addons.
<br/><br/>
Jumpy-xbmc works with most Kodi video addons: <i>Hulu, Free Cable, Al Jazeera, PBS, Academic Earth, YouTube</i>, and many more. Addons are 'mostly' functional in the sense that all content is shown but interactive features that require user input are inactive.
<br/><br/>
Jumpy itself is general-purpose, of course, and you can use it to plug your own scripts, python or other, into PMS as well.
<br/><br/>
<!--<div style="border-style: dotted;border-width:1px;margin:-8;padding:8">-->
<b><a name="QUICKSETUP">Quick Setup</a></b>
<!--<ul>-->
<!--<b><a name="INSTALLERS">Using the Installer</a></b>-->
<br/>
<ol>
<div style="text-indent:-1.5em;">
<b>Quickest</b>: install automatically from the UMS <i>Plugin Management</i> tab.
</div>
<br/>
<div style="text-indent:-1.5em;">
Or else use the installer directly:
</div><br/>
<li>Shut down PMS.
</li>
<li>Put the installer <span style="visibility: hidden">.</span>( <span style="visibility: hidden">.</span> <i><a href="http://sourceforge.net/projects/jumpy-plugin/files/jumpy-0.3.10.exe/download" title="Windows: jumpy-0.3.10.exe"><img src="lib/resources/windows.png" alt="Windows" align="absmiddle"></a></i></img>
<span style="visibility: hidden">.</span> <i><a href="http://sourceforge.net/projects/jumpy-plugin/files/jumpy-0.3.10.run/download" title="Linux: jumpy-0.3.10.run"><img src="lib/resources/linux.png" alt="Linux" align="absmiddle"></a></i></img>
<!-- <span style="visibility: hidden">.</span> <i><a href="http://sourceforge.net/projects/jumpy-plugin/files/jumpy-0.3.10.osx.zip/download" title="Mac: jumpy-0.3.10.app (Mountain Lion only). Mavericks users: please run the linux installer (jumpy-0.3.10.run) inside Terminal instead."><img src="lib/resources/mac.png" alt="Mac" align="absmiddle"></a></i></img>-->
<span style="visibility: hidden">.</span> <i><a href="" title="Sorry, Mac app version not available yet. Please launch the linux installer (jumpy-0.3.10.run) inside Terminal instead."><img src="lib/resources/mac.png" alt="Mac" align="absmiddle"></a></i></img>
<span style="visibility: hidden">.</span> )<span style="visibility: hidden">.</span> in your PMS <b><i>plugins</i> folder</b>.
</li>
<li>
Launch it and follow through as usual with external package installers if prompted
(yes, you can install to alternate locations or skip packages if you want).
<br/><br/>
<b>Windows note</b>: if the installer fails try launching it as administrator (<i>right-click > Run as administrator</i>).
</li>
<br/>
<div style="text-indent:-1.5em;">
<!--<b><a name="QUICKER">Even Quicker</a></b>-->
<!--<br/>-->
<!--<b><a name="UMSSETUP">UMS</b> <i>(2.0.1+)</i> <b>users</a></b> : install/update from the <i>Plugin Management</i> tab.-->
<!--<br/>-->
<b><a name="UPDATE">Future updates</a></b> can be installed directly from the <i>jumpy gui</i> panel.
</div>
<br/>
<div style="margin-left:-1.5em;">
You should end up with
<i><code>jumpy</code>, <code>python</code>, <code>py4j</code>, <code>beautifulsoup4</code>, <code>lxml</code>, <code>polib</code>, <code>Kodi</code>, <code>rtmpdump</code>,
<code>phantomjs</code>, <code>youtube-dl</code></i>, and an updated <i>PMS.conf</i> all ready to go and can skip
the grey section below ('mostly', i.e. maybe install
some <a href="#ADDONS"><i>kodi addons</i></a> or
<a href="https://github.com/chocolateboy/pmsencoder"><i>PMSEncoder</i></a>).
</div>
</ol>
<!--</div>-->
<br/>
<div style="background-color:#f7f7f1;margin:-8;padding:8;padding-bottom:2">
<b><a name="REQUIREMENTS">Requirements / Manual Installation</a></b>
<ol>
<li><a href="http://www.python.org/download/releases/2.7.3/#download">Python 2.7</a>.
To make life simpler <a href="http://superuser.com/questions/143119/how-to-add-python-to-the-windows-path/143121#143121">add python to your system path</a>
and then set up <a href="http://pypi.python.org/pypi/setuptools#installation-instructions">easy_install</a>.
</li>
<li>Python modules:
<ul>
<li><a href="http://py4j.sourceforge.net/download.html">py4j</a></li>
<li><a href="http://www.crummy.com/software/BeautifulSoup/">beautifulsoup4</a></li>
<li><a href="http://lxml.de/index.html">lxml</a>
(in Windows must be version 2.3, use <code>easy_install "lxml==2.3"</code>)</li>
</li>
<li><a href="https://bitbucket.org/izi/polib/wiki/Home">polib</a></li>
</ul>
<li>Not required but useful if you're using PMS: <a href="http://rtmpdump.mplayerhq.hu/">rtmpdump</a> and <a href="https://github.com/chocolateboy/pmsencoder">PMSEncoder</a>,
.
</li>
</ol>
<br/>
<b><a name="XBMC">Kodi Installation</a></b> ("optional")
<ol>
<li>Install <a href="http://xbmc.org/download/">Kodi</a> using the default configuration
for your platform.
</li>
<li><a name="ADDONS"></a><a href="http://wiki.xbmc.org/index.php?title=Unofficial_Add-on_Repositories">Install and configure</a>
some <a href="http://wiki.xbmc.org/index.php?title=Category:All_add-ons">addons</a>
inside Kodi (and of course test them too, some are broken). You may need to configure username/password depending
on the addon, and so on.
</li>
</ol>
<br/>
<b><a name="PHANTOMJS">PhantomJS Installation</a></b> (optional)
<ul>
To use the included <a href="#WEBREADER">webreader</a> browser install <a href="http://phantomjs.org/download.html">phantomjs</a>
in one of these places:
<br/>
<ul>
<li>inside your PMS installation's binaries folder (i.e. in <i>win32</i>, <i>linux</i> or <i>osx</i>).</li>
<li>or inside the <i>plugins/jumpy/webreader</i> folder.</li>
<li>or anywhere, adding its binary folder path to the <code>bin.path</code> setting in <i>PMS.conf</i>
(create it if it doesn't exist):
<ul><code>bin.path = c:\\path\\to\\phantomjsFolder</code></ul></li>
</ul>
</ul>
<br/>
<b><a name="INSTALLATION">Plugin Installation</a></b>
<ol>
<li>Unzip <i><a href="http://sourceforge.net/projects/jumpy-plugin/files/jumpy-0.3.10.zip/download">jumpy-0.3.10.zip</a></i> to your PMS <i>plugins</i> folder.
</li>
<li>Open up <i>PMS.conf</i> and set <code>python.path</code>, e.g.
<pre>python.path = c:\\Python27\\python</pre>
If you're using rtmpdump, or want to enable a script language, let's say perl, create
a <code>.path</code> for each if it doesn't already exist:
<pre>
rtmpdump.path = c:\\rtmpdump\\rtmpdump.exe
perl.path = c:\\perl\\bin\\perl.exe
</pre>
</li>
<li>Restart PMS. You should see a 'Jumpy' folder on the xmb containing the examples and any
media addons found in your Kodi user directory.
</li>
</ol>
<b><a name="MANUALUPDATE">Updating</a></b>
<ul>
When updating by hand you may want to merge any new sections or changes in
<i>plugins/jumpy/examples/sample-jumpy-scripts.ini</i>
into your own <i><a href="#SCRIPTSINI">jumpy-scripts.ini</a></i>.
</ul>
</div>
<br/><br/>
<b><a name="SHORTPATHS">Windows Short Paths</a></b>
<ul>
In Windows jumpy uses several 'short' paths (e.g. in the <a href="scripts.html#OTHERSCRIPTS"><code><span class="orange">pms</span></code></a> and <code><span class="orange">imconvert</span></code> variables)
to circumvent space-containing path errors when invoking <i>cmd.exe</i>, which requires that
<a href="https://en.wikipedia.org/wiki/8.3_filename">8dot3 filenames</a>
be available on your file system.
<br/><br/>
You can check whether 8dot3 filenames are currently enabled using <a href="https://technet.microsoft.com/en-us/library/ff621566.aspx">fsutil</a>,
by opening a command window and typing
<pre>fsutil 8dot3name query c:</pre>
If you see warnings about 8dot3 short paths in <b><i>jumpy.log</i></b> or the jumpy installer, it means that short filenames
are (or were) disabled on your system, possibly as a result of running a system optimizer utility at some point,
and you will need to create the required short paths using the following (unfortunately somewhat painful) method:
<br/><br/>
<ul>
<li>Ensure the target directories are not in use by the system:
<ul>
<li>If the warnings show paths with "<code>Program Files</code>" reboot Windows in Safe Mode with command prompt.
The reason for this is that in normal mode the <i>Program Files</i> folders are always in use by running programs,
so the system won't allow any changes (e.g. setting short names).</li>
<li>Otherwise make sure PMS/UMS is not running and open a command window.</li>
</ul>
<br/>
<li>Enable 8dot3 (with prompt at drive c:):<pre>fsutil behavior set disable8dot3 0</pre></li>
<li>Set short names for your Program Files and/or PMS/UMS directories as appropriate, i.e. run one or more of the
following commands:
<pre>fsutil file setshortname "Program Files" PROGRA~1
fsutil file setshortname "Program Files (x86)" PROGRA~2
fsutil file setshortname "Program Files (x86)\Universal Media Server" UNIVER~1
fsutil file setshortname "Program Files (x86)\PS3 Media Server" PS3MED~1
</pre>
</li>
<li>(Optional) set the 8dot3name behavior back to the original setting (returned by the initial query cmd, e.g. 1).
Please note that doing this may cause other similar errors in the future.
<pre>fsutil behavior set disable8dot3 1</pre>
</li>
</ul>
Note that the above applies to a default installation on drive c. If UMS/PMS is installed at a non-standard location
you will need to adjust the commands accordingly.
</ul>
<br/>
<b><a name="BOOKMARKS">Bookmarks</a></b>
<ul>
Press the <i>Add bookmark</i> button in any folder to create a bookmark inside <i> Jumpy > Bookmarks</i>. These are saved to <b><i>jumpy-bookmarks.ini</i></b> in your PMS profile folder (wherever <i>PMS.conf</i> is). You can edit this file, for instance to change the labels or reorder the items.
</ul>
<br/>
<b><a name="LOGCONF">Log and Conf</a></b>
<ul>
Locations are according to your PMS installation (for quick access use the buttons on gui panel, otherwise see jumpy's init messages inside your <i>debug.log</i> for the specific paths):<br/><br/>
<ul>
<li><b><i>jumpy.log</i></b>: located wherever <i>debug.log</i> is.
</li><br/>
<li><a name="JUMPYCONF"><b><i>jumpy.conf</i></b>: located wherever <i>PMS.conf</i> is.
The available settings are:
<pre><i class="comment"># whether to activate bookmarks (true|false)</i>
<b>bookmarks</b>=true
<i class="comment"># whether to qualify the bookmark name (true|false)
# e.g. 'Live :ESPN' instead of just 'Live'</i>
<b>verbose_bookmarks</b>=true
<i class="comment"># how often to refresh folder content in minutes
# (-1=never|0=always|1=one minute)</i>
<b>refresh</b>=60
<i class="comment"># whether to check for updates (true|false)</i>
<b>check_update</b>=true
<i class="comment"># whether to copy log output to the console (true|false)</i>
<b>debug</b>=false
<i class="comment"># whether to act as a url resolver (true|false)</i>
<b>url_resolver</b>=true
</pre>
</li>
<li><a name="PMSCONF"></a><b><i>PMS.conf</i></b>:
<a name="CONF_XBMC"></a>If you need to override the locations where jumpy looks for Kodi set:
<pre>
<i class="comment"># kodi/xbmc user folder</i>
<b>xbmc.home.path</b> = c:\\path\\to\\my\\XBMC
<i class="comment"># kodi/xbmc program folder</i>
<b>xbmc.main.path</b> = c:\\path\\to\\program\\Kodi
</pre>
<a name="CONF_BINPATH"></a>You can set paths where external binaries needed by your scripts can be found,
separating them with '<code><span class="orange">;</span></code>' in Windows or '<code><span class="orange">:</span></code>' in linux/mac:
<pre>
<b>bin.path</b> = c:\somewhere\bin<span class="orange">;</span>c:\somewhere else
</pre>
You<a name="CONF_EDITOR"> can also specify your preferred text editor for opening files from the gui:
<pre>
<b>text.editor</b> = c:\\path\\to\\my\\textEditor
</pre>
See also <a href="#RESOLVER">Resolver</a> and
<a href="scripts.html#INTERPRETERS">Interpreters</a> for more <i>PMS.conf</i> settings.
</li><br/>
</ul>
</ul>
<b><a name="BUGS">Bugs</a></b>
<ul>
When reporting bugs please <a href="http://www.ps3mediaserver.org/forum/viewtopic.php?f=6&t=3507&p=38484#p38484">set logging to TRACE</a> and attach these together as one zip file (or use the <a href="https://github.com/SharkHunter/DbgPack">DbgPack</a> plugin):
<ul>
<i>•PMS.conf •debug.log •jumpy.log •jumpy-scripts.ini •pmsencoder.log</i>
</ul>
</ul>
<br/>
<b><a name="SCRIPTSINI">jumpy-scripts.ini</a></b>
<ul>
Scripts are registered with jumpy via entries inside the user file <i>jumpy-scripts.ini</i>, which is located wherever
<i>PMS.conf</i> is in your setup. For quick access use the button on the gui.
<br/><br/>
Each script has its own section, where the section name <code>[...]</code> is also the label, interpreted as a
<a href="scripts.html#UNIXPATH"/>unix-style path</a> branching from jumpy's top folder:
<ul>
<pre>
[My Scripts/foo]
cmd = c:\path\to\foo.bat arg1 arg2
</pre>
</ul>
unless it begins with a '<code><span class="orange">+</span></code>' or '<code><span class="orange">-</span></code>',
in which case it will be executed automatically at startup or shutdown respectively (and the rest of
the label is irrelevant):
<ul>
<pre>
[<span class="orange">+</span>hi]
cmd = c:\path\to\hello.bat
[<span class="orange">-</span>bye]
cmd = c:\path\to\goodbye.bat
</pre>
</ul>
To disable a script put a '<code><span class="orange">#</span></code>' at the beginning of
the section name:
<ul>
<pre>
[<span class="orange">#</span>+hi]
cmd = c:\path\to\hello.bat
</pre>
</ul>
If <code>cmd</code> begins with the keyword <code><span class="orange">pms</span></code> it will be
interpreted as an API call using <i><a href="scripts.html#OTHERSCRIPTS">command-line syntax</a></i>. The entry
below is equivalent to the first example above:
<ul>
<pre>
[<span class="orange">+</span>foo]
cmd = <span class="orange">pms</span> addFolder "My Scripts/foo" "c:\path\to\foo.bat arg1 arg2"
</pre>
</ul>
</ul>
<br/>
<b><a name="WEBREADER">Webreader</a></b>
<ul>
<i>Webreader</i> is a "poor man's" browser for PMS, which takes a snapshot of a given
web page and streams it as video. The view pans left to right (or optionally
right to left) and top to bottom in 4 second shots across the page. It requires <a href="#PHANTOMJS">PhantomJS</a>
to be installed.
<br/><br/>
Try one of the web pages
in the <i>Web Reader</i> folder on the xmb to see how it works, but basically:
<br/>
<ul>
<li>Press <b><i>pause</i></b> to stop panning and read, press again to continue.</li>
<li>Pressing <b><i>back</i></b> takes you to the top of the page (on my Sony Bluray anyway,
your renderer may behave differently).</li>
</ul>
<br/>
To add web pages edit the <code>[+webreader]</code> section of
<i><a href="#SCRIPTSINI">jumpy-scripts.ini</a></i>, adding one page per line in this form:
<ul><pre>data = <i>name, url, [style, thumb]</i></pre></ul>
where
<ul>
<br/>
<li><code>name</code> is the item's label (or <a href="scripts.html#UNIXPATH">unix-style path</a>).
</li>
<li><code>url</code> is the address of the web page.
</li>
<li><code>style</code> is an optional field to control presentation and playback using this syntax:
<ul><i><code class="comment">format<span class="orange">:</span>delay_seconds<span class="orange">:</span>buffer_mb<span class="orange">+</span>pan<span class="orange">:</span>rdb_style<span class="orange">:</span>rdb_size<span class="orange">:</span>rdb_margin</code></i></ul>
where
<ul>
<li><code class="comment"><i>format</i></code> is the only required part and is either:
<ul>
<li><code>webpage</code> which is the default.
Here <code class="comment"><i>pan</i></code> can be
<ul>
<li><code>rtl</code> for right to left panning.</li>
<li><code>graphics</code> which maximizes the vertical overlap and is better suited to
viewing images as opposed to reading text.</li>
<li>or both, e.g. <code>webpage<span class="orange">+</span>rtl<span class="orange">:</span>graphics</code>.</li>
</ul>
</li>
</li>
<li><code>readability</code> (or <code>rdb</code>) which uses the arc90labs
<a href="http://code.google.com/p/arc90labs-readability/">readability</a>
script to clean up web pages into stripped-down article-like versions for easy
reading.
<ul>
<li><code class="comment"><i>rdb_style</i></code> is either <code>newspaper</code> (default), <code>novel</code>, <code>ebook</code>,
<code>terminal</code>, <code>apertura</code>, or <code>athelas</code>.
</li>
<li><code class="comment"><i>rdb_size</i></code> (font) is either <code>x-small</code>, <code>small</code>, <code>medium</code> (default),
<code>large</code>, or <code>x-large</code>.
</li>
<li><code class="comment"><i>rdb_margin</i></code> is either <code>x-narrow</code>, <code>narrow</code>, <code>medium</code> (default),
<code>wide</code>, or <code>x-wide</code>.
</li>
</ul>
see <i>jumpy/webreader/readability.css</i> (and edit it too if you like).
</li>
</ul>
<li><code class="comment"><i>delay_seconds<span class="orange">:</span>buffer_mb</i></code> are <a href="scripts.html#PLAYBACK">playback</a> settings.
</li>
</ul>
<li><code>thumb</code> is an image file or a pre-defined <a href="scripts.html#ICONS">icon</a>.
</li>
</ul>
<br/>
Some examples:
<pre>
<i class="comment">; a typical page (webpage format by default)</i>
data = My Pages/p1, http://www.foo.org/index.html
<i class="comment">; a page in readabilty format</i>
data = My Pages/p2, http://www.foo.org/article.html, rdb
<i class="comment">; an rtl page in webpage format with a 10s delay</i>
data = My Pages/p3, http://www.foo.org/index.html, webpage<span class="orange">:</span>10<span class="orange">+</span>rtl
<i class="comment">; a page in readabilty novel format with a 10s delay and large font</i>
data = My Pages/p4, http://www.foo.org/article.html, rdb<span class="orange">:</span>10<span class="orange">+</span>novel<span class="orange">:</span>large
</pre>
you can also include a <i>csv</i> file
<ul><pre>data = <i>name, filename.csv, [style, thumb]</i></pre></ul>
where the <i>csv</i> file looks like this:
<pre>
<i class="comment"># csv columns are: label, url, [style, thumb]
# default style is webpage
# comments and blank lines are allowed</i>
My Pages/p1, http://www.foo.org/index.html
My Pages/p2, http://www.foo.org/article.html, rdb
My Pages/p3, http://www.foo.org/index.html, webpage<span class="orange">:</span>10<span class="orange">+</span>rtl
My Pages/p4, http://www.foo.org/article.html, rdb<span class="orange">:</span>10<span class="orange">+</span>novel<span class="orange">:</span>large
</pre>
</ul>
<br/>
<b><a name="FEEDREADER">Feedreader</a></b>
<ul>
<i>Feedreader</i> loads rss feeds for browsing with webreader. Usage is similar to webreader
except that the default style is <code>readability</code>.
<br/><br/>
To add feeds edit the <code>[+feedreader]</code> section of
<i><a href="#SCRIPTSINI">jumpy-scripts.ini</a></i>, adding one feed per line in this form:
<ul><pre>data = <i>name, feedurl, [style, thumb]</i></pre></ul>
or a <i>csv</i> file containing feed urls
<ul><pre>data = <i>name, filename.csv, [style, thumb]</i></pre></ul>
where the <i>csv</i> file looks like this:
<pre>
<i class="comment"># csv columns are: label, url, [style, thumb]
# default style is readability
# comments and blank lines are allowed</i>
World news/World news, http://www.guardian.co.uk/world/, webpage:10
World news/World news, http://www.guardian.co.uk/world/rss
World news/UK, http://www.guardian.co.uk/uk/rss
World news/Europe, http://www.guardian.co.uk/world/europe/roundup/rss
</pre>
</ul>
<br/>
<b><a name="RESOLVER">Resolver</a></b>
<ul>
Jumpy acts as a url resolver for unresolved <i>WEB.conf</i> items (youtube, vimeo, many more)
in UMS if it can find either the
<i>Kodi urlresolver addon</i>
or the <i>youtube-dl python library</i>.
<br/><br/>
Both are automatically added by the jumpy installer and require no special setup,
but you may wish to note the following details:
<ul>
<br/>
<li><b>Kodi</b>: two new addons are auto-installed:
<ul>
<li>script.module.jumpy <i class="comment">(Programs>jumpy)</i></li>
<li>repository.jumpy.addons <i class="comment">(System>Add-ons>Get Add-ons>jumpy repo)</i></li>
</ul>
Restart Kodi and you should see
a brief update notice for the '<i>jumpy</i>' addon, which just means that <i>urlresolver</i> and
<i>youtube</i> are being added if not already present. You can then uninstall the new jumpy
addons if you like.
</li>
<br/>
<li><b>youtube-dl</b>: There's no general reason to change anything in Linux/OS-X,
but <u><i>If you're on Windows and have the Channels Plugin</i></u> (which
already resolves using youtube-dl in Windows) you may want to disable it in the jumpy config gui.
</li>
</ul>
<br/>
Alternatively, you can of course install these resolvers by hand:
<br/><br/>
<ul>
<li>Install from zip in Kodi: <a href="http://mirrors.xbmc.org/addons/gotham/script.module.urlresolver/">script.module.urlresolver</a>
</li>
<li>Download <a href="http://rg3.github.io/youtube-dl/download.html">youtube-dl</a>'s
latest <i>Full source tarball</i>, untar and point
to its <i><span class="orange">youtube_dl</span></i> subfolder in <i>UMS.conf</i>:
<pre>
<b>youtube-dl.lib.path</b> = c:\\path\\to\\youtube-dl\\<span class="orange">youtube_dl</span>
</pre>
</li>
</ul>
</ul>
<br/>
<b><a name="EARMARKER">Earmarker</a></b>
<ul>
Earmarker is a service to bookmark your browser's current page for media scanning
in UMS/PMS, allowing you to instantly add its linked/embedded media to the xmb.
It requires <a href="#REQUIREMENTS">beautifulsoup4</a> (automatically added by the installer).
<br/><br/>
The Earmark server is enabled by default. For browser setup instructions open the server home page:
<br/><br/>
<ul>
<li>If this browser is on the same device as PMS/UMS, go to <i><a href="http://127.0.0.1:8989" target="_blank">127.0.0.1:8989</a></i>.
</li>
<br/>
<li>If this browser is on a different device, type <code><span class="orange">IP_ADDRESS</span>:8989</code> in the address bar,
where <code><span class="orange">IP_ADDRESS</span></code> is the LAN IP
of the device running PMS/UMS (for example <i><b>192.168.1.3</b>:8989</i>).
</li>
</ul>
<br/>
Once your browser is set up:
<br/><br/>
<ul>
<li>Press 'earmark' on any web page with media content (you should then see an '<i>Earmarked</i>' notice).
</li>
<br/>
<li>Look inside its earmark folder on the xmb to see any discovered items, at
<ul>
<li><i>/Jumpy/Earmarks</i> (default)
</li>
<li>or wherever else you specify by setting
'<code style="color:#0000BB;"><b>earmarks</b>=/some/where</code>'
in <i>PMS.conf</i>
</li>
</ul>
</li>
</ul>
<br/>
Caveats:
<br/><br/>
<ul>
<li>This feature works to the extent that content is plainly evident
and/or recognized by the available <a href="#RESOLVER">resolvers</a>.
</li>
<br/>
<li>For <i><b>https</b></i> pages be aware that some recent browsers (e.g. <a href="https://developer.mozilla.org/en-US/docs/Security/MixedContent">firefox 23+</a>)
will block mixed content, which means that the earmark button can't connect to its <i><b>http</b></i> server.
In this case (e.g. youtube) the workaround is to go to the <i><b>http</b></i> version of the page if one exists and retry.
</li>
</ul>
</ul>
<br/>
<b><a name="CAPTURE">Capture</a></b>
<ul>
Capture is a script to discover and stream system media sources (e.g. computer screen, video cam, audio card) to your renderer.
It's basically a wrapper around <a href="http://ffmpeg.org/ffmpeg-devices.html">ffmpeg devices support</a>. Some notes:
<br/><br/>
<ul>
<li>Discovered devices (in various A/V combinations) are listed inside the <i><b>Devices</b></i> folder in the xmb root.
</li>
<br/>
<li>Windows:
<ul>
<li>Directshow devices are supported, VFW is not.
</li>
<li>For screencasting install any/all of these directshow filters:
<ul>
<li><i>x86 edition</i> of <a href="http://www.umediaserver.net/components/index.html">UScreenCapture</a> from Unreal Media.</li>
<li><a href="https://github.com/rdp/screen-capture-recorder-to-video-windows-free">screen-capture-recorder</a>.</li>
<li><a href="https://github.com/rdp/virtual-audio-capture-grabber-device">virtual-audio-capture-grabber</a>.</li>
</ul>
</li>
</ul>
</li>
<br/>
<li>Linux: Only screencasting is implemented and X11 display screens are automatically detected assuming your ffmpeg has been compiled with <a href="http://ffmpeg.org/ffmpeg-devices.html#x11grab">x11grab</a> enabled
(which is not true for the linux ffmpeg binaries shipped with UMS).
</li>
<br/>
<li>OS-X: Sorry, no device capture support in ffmpeg.
</li>
<br/>
<li>There's a transcoding delay of 10 seconds or more, so this isn't really practical for real-time uses
such as interacting with your desktop. See <a href="http://www.universalmediaserver.com/forum/viewtopic.php?f=9&t=907&p=10670#p10675">here</a>
for some more hands-on user notes.
</li>
</ul>
</ul>
</ul>
</ul>
<br/>
</div>
</body>
</html>
<!--http://wiki.xbmc.org/index.php?title=Python_Development-->