aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Christopher Rosell <chrippa@tanuki.se>2012-09-19 17:56:25 +0200
committerGravatar Christopher Rosell <chrippa@tanuki.se>2012-09-19 17:56:25 +0200
commit8124016735082c3d002ab087155dcd1fce1fedaa (patch)
treefe57c31228da54c62541ff2048e25201060c9846 /README.md
parent0b257e92035f727062ded0e5565222567345bcdc (diff)
Release version 1.3.
Diffstat (limited to 'README.md')
-rw-r--r--README.md44
1 files changed, 29 insertions, 15 deletions
diff --git a/README.md b/README.md
index c2ce3e6..bbc0cfc 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,6 @@
Livestreamer
============
-Livestreamer is a CLI program that launches streams from various
-streaming services in a custom video player.
+Livestreamer is a CLI program that launches live streams from various streaming services in a custom video player.
Currently supported sites are:
@@ -13,35 +12,47 @@ Currently supported sites are:
* UStream
* YouTube
-Note: Justin.tv plugin requires rtmpdump with jtv token support (recent git).
-Livestreamer is compatible with Python version >= 2.6 and >= 3.0.
+Dependencies
+------------
+Livestreamer and it's plugins currently depends on these software:
+
+* Python version >= 2.6 and >= 3.0 (currently CPython and PyPy is known to work)
+* python-setuptools or python-distribute
+* python-requests (at least version 0.12.1)
+* python-pbs
+* python-argparse (only needed for Python version < 2.7)
+
+For RTMP based plugins:
+* librtmp/rtmpdump (git clone after 2011-07-31 is needed for Twitch/JustinTV plugin)
Installing (Linux, OS X etc)
----------
-Make sure you have Python and Python setuptools then run:
+Make sure you have at least Python and python-setuptools then run:
$ sudo python setup.py install
+This should install any missing Python dependencies automatically if they are missing.
+
Installing (Windows)
--------------------
1. Install Python
2. Install Python setuptools
-3. Get rtmpdump and unpack it somewhere (rtmpdump-20110925-git-6230845-win32.zip from http://rtmpdump.mplayerhq.hu/ should work)
+3. Get rtmpdump and unpack it somewhere (rtmpdump-20110925-git-6230845-win32.zip from the downloads section should work)
4. Add these paths to your Path environment variable:
- * [Python path]\
- * [Python path]\scripts\
- * [rtmpdump path]\ (or specify full path with --rtmpdump option)
- * [VLC/mplayer/other path]\ (or specify full path with --player option)
+ * [Python path]\
+ * [Python path]\scripts\
+ * [rtmpdump path]\ (or specify full path with --rtmpdump option)
+ * [VLC/mplayer/other path]\ (or specify full path with --player option)
5. Open a command prompt and change directory to livestreamer source, then run:
python setup.py install
-Note: If you want to use VLC be aware there is currently a bug in version 2.0.1/2.0.2
-that prevents stdin reading from working. The bug has been fixed in version 2.0.3.
+This should install any missing Python dependencies automatically if they are missing.
+
Using
@@ -51,9 +62,11 @@ Using
Common issues
-------------
-**Issue:** livestreamer errors with "Unable to read from stream" or "Error while executing subprocess" on Twitch/JustinTV streams.
+**livestreamer errors with "Unable to read from stream" or "Error while executing subprocess" on Twitch/JustinTV streams.**
+When building rtmpdump from source it may link with a already existing (probably older) librtmp version instead of using it's own version. On Debian/Ubuntu it is recommended to use the official packages of *librtmp0* and *rtmpdump* version *2.4+20111222.git4e06e21* or newer. This version contains the necessary code to play Twitch/JustinTV streams and avoids any conflicts. It should be available in the testing or unstable repositories if it's not available in stable yet.
-**Solution:** When building rtmpdump from source it may link with a already existing (probably older) librtmp version instead of using it's own version. On Debian/Ubuntu it is recommended to use the official packages of *librtmp0* and *rtmpdump* version *2.4+20111222.git4e06e21*. This version contains the necessary code to use Twitch/JustinTV streams and avoids any conflicts. It should be available in the testing or unstable repositories if it's not available in stable yet.
+**VLC on Windows failes to play with a error message.**
+VLC version 2.0.1 and 2.0.2 contains a bug that prevents it from reading data from stdin. This has been fixed in version 2.0.3.
Saving arguments AKA config file
@@ -62,7 +75,8 @@ Livestreamer can read arguments from the file ~/.livestreamerrc (POSIX) or %APPD
A example file:
player=mplayer
- jtv-cookie=_jtv3_session_id=arandomhash
+ gomtv-username=username
+ gomtv-password=password
Using livestreamer as a library