Files
Piik/docs/guide/getting-started.zh-CN.md
T
AAA f92162b3bb feat: launch Piik with a unified interface and public website
Piik now has one public presentation and a coordinated App/Server release path. This phase unifies the room UI, rewrites the bilingual README and guides, adds a static website with an inline product film, and prepares matching GitHub/Gitee packages and update links.

The film uses the current homepage and shared product controls on one seekable timeline. Runtime fixes preserve presentation when the App opens a room, normalize Site origins, and keep capture and media-recovery status in the television indicator. New visits use Chinese for a Chinese system language and English otherwise; explicit language and visual-mode choices remain available. An optional site passphrase controls site entry, while room authorization remains enforced.

GitHub is the release authority. Gitee mirrors verified packages and provides update metadata when GitHub is unavailable. Reviewed PR release notes become the GitHub Release description. The separate public demo uses P2P only, with HTTPS and STUN verified.

Validation: 756 Web tests, TypeScript and production build; Go core tests, formatting, vet and available target builds; bounded Windows capture and App/Site interoperability; browser film checks, audible playback and narrow layouts; anonymous Gitee Windows-package download, checksum and launcher/update-link checks. Public demo acceptance covers authenticated WebSocket signaling, synthetic P2P video and room cleanup on one network. macOS/Linux physical capture and the wider device/network/endurance matrix remain explicitly deferred.

Publication builds every package from the merged source SHA. The repository is public, main protection is active, and Pages is configured for piik.tv. CI/publisher and Pages deployment records own publication results.

## Release notes

### 中文

Piik 是免费开源的屏幕共享工具。开个房间,发出邀请,最多 20 位朋友就能用浏览器加入观看。

- 使用浏览器或 Piik App 分享游戏、窗口和整个屏幕。
- 优先建立直连;自托管站点可开启媒体转发作为备用线路。
- Piik App 支持本地房间、临时公网邀请和已有站点。
- Piik Server 内置网页界面、房间管理和连接服务,方便自行部署。
- 提供中英文界面与使用指南,以及 GitHub、Gitee 两条下载线路。

