|
1 |
| -# [Streamlink][streamlink-website] |
| 1 | +<h1 align="center"><a href="https://streamlink.github.io/">Streamlink<br><img height="150" alt="Streamlink" src="https://raw.githubusercontent.com/streamlink/streamlink/master/icon.svg"></a></h1> |
2 | 2 |
|
3 |
| -[![Github build status][workflow-status-badge]][workflow-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) |
| 3 | +<p align="center"> |
| 4 | + <a href="https://streamlink.github.io/install.html"><img alt="Supported Python versions" src="https://img.shields.io/pypi/pyversions/streamlink.svg?style=flat-square&maxAge=86400"></a> |
| 5 | + <a href="https://streamlink.github.io/changelog.html"><img alt="Latest release" src="https://img.shields.io/github/release/streamlink/streamlink.svg?style=flat-square&maxAge=86400"></a> |
| 6 | + <a href="https://github.com/streamlink/streamlink"><img alt="License" src="https://img.shields.io/github/license/streamlink/streamlink.svg?style=flat-square&maxAge=86400"></a> |
| 7 | + <a href="https://github.com/streamlink/streamlink/issues"><img alt="Open issues" src="https://img.shields.io/github/issues/streamlink/streamlink.svg?style=flat-square&maxAge=86400"></a> |
| 8 | + <a href="https://github.com/streamlink/streamlink/actions?query=event%3Apush"><img alt="Build status" src="https://img.shields.io/github/actions/workflow/status/streamlink/streamlink/main.yml?branch=master&event=push&style=flat-square&maxAge=86400"></a> |
| 9 | + <a href="https://codecov.io/github/streamlink/streamlink?branch=master"><img alt="Overall code coverage" src="https://img.shields.io/codecov/c/github/streamlink/streamlink.svg?branch=master&style=flat-square&maxAge=86400"></a> |
| 10 | +</p> |
5 | 11 |
|
6 |
| -Streamlink is a CLI utility which pipes video streams from various services into a video player, such as VLC. |
| 12 | +<p align="center"> |
| 13 | + A Python library and command-line interface which pipes streams from various services into a video player.<br> |
| 14 | + Avoid resource-heavy and unoptimized websites, and still enjoy streamed content. |
| 15 | +</p> |
7 | 16 |
|
8 |
| -The main purpose of streamlink is to avoid resource-heavy and unoptimized websites, while still allowing the user to enjoy various streamed content. |
| 17 | +<p align="center"> |
| 18 | + Streamlink was forked in 2016 from the abandoned <em>Livestreamer</em> project. |
| 19 | +</p> |
9 | 20 |
|
10 |
| -Streamlink is a fork of the [Livestreamer][livestreamer] project. |
11 | 21 |
|
12 |
| -Please note that by using this application you're bypassing ads run by |
13 |
| -sites such as Twitch.tv. Please consider donating or paying for subscription |
14 |
| -services when they are available for the content you consume and enjoy. |
| 22 | +# 📦 Installation |
15 | 23 |
|
16 |
| - |
17 |
| -# [Installation][streamlink-installation] |
18 |
| - |
19 |
| -Please refer to our documentation for different ways to install Streamlink: |
| 24 | +Please take a look at the documentation for different ways of installing Streamlink: |
20 | 25 |
|
21 | 26 | - [Windows][streamlink-installation-windows]
|
22 | 27 | - [macOS][streamlink-installation-macos]
|
23 | 28 | - [Linux and BSD][streamlink-installation-linux-and-bsd]
|
24 | 29 | - [PyPI package and source code][streamlink-installation-pypi-source]
|
25 | 30 |
|
26 |
| -# Features |
27 | 31 |
|
28 |
| -Streamlink is built upon a plugin system which allows support for new services to be easily added. |
29 |
| -Most of the big streaming services are supported, such as: |
| 32 | +# 👍 Features |
| 33 | + |
| 34 | +Streamlink is built on top of a plugin system which allows support for new services to be added easily. |
| 35 | + |
| 36 | +Most of the popular streaming services are supported, such as: |
30 | 37 |
|
31 | 38 | - [Twitch](https://www.twitch.tv)
|
32 | 39 | - [YouTube](https://www.youtube.com)
|
33 | 40 | - [Livestream](https://livestream.com)
|
34 | 41 | - [Dailymotion](https://www.dailymotion.com)
|
35 | 42 |
|
36 |
| -... and many more. A full list of plugins currently included can be found on the [plugin page][streamlink-plugins]. |
| 43 | +... and many more. A list of all plugins currently included can be found on the [plugins page][streamlink-plugins]. |
37 | 44 |
|
38 | 45 |
|
39 |
| -# Quickstart |
| 46 | +# 💡 Quickstart |
40 | 47 |
|
41 |
| -After installing, simply use: |
| 48 | +After installing, simply run: |
42 | 49 |
|
| 50 | +```sh |
| 51 | +streamlink "STREAMURL" best |
43 | 52 | ```
|
44 |
| -streamlink STREAMURL best |
45 |
| -``` |
46 | 53 |
|
47 |
| -The default behavior of Streamlink is to play back streams in the VLC player. |
| 54 | +The default behavior of Streamlink is to play back streams in the [VLC player][player-vlc], but a lot of other options and output methods are available, such as writing the stream to the filesystem, reading stream metadata, etc. |
| 55 | + |
| 56 | +For more in-depth usage, please refer to the [CLI documentation][streamlink-documentation-cli]. |
48 | 57 |
|
49 |
| -For more in-depth usage and install instructions, please refer to the [detailed documentation][streamlink-documentation]. |
| 58 | +An [API guide][streamlink-documentation-apiguide] and [API reference][streamlink-documentation-apiref] is available for Python implementors of Streamlink. |
50 | 59 |
|
51 | 60 |
|
52 |
| -# Contributing |
| 61 | +# 🙏 Contributing |
53 | 62 |
|
54 | 63 | All contributions are welcome.
|
55 | 64 | Feel free to open a new thread on the issue tracker or submit a new pull request.
|
56 | 65 | Please read [CONTRIBUTING.md][contributing] first. Thanks!
|
57 | 66 |
|
58 |
| -[![Contributors][opencollective-contributors]][contributors] |
59 |
| - |
60 | 67 |
|
61 |
| -## Backers |
| 68 | +# ❤️ Support |
62 | 69 |
|
63 |
| -Thank you to all our backers! \[[Become a backer][opencollective-backer]\] |
| 70 | +If you think that Streamlink is useful and if you want to keep the project alive, then please consider supporting its maintainers by sending a small and optionally recurring tip via the [available options][support]. |
| 71 | +Your support is very much appreciated, thank you! |
64 | 72 |
|
65 |
| -[![Backers on Open Collective][opencollective-backers-image]][opencollective-backers] |
66 | 73 |
|
67 |
| - |
68 |
| -## Sponsors |
69 |
| - |
70 |
| -Support this project by becoming a sponsor. Your logo will show up here with a link to your website. \[[Become a sponsor][opencollective-sponsor]\] |
71 |
| - |
72 |
| -[](https://opencollective.com/streamlink/sponsor/0/website) |
73 |
| -[](https://opencollective.com/streamlink/sponsor/1/website) |
74 |
| -[](https://opencollective.com/streamlink/sponsor/2/website) |
75 |
| -[](https://opencollective.com/streamlink/sponsor/3/website) |
76 |
| -[](https://opencollective.com/streamlink/sponsor/4/website) |
77 |
| -[](https://opencollective.com/streamlink/sponsor/5/website) |
78 |
| -[](https://opencollective.com/streamlink/sponsor/6/website) |
79 |
| -[](https://opencollective.com/streamlink/sponsor/7/website) |
80 |
| -[](https://opencollective.com/streamlink/sponsor/8/website) |
81 |
| -[](https://opencollective.com/streamlink/sponsor/9/website) |
82 |
| - |
83 |
| - |
84 |
| - [streamlink-website]: https://streamlink.github.io |
85 |
| - [streamlink-plugins]: https://streamlink.github.io/plugins.html |
86 |
| - [streamlink-documentation]: https://streamlink.github.io/cli.html |
87 |
| - [streamlink-installation]: https://streamlink.github.io/install.html |
88 | 74 | [streamlink-installation-windows]: https://streamlink.github.io/install.html#windows
|
89 | 75 | [streamlink-installation-macos]: https://streamlink.github.io/install.html#macos
|
90 | 76 | [streamlink-installation-linux-and-bsd]: https://streamlink.github.io/install.html#linux-and-bsd
|
91 | 77 | [streamlink-installation-pypi-source]: https://streamlink.github.io/install.html#pypi-package-and-source-code
|
92 |
| - [livestreamer]: https://github.com/chrippa/livestreamer |
| 78 | + [streamlink-documentation-cli]: https://streamlink.github.io/cli.html |
| 79 | + [streamlink-documentation-apiguide]: https://streamlink.github.io/api_guide.html |
| 80 | + [streamlink-documentation-apiref]: https://streamlink.github.io/api.html |
| 81 | + [streamlink-plugins]: https://streamlink.github.io/plugins.html |
| 82 | + [player-vlc]: https://www.videolan.org/vlc/ |
93 | 83 | [contributing]: https://github.com/streamlink/streamlink/blob/master/CONTRIBUTING.md
|
94 |
| - [changelog]: https://github.com/streamlink/streamlink/blob/master/CHANGELOG.rst |
95 |
| - [contributors]: https://github.com/streamlink/streamlink/graphs/contributors |
96 |
| - [workflow-status]: https://github.com/streamlink/streamlink/actions?query=event%3Apush |
97 |
| - [workflow-status-badge]: https://github.com/streamlink/streamlink/workflows/Test,%20build%20and%20deploy/badge.svg?branch=master&event=push |
98 |
| - [codecov-coverage]: https://codecov.io/github/streamlink/streamlink?branch=master |
99 |
| - [codecov-coverage-badge]: https://codecov.io/github/streamlink/streamlink/coverage.svg?branch=master |
100 |
| - [opencollective-contributors]: https://opencollective.com/streamlink/contributors.svg?width=890 |
101 |
| - [opencollective-backer]: https://opencollective.com/streamlink#backer |
102 |
| - [opencollective-backers]: https://opencollective.com/streamlink#backers |
103 |
| - [opencollective-backers-image]: https://opencollective.com/streamlink/backers.svg?width=890 |
104 |
| - [opencollective-sponsor]: https://opencollective.com/streamlink#sponsor |
105 |
| - [opencollective-backers-badge]: https://opencollective.com/streamlink/backers/badge.svg |
106 |
| - [opencollective-sponsors-badge]: https://opencollective.com/streamlink/sponsors/badge.svg |
| 84 | + [support]: https://streamlink.github.io/latest/donate.html |
0 commit comments