|
1 | | -# Streamlink |
| 1 | +# [Streamlink][streamlink-website] |
2 | 2 |
|
3 | | -[](#backers) [](#sponsors) [](https://travis-ci.org/streamlink/streamlink) |
4 | | -[](http://codecov.io/github/streamlink/streamlink?branch=master) |
| 3 | +[![TravisCI build status][travisci-build-status-badge]][travisci-build-status] |
| 4 | +[![codecov.io][codecov-coverage-badge]][codecov-coverage] [![Backers on Open Collective][opencollective-backers-badge]](#backers) [![Sponsors on Open Collective][opencollective-sponsors-badge]](#sponsors) |
5 | 5 |
|
6 | 6 | Streamlink is a CLI utility that pipes flash videos from online streaming services to a variety of video players such as VLC, or alternatively, a browser. |
7 | 7 |
|
8 | 8 | The main purpose of streamlink is to convert CPU-heavy flash plugins to a less CPU-intensive format. |
9 | 9 |
|
10 | | -Streamlink is a fork of the [livestreamer](https://github.com/chrippa/livestreamer) project. |
| 10 | +Streamlink is a fork of the [Livestreamer][livestreamer] project. |
11 | 11 |
|
12 | 12 | Please note that by using this application you're bypassing ads run by |
13 | 13 | sites such as Twitch.tv. Please consider donating or paying for subscription |
14 | 14 | services when they are available for the content you consume and enjoy. |
15 | 15 |
|
16 | | -# Installation |
17 | 16 |
|
18 | | -Streamlink can be installed by using Python or through the installers below. |
| 17 | +# [Installation][streamlink-installation] |
19 | 18 |
|
20 | | -**Installation via Python pip:** |
21 | | -``` |
| 19 | +#### Installation via Python pip |
| 20 | + |
| 21 | +```bash |
22 | 22 | sudo pip install streamlink |
23 | 23 | ``` |
24 | | -Note: For Windows, omit "sudo" |
25 | 24 |
|
26 | | -**Manual installation via Python:** |
27 | | -``` |
| 25 | +#### Manual installation via Python |
| 26 | + |
| 27 | +```bash |
28 | 28 | git clone https://github.com/streamlink/streamlink |
29 | 29 | sudo python setup.py install |
30 | 30 | ``` |
31 | 31 |
|
32 | | -**Installers for Windows/Mac/Linux:** |
33 | | - |
34 | | - - [Mac OSX](https://streamlink.github.io/install.html#other-platforms) |
35 | | - |
36 | | - - [Windows](https://streamlink.github.io/install.html#windows-binaries) |
| 32 | +#### Windows, MacOS, Linux and BSD specific installation methods |
37 | 33 |
|
38 | | - - [Windows portable version](https://streamlink.github.io/install.html#windows-portable-version) |
| 34 | +- [Windows][streamlink-installation-windows] |
| 35 | +- [Windows portable version][streamlink-installation-windows-portable] |
| 36 | +- [MacOS][streamlink-installation-others] |
| 37 | +- [Linux and BSD][streamlink-installation-linux] |
39 | 38 |
|
40 | | - - [Linux and BSD](https://streamlink.github.io/install.html#linux-and-bsd-packages) |
41 | 39 |
|
42 | 40 | # Features |
43 | 41 |
|
44 | 42 | Streamlink is built via a plugin system which allows new services to be easily added. |
45 | 43 |
|
46 | | -Major streaming services such as: |
47 | | - - [Dailymotion](http://dailymotion.com/live) |
48 | | - - [Livestream](https://livestream.com) |
49 | | - - [Twitch](http://twitch.tv) |
50 | | - - [UStream](http://ustream.tv) |
51 | | - - [YouTube Live](http://youtube.com) |
| 44 | +Supported streaming services, among many others, are: |
52 | 45 |
|
53 | | -Are supported. |
| 46 | +- [Dailymotion](https://www.dailymotion.com) |
| 47 | +- [Livestream](https://livestream.com) |
| 48 | +- [Twitch](https://www.twitch.tv) |
| 49 | +- [UStream](http://www.ustream.tv) |
| 50 | +- [YouTube Live](https://www.youtube.com) |
54 | 51 |
|
55 | | -A full list of plugins can be found on the [plugin page](https://streamlink.github.io/plugin_matrix.html). |
| 52 | +A list of all supported plugins can be found on the [plugin page][streamlink-plugins]. |
56 | 53 |
|
57 | 54 |
|
58 | 55 | # Quickstart |
59 | 56 |
|
60 | | -After installation simply use: |
| 57 | +After installing, simply use: |
| 58 | + |
61 | 59 | ``` |
62 | | -streamlink twitch.tv/lirik source |
| 60 | +streamlink STREAMURL best |
63 | 61 | ``` |
64 | 62 |
|
65 | | -And Streamlink will automatically open a default video player and begin streaming! |
66 | | - |
67 | | -For full details on how to use Streamlink visit our documentation at [streamlink.github.io](https://streamlink.github.io) |
| 63 | +Streamlink will automatically open the stream in its default video player! |
| 64 | +See [Streamlink's detailed documentation][streamlink-documentation] for all available configuration options, CLI parameters and usage examples. |
68 | 65 |
|
69 | 66 |
|
70 | 67 | # Contributing |
71 | 68 |
|
72 | | -Feel free to open a bug or contribute to code! |
73 | | - |
74 | | -No need to go through a large CONTRIBUTING.md doc. The only requirement being that we get at least one ACK from a maintainer. Fork / clone us and open a PR! |
| 69 | +All contributions are welcome. |
| 70 | +Feel free to open a new thread on the issue tracker or submit a new pull request. |
| 71 | +Please read [CONTRIBUTING.md][contributing] first. Thanks! |
75 | 72 |
|
76 | | -<a href="graphs/contributors"><img src="https://opencollective.com/streamlink/contributors.svg?width=890" /></a> |
| 73 | +[![Contributors][opencollective-contributors]][contributors] |
77 | 74 |
|
78 | 75 |
|
79 | 76 | ## Backers |
80 | 77 |
|
81 | | -Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/streamlink#backer)] |
| 78 | +Thank you to all our backers! \[[Become a backer][opencollective-backer]\] |
82 | 79 |
|
83 | | -<a href="https://opencollective.com/streamlink#backers" target="_blank"><img src="https://opencollective.com/streamlink/backers.svg?width=890"></a> |
| 80 | +[![Backers on Open Collective][opencollective-backers-image]][opencollective-backers] |
84 | 81 |
|
85 | 82 |
|
86 | 83 | ## Sponsors |
87 | 84 |
|
88 | | -Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/streamlink#sponsor)] |
89 | | - |
90 | | -<a href="https://opencollective.com/streamlink/sponsor/0/website" target="_blank"><img src="https://opencollective.com/streamlink/sponsor/0/avatar.svg"></a> |
91 | | -<a href="https://opencollective.com/streamlink/sponsor/1/website" target="_blank"><img src="https://opencollective.com/streamlink/sponsor/1/avatar.svg"></a> |
92 | | -<a href="https://opencollective.com/streamlink/sponsor/2/website" target="_blank"><img src="https://opencollective.com/streamlink/sponsor/2/avatar.svg"></a> |
93 | | -<a href="https://opencollective.com/streamlink/sponsor/3/website" target="_blank"><img src="https://opencollective.com/streamlink/sponsor/3/avatar.svg"></a> |
94 | | -<a href="https://opencollective.com/streamlink/sponsor/4/website" target="_blank"><img src="https://opencollective.com/streamlink/sponsor/4/avatar.svg"></a> |
95 | | -<a href="https://opencollective.com/streamlink/sponsor/5/website" target="_blank"><img src="https://opencollective.com/streamlink/sponsor/5/avatar.svg"></a> |
96 | | -<a href="https://opencollective.com/streamlink/sponsor/6/website" target="_blank"><img src="https://opencollective.com/streamlink/sponsor/6/avatar.svg"></a> |
97 | | -<a href="https://opencollective.com/streamlink/sponsor/7/website" target="_blank"><img src="https://opencollective.com/streamlink/sponsor/7/avatar.svg"></a> |
98 | | -<a href="https://opencollective.com/streamlink/sponsor/8/website" target="_blank"><img src="https://opencollective.com/streamlink/sponsor/8/avatar.svg"></a> |
99 | | -<a href="https://opencollective.com/streamlink/sponsor/9/website" target="_blank"><img src="https://opencollective.com/streamlink/sponsor/9/avatar.svg"></a> |
100 | | - |
101 | | - |
| 85 | +Support this project by becoming a sponsor. Your logo will show up here with a link to your website. \[[Become a sponsor][opencollective-sponsor]\] |
| 86 | + |
| 87 | +[](https://opencollective.com/streamlink/sponsor/0/website) |
| 88 | +[](https://opencollective.com/streamlink/sponsor/1/website) |
| 89 | +[](https://opencollective.com/streamlink/sponsor/2/website) |
| 90 | +[](https://opencollective.com/streamlink/sponsor/3/website) |
| 91 | +[](https://opencollective.com/streamlink/sponsor/4/website) |
| 92 | +[](https://opencollective.com/streamlink/sponsor/5/website) |
| 93 | +[](https://opencollective.com/streamlink/sponsor/6/website) |
| 94 | +[](https://opencollective.com/streamlink/sponsor/7/website) |
| 95 | +[](https://opencollective.com/streamlink/sponsor/8/website) |
| 96 | +[](https://opencollective.com/streamlink/sponsor/9/website) |
| 97 | + |
| 98 | + |
| 99 | + [streamlink-website]: https://streamlink.github.io |
| 100 | + [streamlink-plugins]: https://streamlink.github.io/plugin_matrix.html |
| 101 | + [streamlink-documentation]: https://streamlink.github.io/cli.html |
| 102 | + [streamlink-installation]: https://streamlink.github.io/install.html |
| 103 | + [streamlink-installation-windows]: https://streamlink.github.io/install.html#windows-binaries |
| 104 | + [streamlink-installation-windows-portable]: https://streamlink.github.io/install.html#windows-portable-version |
| 105 | + [streamlink-installation-linux]: https://streamlink.github.io/install.html#linux-and-bsd-packages |
| 106 | + [streamlink-installation-others]: https://streamlink.github.io/install.html#other-platforms |
| 107 | + [livestreamer]: https://github.com/chrippa/livestreamer |
| 108 | + [contributing]: https://github.com/streamlink/streamlink/blob/master/CONTRIBUTING.md |
| 109 | + [changelog]: https://github.com/streamlink/streamlink/blob/master/CHANGELOG.rst |
| 110 | + [contributors]: https://github.com/streamlink/streamlink/graphs/contributors |
| 111 | + [travisci-build-status]: https://travis-ci.org/streamlink/streamlink |
| 112 | + [travisci-build-status-badge]: https://travis-ci.org/streamlink/streamlink.svg?branch=master |
| 113 | + [codecov-coverage]: https://codecov.io/github/streamlink/streamlink?branch=master |
| 114 | + [codecov-coverage-badge]: https://codecov.io/github/streamlink/streamlink/coverage.svg?branch=master |
| 115 | + [opencollective-contributors]: https://opencollective.com/streamlink/contributors.svg?width=890 |
| 116 | + [opencollective-backer]: https://opencollective.com/streamlink#backer |
| 117 | + [opencollective-backers]: https://opencollective.com/streamlink#backers |
| 118 | + [opencollective-backers-image]: https://opencollective.com/streamlink/backers.svg?width=890 |
| 119 | + [opencollective-sponsor]: https://opencollective.com/streamlink#sponsor |
| 120 | + [opencollective-backers-badge]: https://opencollective.com/streamlink/backers/badge.svg |
| 121 | + [opencollective-sponsors-badge]: https://opencollective.com/streamlink/sponsors/badge.svg |
0 commit comments