mirror of https://github.com/streamlink/streamlink
85 lines
4.4 KiB
Markdown
85 lines
4.4 KiB
Markdown
<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>
|
|
|
|
<p align="center">
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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/test.yml?branch=master&event=push&style=flat-square&maxAge=86400"></a>
|
|
<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>
|
|
</p>
|
|
|
|
<p align="center">
|
|
A Python library and command-line interface which pipes streams from various services into a video player.<br>
|
|
Avoid resource-heavy and unoptimized websites, and still enjoy streamed content.
|
|
</p>
|
|
|
|
<p align="center">
|
|
Streamlink was forked in 2016 from the abandoned <em>Livestreamer</em> project.
|
|
</p>
|
|
|
|
|
|
# 📦 Installation
|
|
|
|
Please take a look at the documentation for different ways of installing Streamlink:
|
|
|
|
- [Windows][streamlink-installation-windows]
|
|
- [macOS][streamlink-installation-macos]
|
|
- [Linux and BSD][streamlink-installation-linux-and-bsd]
|
|
- [PyPI package and source code][streamlink-installation-pypi-source]
|
|
|
|
|
|
# 👍 Features
|
|
|
|
Streamlink is built on top of a plugin system which allows support for new services to be added easily.
|
|
|
|
Most of the popular streaming services are supported, such as:
|
|
|
|
- [Twitch](https://www.twitch.tv)
|
|
- [YouTube](https://www.youtube.com)
|
|
- [Livestream](https://livestream.com)
|
|
- [Dailymotion](https://www.dailymotion.com)
|
|
|
|
... and many more. A list of all plugins currently included can be found on the [plugins page][streamlink-plugins].
|
|
|
|
|
|
# 💡 Quickstart
|
|
|
|
After installing, simply run:
|
|
|
|
```sh
|
|
streamlink "STREAMURL" best
|
|
```
|
|
|
|
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.
|
|
|
|
For more in-depth usage, please refer to the [CLI documentation][streamlink-documentation-cli].
|
|
|
|
An [API guide][streamlink-documentation-apiguide] and [API reference][streamlink-documentation-apiref] is available for Python implementors of Streamlink.
|
|
|
|
|
|
# 🙏 Contributing
|
|
|
|
All contributions are welcome.
|
|
Feel free to open a new thread on the issue tracker or submit a new pull request.
|
|
Please read [CONTRIBUTING.md][contributing] first. Thanks!
|
|
|
|
|
|
# ❤️ Support
|
|
|
|
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].
|
|
Your support is very much appreciated, thank you!
|
|
|
|
|
|
[streamlink-installation-windows]: https://streamlink.github.io/install.html#windows
|
|
[streamlink-installation-macos]: https://streamlink.github.io/install.html#macos
|
|
[streamlink-installation-linux-and-bsd]: https://streamlink.github.io/install.html#linux-and-bsd
|
|
[streamlink-installation-pypi-source]: https://streamlink.github.io/install.html#pypi-package-and-source-code
|
|
[streamlink-documentation-cli]: https://streamlink.github.io/cli.html
|
|
[streamlink-documentation-apiguide]: https://streamlink.github.io/api_guide.html
|
|
[streamlink-documentation-apiref]: https://streamlink.github.io/api.html
|
|
[streamlink-plugins]: https://streamlink.github.io/plugins.html
|
|
[player-vlc]: https://www.videolan.org/vlc/
|
|
[contributing]: https://github.com/streamlink/streamlink/blob/master/CONTRIBUTING.md
|
|
[support]: https://streamlink.github.io/latest/donate.html
|