Piik README

The project's README from github.com/TNTcraftHIM/Piik. As one markdown file: README.md.

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 games, movie nights, drawings and photos. Choose what to share and send an invitation. Your friends watch in their browsers.

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

Piik room: a shared game, playback controls 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.
Host your own site Advanced: deploy Piik Server on a Linux x64 server with your own domain, then connect through Piik App or a browser.

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.

Turn on the Microphone for commentary; its settings let you choose the input device and adjust your voice volume.

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 offers a local room, a temporary public link, or a connection to your own site. Keep the App running while sharing through it.

Download a ZIP beginning with piik-app. The filename also identifies the platform:

Filename contains Platform
windows-amd64 Windows x64
darwin-arm64 Apple silicon; native capture requires macOS 13+
linux-amd64 Linux x64

Full setup guide → · Open online →

Browser capture requires HTTPS or localhost. Windows App and desktop browser sharing are the primary tested paths. The macOS and Linux apps have not yet been tested on physical devices; test results and feedback are welcome. P2P-only modes, including the App's temporary public link and the online version, may not connect on restrictive networks.

Self-hosting

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

./piik-server

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.

Piik (TNTcraftHIM/Piik)

Searching Database…

3.3K ·GitHub
What is this?Piik is a free, open-source screen sharing tool for game streaming, movie nights, drawings and photos. You share a screen, window, tab or camera, friends join through a link in their browser, and you can self-host the whole thing.
Is this a browser site, a desktop app, or a server I run myself?It is all three in one project: a hosted online site, a downloadable desktop App (Windows/macOS/Linux) for sharing, and a standalone Piik Server binary you can self-host with a web UI, room management and optional media forwarding built in.
How do I start watching or sharing?To watch, just open the invitation link a friend sends and press Play. To share, download Piik App, extract it, choose Public invite, then Open Piik to create a temporary room — or share without installing anything by creating a room in the online version.
What do I need to self-host Piik Server?You need a Linux x64 server with your own domain, plus an HTTPS reverse proxy and a STUN address configured for a public site; the Linux Server package is a tar.gz you extract and run, and room data is stored in SQLite.
Does the sharing connection always work on all platforms?Windows App and desktop browser sharing are the only paths tested so far; macOS and Linux apps haven't been tested on real devices yet, and P2P-only modes (temporary public links, the online version) may fail to connect on restrictive networks.
Who can watch a stream, and how many people fit in a room?Anyone can watch — up to 20 viewers join through an invitation link, room code, or optional password, in a desktop or mobile browser, with no install needed on the viewer side.
Which platforms can run the Piik App or Server?The App ships for Windows x64, Apple Silicon macOS (13+ for native capture) and Linux x64; the self-hosted Server currently only has a Linux x64 build.
Does my video traffic pass through a server, or does it stay between me and my friends?Piik tries direct peer-to-peer connections first so media travels straight between participants; a self-hosted server can act as a fallback SFU (media forwarding) only when a direct connection isn't possible.
Does the browser-based viewer need HTTPS?Yes, browser capture (sharing from a browser tab) requires HTTPS or localhost, so an unsecured plain HTTP page will not be able to capture a screen.
Can I put the self-hosted server in a container?Yes, a Docker Compose setup is provided for containerized deployments of Piik Server.
What can I actually share besides my screen?You can share a full screen, a specific window, a browser tab or a camera; the exact available sources and audio options depend on the platform you're sharing from.
Does Piik support languages other than English?Yes, it follows your system language and currently supports Chinese and English (with English as the fallback), switchable from the header.
What are similar projects?srs, server, ZLMediaKit, webrtc, livego, Sunshine, peerjs, p2wlan
Size
15.2 MB
Stars
3.3K
Age
2mo
Commits · 90 Days