[官网](https://piik.tv) · [在线体验](https://demo.piik.tv) · [使用指南](https://github.com/TNTcraftHIM/Piik/blob/main/docs/guide/getting-started.zh-CN.md) · [自行部署](https://github.com/TNTcraftHIM/Piik/blob/main/docs/operations/self-hosting.zh-CN.md) · [Gitee 下载](https://gitee.com/TNTcraftHIM/Piik/releases)

Windows App 和桌面浏览器是本次主要验证的平台。macOS 和 Linux 尚未经过实机测试,欢迎有设备的朋友测试并反馈。演示站和 App 公网邀请使用 P2P,受限网络下可能无法连接;自托管站点可开启媒体转发。

### English

Piik is free, open-source screen sharing for you and up to 20 viewers. Start a room, send an invitation, and your friends can join in a browser.

- Share games, windows or a whole screen from your browser or Piik App.
- Direct connections come first, with optional media forwarding on self-hosted sites.
- Piik App supports local rooms, temporary public invitations and existing sites.
- Piik Server includes the web interface, rooms and connection services for self-hosting.
- English and Chinese interfaces and guides are available, with GitHub and Gitee downloads.

[Website](https://piik.tv) · [Online demo](https://demo.piik.tv) · [User guide](https://github.com/TNTcraftHIM/Piik/blob/main/docs/guide/getting-started.md) · [Self-hosting](https://github.com/TNTcraftHIM/Piik/blob/main/docs/operations/self-hosting.md) · [Gitee downloads](https://gitee.com/TNTcraftHIM/Piik/releases)

Windows App and desktop browsers are the primary validated paths. macOS and Linux have not yet been tested on physical devices; testing and feedback are welcome. The demo and App public invitations rely on P2P and may not connect on restrictive networks. Self-hosted sites can enable media forwarding.
2026-09-12 22:09:12 +08:00

6.9 KiB
Raw Blame History

第一次用 Piik

English · 简体中文 · 回到 Piik

Piik 支持一位房主分享屏幕,最多 20 位受邀观众通过浏览器观看。 本指南介绍加入房间、体验在线 Demo、使用客户端,以及通过已有站点分享的方法。

加入房间 · 在线 Demo · Piik App · 已有站点 · 问题排查

观众只需要浏览器和邀请链接。 初次体验分享,可以使用在线 Demo 或客户端的 公网邀请。

如果 Piik 只显示图示,点击顶部的 中 即可显示下文提到的按钮文字。 EN 切换到英文,✦ 返回图示模式。

加入朋友的房间

  1. 用电脑或手机浏览器打开朋友发来的邀请链接。
  2. 等待画面出现。如果浏览器没有自动播放,点击 播放。
  3. 将鼠标移到画面上,或轻点画面,显示播放控制栏。

播放控制栏只改变你自己看到的画面和听到的声音。

播放按钮分别做什么?
按钮 作用
剧场模式 在浏览器标签页内展开画面。
全屏观看 让画面铺满屏幕。
悬浮小窗 浏览器支持时,把视频放进独立小窗。
音量 支持增强时最高 200%,否则最高 100%;声音失真时调低一些。

只有四位房间号时,打开同一个 Piik 站点,选择 加入房间。 你可能需要站点口令和房间密码。能否通过房间号加入由房主决定; 无法加入时,请朋友发邀请链接。

旧链接失效了,就请房主重新发一份当前邀请。 App 的本地房间和临时公网邀请会随本次 App 退出而结束。

体验在线 Demo

  1. 在支持屏幕共享的电脑浏览器中打开 demo.piik.tv。
  2. 点击 开始分享,选择屏幕、窗口或标签页;如需声音且浏览器提供该选项,启用音频。
  3. 确认预览后,点击 复制邀请链接,用另一台设备打开,或发送给朋友。
  4. 体验结束后,点击 停止分享。

演示站由项目提供,画面通过设备间直连(P2P)传输。 在受限网络下,可能出现页面能打开、画面无法连接的情况。

用 Piik App 分享

  1. 从 GitHub Releases 或 Gitee 镜像下载以 piik-app 开头、 对应平台的压缩包,完整解压并保留目录结构。
  2. Windows 打开 piik-app.exe,macOS 打开 Piik App.app,Linux 运行 ./piik-app。 启动页会在系统浏览器里打开。
  3. 邀请不在同一局域网的朋友时,选择 公网邀请,再点击 进入 Piik。 其他模式的用途见下表。
  4. 点击 开始分享,按可用选项选择 浏览器、程序 / 窗口 或 屏幕, 然后选定要分享的画面与声音。
  5. 复制房间邀请发给朋友。分享期间保持 App 和分享标签页打开。
文件名包含 适用平台
windows-amd64 Windows x64
darwin-arm64 Apple 芯片;原生采集需 macOS 13 及以上
linux-amd64 Linux x64

目前主要测试 Windows 客户端和浏览器分享。macOS 和 Linux 客户端尚未经过实机测试, 欢迎有设备的朋友试用并反馈问题。 Linux 原生采集还需要系统组件。 程序包与启动参数的细节见 App 指南。

选择 App 模式

模式 什么时候用 需要知道
本地房间 朋友和你在同一个局域网。 对方需要能连接到你的电脑,可以设置本地站点口令。
公网邀请 朋友在别处,想临时发个邀请。 需要互联网连接;公网地址只在本次 App 运行期间有效。
连接站点 你们已经有一个 Piik 站点。 输入站点地址,在原有分享页面使用 App 的采集能力。

网页能打开,不代表视频一定能连通。 公网邀请为房间提供临时网页地址, 画面和声音仍靠参与者之间的连接传输。此模式没有媒体服务器兜底, 临时地址也不保证持续可用。所有模式都需要可用的 UDP 媒体路径。 具体连接方式见 App 指南。

用浏览器分享

需要先有一个运行 Piik Server 的 HTTPS 站点,可以使用朋友或管理员提供的地址。 还没有站点时,请先体验在线 Demo 或使用客户端。 自建站点属于进阶操作,服务器、HTTPS 和网络端口的配置步骤见部署指南。

  1. 在电脑上打开 Piik 站点。如果站点设置了口令,先输入口令。
  2. 点击 开始分享,在浏览器弹窗里选择屏幕、窗口或标签页; 如需声音且浏览器提供该选项,启用音频。
  3. 确认预览画面后,点击 复制邀请链接 发给朋友。
  4. 保持分享标签页打开。需要时使用 暂停分享、切换来源 或 停止分享。

浏览器屏幕采集需要 HTTPS 站点或 localhost。 弹窗里有哪些画面和声音可选,取决于浏览器与操作系统。 拿到邀请链接的人可以进入这个房间,请把它发给你想邀请的人。

遇到问题了

你遇到的情况 可以先试什么
有画面,没声音 先取消视频静音。房主应选择支持分享声音的来源;如果开始时关闭了声音,请停止后重新开始并打开声音。通过 App 采集窗口或屏幕时,切换来源会保留原来的声音设置。
没有屏幕选择弹窗 按系统提示允许浏览器或 App 录制屏幕。浏览器采集需要 HTTPS 或 localhost,请在电脑上尝试分享。
本地邀请打不开 确认两台设备在同一网络且可以互相访问。访客 Wi-Fi 或防火墙规则可能阻止本地连接。
网页能打开,画面连不上 点击播放控制栏的 重新连接;仍然失败时,检查 WebRTC 连接设置,或尝试有媒体服务器兜底的站点。
休眠或挂起后分享中断 唤醒设备,回到分享标签页,必要时重新开始分享。浏览器或系统挂起可能中断采集和播放。

反馈问题时,请附上版本、系统与浏览器、预期结果和复现步骤。 诊断与导出 说明如何收集本地报告,以及分享前需要检查哪些内容。

想为朋友搭一个站点?从 部署指南 开始。 其他内容可在 文档导航 找到。