TNTcraftHIM/Piik

TypeScriptpiik.tv
macOSWindowsLinux

Free, open-source screen sharing for private live streams with friends. Watch together in a browser or self-host Piik. 免费开源的私密屏幕共享,支持游戏直播、一起看电影与自部署。

p2pscreen-sharingself-hostedwebrtclive-streamingprivate-streamingwatch-together
Star Growth
Stars
3.7k
Forks
227
Weekly Growth
+401
Issues
3
1k2k3k
Sep 1Sep 19Oct 7Oct 25
Artifactsnpm
README

Piik mascot

Piik

Share the good stuff.
Private screen sharing for you and up to 20 friends.

Website · Download · Gitee mirror · Use online · Documentation

License: MIT Up to 20 viewers P2P-first media

English · 简体中文

Piik is a free, open-source screen sharing tool for private live streams with friends: games, movie nights, drawings and photos. Choose what to share and send an invitation. Your friends watch in their browsers. You can also self-host Piik on your own server.

A little room · Show / hide animation

A host with a gold crown switches between a gamepad, paintbrush, camera and remote as friends watch games, drawings, photos and a film.

Features · Get started · Self-hosting · Contributing

Features

  • Watch without installing. Friends join by invitation in a desktop or mobile browser.
  • Share from Piik App or an existing Piik site. Choose a screen, window, browser tab or camera; available sources and audio depend on the platform.
  • Direct connections first. Media travels between participants where possible (P2P). A self-hosted server can provide automatic media forwarding (SFU) as a fallback.
  • Rooms you control. Invitations, room codes and optional room passwords, for one host and up to 20 viewers.
  • Talk and chat together. Join room voice, send messages and reactions, or enable on-screen chat.
  • Hand control to friends. Share an App window or screen and approve remote control. Allow friends to play together with shared keyboard/mouse or supported gamepads; take control back at any time. Setup guide.
  • Flexible viewing. Light and dark themes, playback controls, picture-in-picture and a connection topology view.
  • One program to host a site. Web UI, room management and optional media forwarding are packaged together.

Piik room: a shared game, playback controls, chat and friends on a sofa. The host wears a small gold crown.
Interface preview · Sample room with a generated game scene

Get started

To watch: open the invitation your friend sends you. Select Play if the picture does not start automatically.

To share: download Piik App to get started. To share without installing, you can also create a room in the online version.

Start here What you need to do
Use Piik online Share from a desktop browser, or choose Camera on a phone with browser camera support.
Download Piik App Extract and open the App, choose Public invite, then Open Piik to create a temporary room.

Choose a screen, send an invitation, watch together.

  1. Select Start sharing, then choose the picture and audio to share.
  2. Select Copy invite link and send it to your friends. Keep the sharing tab open.

Open Interact → Voice to talk together, with or without picture sharing. The Host opens voice; everyone joins to listen and chooses when to turn on their microphone.

Piik follows your system language: Chinese or English, with English as the fallback. Use 中 / EN / ✦ in the header to switch language or try the visual mode. The App can create a local room or temporary public invitation, and stays available to supply capture for an approved site. Keep it running while sharing.

Illustrated getting started → · Troubleshooting →

Choose a download beginning with piik-app. The guide covers installation, source selection and invitations.

Browser capture requires HTTPS or localhost. The App's temporary public link and the online version use P2P and need a usable UDP connection between participants. For campus networks, failed media connections or virtual LANs, see network checks and connection options.

Self-hosting

Deploy Piik Server to run a site for your group.

Deploy Piik with Docker Compose

Piik Server is a standalone binary with the web interface built in. Download the Server package for Linux x64 (piik-<revision>-runtime.tar.gz) or ARM64 (piik-<revision>-linux-arm64-runtime.tar.gz), extract it, and run:

./piik-server

Windows x64 uses piik-<revision>-windows-amd64-runtime.zip; extract it and run ./piik-server.exe in PowerShell. The same configuration applies.

Open http://localhost:8787 to try it locally. For a public site, configure your domain, HTTPS reverse proxy and STUN address. Room data is stored in SQLite. For containers, use the Docker Compose setup.

Deploy your own site → · Configuration · Run from source

Contributing

Bug reports, translations, documentation improvements and pull requests are welcome. See ways to contribute or help translate Piik. Use the repository layout to find your way around.

License

Piik-owned code is MIT licensed. Dependencies retain their own licenses and notices.

Project activity

Piik on Trendshift

Piik GitHub star history