Piped-Material/README.md

# Piped-Material

[![GitHub Repo stars](https://img.shields.io/github/stars/mmjee/Piped-redesign?style=social)](https://github.com/mmjee/Piped-redesign/stargazers)
[![GitHub last commit](https://img.shields.io/github/last-commit/mmjee/Piped-redesign)](https://github.com/mmjee/Piped-redesign/commits)
[![Weblate Translation Status](https://hosted.weblate.org/widgets/piped-material/-/i18n/svg-badge.svg)](https://hosted.weblate.org/projects/piped-material/i18n/#information)

Piped-Material is a fork of [Piped](https://github.com/TeamPiped/piped), an alternative client to YouTube. I have tried to improve the performance, the design and efficiency.

There are a few things that PM does better, like watch history tracking, but it's feature complete in almost all places.

As a byproduct, the code is also much cleaner, dysfunctional patterns and paradigms have been replaced with clean, beautiful code :).

## Links

| URL                           | Environment | Special Notes | Default Instance |
|-------------------------------|-------------|---------------|------------------|
| https://piped-material.১.net  | Production  |               | Kavin            |
| https://piped-material.ftp.sh | Production  |               | Kavin            |
| https://piped-staging.ftp.sh  | Staging     |               | Kavin            |
| https://ui.piped.১.net        | Staging     | IPv6-only     | mmjee            |

Production instances are updated infrequently, and do not include features that are introduced recently without extensive testing.

Piped-Material's Production instance is also available via IPFS at IPNS key `k51qzi5uqu5dl0a18rats73hcc6d5dtvtz9pjbpgzj6hl66b9za5i5wn0yzgjv`.
For example, it's available [via dweb.link](https://k51qzi5uqu5dl0a18rats73hcc6d5dtvtz9pjbpgzj6hl66b9za5i5wn0yzgjv.ipns.dweb.link) and [via cf-ipfs.com](https://k51qzi5uqu5dl0a18rats73hcc6d5dtvtz9pjbpgzj6hl66b9za5i5wn0yzgjv.ipns.cf-ipfs.com).

## Help

Join the Libera Chat channel [#piped-material via IRC](ircs://irc.libera.chat:6697/#piped-material).

Or alternatively you [can join in via Matrix](https://matrix.to/#/#piped-material:libera.chat).

## How to contribute

One of the easiest and most important ways to contribute is to translate and localize it to your language and/or region.

You can use Weblate for this, or you can just send normal PRs or patches.

Weblate URL: [https://hosted.weblate.org/projects/piped-material/i18n](https://hosted.weblate.org/projects/piped-material/i18n).

## Backlog

- [ ] Playing videos continuously in a playlist

## Features:

- [x] No Ads
- [x] No Tracking
- [x] Infinite Scrolling
- [x] 4K support
- [x] No connections to Google's servers
- [x] Comments
- [x] Playlist support
- [x] Captions support
- [x] Search Suggestions
- [x] Livestreams support with a quality selector
- [x] Support for IOS
- [x] Preferences saved locally
- [x] Multi-region loadbalancing
- [x] Performant by design, designed to handle 1000s of users concurrently
- [x] PWA support
- [x] Improving UI
- [x] Login
- [x] Feeds
- [x] Integration with SponsorBlock
- [x] Integration with LBRY

## WIP

- [ ] Playing just audio
- [ ] 8K support

## Documentation

The original parent repository documentation can be found at https://piped-docs.kavin.rocks (accessible via IPNS as well).

## Screenshots

![Screenshot 1](https://cf-ipfs.com/ipfs/QmeQ4iWYB6vVjj4z7oUbgZrcd5CxuePkxwD9TM4uL9NiKg?filename=img2.png)
![Screenshot 2](https://cf-ipfs.com/ipfs/QmXSEJ2dUXGBqx6d6dsKYmx9QUcgycvh5MmuExTxZYmoEA?filename=rick.png)

To donate and for support, [see TeamPiped/piped](https://github.com/TeamPiped/piped)