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
Piik
这是什么?Piik 是一款免费开源的屏幕共享工具,适合游戏直播、观影之夜、绘画和照片分享。你可以共享屏幕、窗口、标签页或摄像头,朋友通过链接在浏览器里加入,而且整套东西你都可以自己托管。
这是网页站点、桌面应用,还是我自己跑的服务器?这三者合一:一个托管的在线网站、一个用于共享的桌面 App 下载版(Windows/macOS/Linux),以及一个可自行托管的独立 Piik Server 二进制文件,内置 Web UI、房间管理和可选的媒体转发。
怎么开始观看或共享?观看时,只需打开朋友发来的邀请链接并点击播放。共享时,下载 Piik App 并解压,选择 Public invite,再点 Open Piik 创建临时房间——或者什么都不装,直接在在线版里创建房间来共享。
自行托管 Piik Server 需要什么?你需要一台 Linux x64 服务器和自己的域名,并为公开站点配置 HTTPS 反向代理和 STUN 地址;Linux Server 包是一个解压即用的 tar.gz,房间数据存在 SQLite 里。
共享连接在所有平台上都可靠吗?目前只有 Windows App 和桌面浏览器共享这两种方式经过测试;macOS 和 Linux 应用还没在真机上测过,而且纯 P2P 模式(临时公开链接、在线版)在限制严格的网络里可能连不上。
谁可以观看直播?一个房间能装多少人?谁都能看——最多 20 个观看者,通过邀请链接、房间口令或可选密码加入,在桌面或手机浏览器里打开即可,观看端无需安装任何东西。
Piik App 和 Server 能跑在哪些平台上?App 提供 Windows x64、Apple Silicon macOS(原生采集需要 13+)和 Linux x64 版本;自行托管的 Server 目前只有 Linux x64 构建。
我的视频流量会经过服务器,还是只在我和朋友之间?Piik 会先尝试点对点直连,媒体数据直接在参与者之间传输;只有在无法直连时,自行托管的服务器才会作为后备的 SFU(媒体转发)介入。
基于浏览器的观看端需要 HTTPS 吗?需要,浏览器采集(从浏览器标签页共享)要求 HTTPS 或 localhost,不安全的纯 HTTP 页面无法采集屏幕。
可以把自行托管的服务器放进容器吗?可以,项目提供了 Docker Compose 配置,用于 Piik Server 的容器化部署。
除了屏幕,我还能共享什么?你可以共享整个屏幕、特定窗口、浏览器标签页或摄像头;具体可用的来源和音频选项取决于你从哪个平台共享。
Piik 支持英语以外的语言吗?支持,它跟随系统语言,目前支持中文和英文(回退为英文),可以在页头切换。
What are similar projects?srs, server, ZLMediaKit, webrtc, livego, Sunshine, peerjs, p2wlan
Which topics is it in?live-streaming, remote-desktop, webrtc, p2p, reverse-proxy, gaming, real-time, streaming, video, sqlite, browser, desktop
Creator
TNTcraftHIM
Size
15.2 MB
Stars
3.3K
Updated
CommitOct 16Releasev2.1.0Oct 16
Age
2mo
Commits · 90 Days