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 — бесплатный open-source инструмент демонстрации экрана для стримов игр, киновечеров, рисунков и фотографий. Вы делитесь экраном, окном, вкладкой или камерой, друзья подключаются по ссылке в своём браузере, а всё это можно развернуть у себя.
Это сайт в браузере, десктопное приложение или сервер, который я запускаю сам?Всё три в одном проекте: хостинговый онлайн-сайт, скачиваемое десктопное приложение (Windows/macOS/Linux) для демонстрации и отдельный бинарник Piik Server, который можно развернуть у себя — с веб-интерфейсом, управлением комнатами и опциональной пересылкой медиа в комплекте.
Как начать смотреть или транслировать?Чтобы смотреть, просто откройте ссылку-приглашение, которую прислал друг, и нажмите Play. Чтобы транслировать, скачайте Piik App, распакуйте, выберите Public invite, затем Open Piik, чтобы создать временную комнату, — или делитесь без установки чего-либо, создав комнату в онлайн-версии.
Что нужно для самостоятельного развёртывания Piik Server?Нужен сервер Linux x64 со своим доменом, плюс настроенные HTTPS reverse proxy и STUN-адрес для публичного сайта; пакет Linux Server — это tar.gz, который вы распаковываете и запускаете, а данные комнат хранятся в SQLite.
Соединение демонстрации всегда работает на всех платформах?Пока проверены только приложение Windows и демонстрация из десктопного браузера; приложения macOS и Linux на реальных устройствах ещё не тестировались, а P2P-режимы (временные публичные ссылки, онлайн-версия) могут не соединяться в ограничительных сетях.
Кто может смотреть трансляцию и сколько людей вмещает комната?Смотреть может любой — до 20 зрителей подключаются по ссылке-приглашению, коду комнаты или опциональному паролю, в десктопном или мобильном браузере, без установки чего-либо на стороне зрителя.
На каких платформах могут работать Piik App или Server?Приложение поставляется для Windows x64, macOS на Apple Silicon (13+ для нативного захвата) и Linux x64; у самостоятельно размещаемого Server сейчас есть только сборка Linux x64.
Мой видеотрафик идёт через сервер или остаётся между мной и друзьями?Piik сначала пытается установить прямое peer-to-peer соединение, чтобы медиа шли напрямую между участниками; самостоятельно размещённый сервер может выступать резервным SFU (пересылка медиа), только когда прямое соединение невозможно.
Нужен ли HTTPS браузерному зрителю?Да, захват в браузере (демонстрация из вкладки браузера) требует HTTPS или localhost, поэтому незащищённая обычная HTTP-страница не сможет захватить экран.
Можно ли поместить самостоятельно размещаемый сервер в контейнер?Да, для контейнерного развёртывания Piik Server предоставляется конфигурация Docker Compose.
Что ещё можно транслировать, кроме экрана?Можно делиться целым экраном, конкретным окном, вкладкой браузера или камерой; точный набор доступных источников и опций звука зависит от платформы, с которой вы транслируете.
Поддерживает ли Piik языки, кроме английского?Да, он следует языку вашей системы и сейчас поддерживает китайский и английский (с английским как запасным), переключение — в шапке.
What are similar projects?srs, server, ZLMediaKit, webrtc, livego, Sunshine, peerjs, p2wlan
Size
15.2 MB
Stars
3.3K
Age
2mo
Commits · 90 Days