This release adds microphone processing controls and local chat controls, expands platform packages, and synchronizes the website and guides. It also fixes native H.264 input/format handling, signaling recovery, fresh STUN discovery, and UDP ownership during overlapping connections. This is **v1.8.0**. Browser/Server v23, Native control v9 and capture v7 remain unchanged, with the existing 1440p ceiling. Additional resolutions, capability negotiation and Magicsock are separate follow-up work. ## Validation - Full local Web check: 79 files / 1,317 tests, TypeScript and production build. - Full Go checks, platform builds and Windows native capture regressions/probe. - Native H.264 Host lifecycle, Browser-to-App fanout and App-exit recovery, and Native H.264 through embedded SFU: all passed with owned process/port/profile cleanup. - Website build, documentation and repository hygiene passed. Existing UI acceptance covers narrow screens, both languages/themes, architecture downloads and all 23 film checks; final packaging and Go race checks run on the merged revision in CI. - Physical macOS/Linux capture, representative public networks and unmatched field reports retain their documented evidence limits. No claim that every blur/disconnection report is resolved. ## Release notes ### 中文 这是一次功能与兼容性更新:麦克风和聊天增加了实用的小选项,App 与 Server 支持更多设备,同时修复了原生分享和连接恢复中的若干问题。现有 1.x 协议保持不变。 #### 新增与改进 - 浏览器麦克风新增「降噪与回声消除」开关,默认开启回声消除、降噪和自动增益;分享音乐或使用虚拟音频输入时,可按需关闭。 - 可调整弹幕字号和透明度,并将当前保留的聊天记录导出为 TXT。当前会话最多保留 1,000 条文字消息,刷新页面后清空;需要保存时请先导出。 - 新增 Intel Mac、Linux ARM64 App,以及 Linux ARM64 Server 和容器镜像。官网下载区可直接选择对应架构,并显示最新版本和发布时间。 - 更新官网演示、README 截图和中英文教程,明确浏览器分享也可选择窗口或屏幕;开始分享前显示房间号占位,保持底栏控件位置稳定。 - 官网新增直达问题排查的入口,补充浏览器 WebRTC 限制、校园网和 Windows 显卡相关的排查步骤。 - App 模式选择页显示免费开源说明、作者与贡献者署名,以及官方网站和源码链接。 #### 修复 - 修正部分 H.264 原生分享的格式兼容性校验,以及 Windows 编码器输入长度和输出缓冲区对齐问题。 - 清理已失效的重连任务和 Native 接收信令,避免旧连接继续影响当前会话。 - 修复 App 重连时可能复用过期公网地址的问题;重新探测使用当前地址,并处理探测丢包和过期响应,保留其他正常连接。 - 修复 App 新旧媒体连接重叠时共用端口造成的冲突,避免准备或撤销新连接打断仍在使用的画面;关闭连接时及时取消未完成的端口映射请求。 - 无站点密码时,连接恢复不再误引导用户输入站点密码。 - 房间失效或会话终止时,开播前后的原因提示统一显示在电视状态图标中,避免额外提示条。 - 修正 Linux 原生采集的时间戳与关键帧时间基准。感谢 Pedro Antonio 在 [#449](https://github.com/TNTcraftHIM/Piik/pull/449) 的贡献。 #### 使用说明 下载对应平台的完整压缩包,退出旧 App 后解压使用。Windows 继续提供 x64;macOS 提供 Apple 芯片与 Intel 版本,原生采集需要 macOS 13 或更新版本。Linux 提供 x64 与 ARM64,原生采集还需安装[系统组件](https://github.com/TNTcraftHIM/Piik/blob/main/native/capture/linux/README.md)。macOS 和 Linux 的实机覆盖仍有限,欢迎反馈。 ### English This update adds useful microphone and chat controls, brings Piik to more devices, and fixes several native-sharing and connection-recovery issues. The existing 1.x protocols remain unchanged. #### New and improved - Browser microphones now have a “Noise & echo reduction” toggle. Echo cancellation, noise suppression and automatic gain control are on by default; turn them off when appropriate for music or virtual audio inputs. - Adjust chat-overlay text size and opacity, and export retained messages as TXT. The current session keeps up to 1,000 text messages and clears on page refresh; export first if you want to keep them. - Added Intel Mac and Linux ARM64 App packages, plus Linux ARM64 Server and container images. The website provides architecture selectors and shows the latest release and publication date. - Updated the website demonstration, README screenshots and bilingual guides, clarifying that browser capture can also select windows or screens. A room-code placeholder keeps the bottom bar stable before sharing starts. - Added direct website links to troubleshooting, with steps for browser WebRTC restrictions, campus networks and Windows graphics issues. - The App mode-selection page now shows its free and open-source status, author and contributor credit, and links to the official website and source. #### Fixes - Corrected H.264 format compatibility checks and Windows encoder input-length and output-buffer alignment handling. - Retired stale reconnect tasks and Native receive signals so they cannot continue affecting the current session. - Fixed App reconnection reusing an expired public address. Fresh discovery handles lost probes and stale responses while preserving other working connections. - Fixed UDP socket conflicts between overlapping App media connections so preparing or canceling a replacement preserves the active picture. Closing a connection now cancels unfinished gateway mapping requests. - Connection recovery on passwordless sites no longer incorrectly asks for a site passphrase. - Expired-room and session-termination reasons now use the same TV status indicator before and during sharing, without an extra notice strip. - Corrected Linux native capture timestamps and keyframe time bases. Thanks to Pedro Antonio for [#449](https://github.com/TNTcraftHIM/Piik/pull/449). #### Updating Download the complete archive for your platform, quit the old App, and extract the new package. Windows remains x64-only. macOS packages support Apple silicon and Intel; native capture requires macOS 13 or newer. Linux supports x64 and ARM64 and requires additional [system components](https://github.com/TNTcraftHIM/Piik/blob/main/native/capture/linux/README.md) for native capture. Physical-device coverage on macOS and Linux remains limited; feedback is welcome. ## Attribution Co-authored-by: Pedro Antonio <wrenchwastaken@gmail.com>
176 lines
11 KiB
Markdown
176 lines
11 KiB
Markdown
# Public introduction
|
|
|
|
This file owns the website and README content structure. The
|
|
[visual language](./visual-language.md) owns their shared illustration and motion.
|
|
|
|
## One story, three readers
|
|
|
|
Lead with friends sharing something worth seeing: a game, a drawing, a film or
|
|
travel photos. The [copy guide](./naming.md#voice-and-terminology) owns
|
|
Chinese/English voice and role labels. A visitor should
|
|
understand what Piik does, choose an entry and complete the first useful action.
|
|
|
|
| Surface | Reader's question | Content |
|
|
| --- | --- | --- |
|
|
| README, English and Chinese | What is this, and how do I start? | Brand introduction and interface preview, features, getting started, self-hosting, contribution and license |
|
|
| `site/`, for GitHub Pages | What does using it feel like, and how do I start? | Room illustration and primary download link, illustrated steps, online/App/existing-site walkthroughs, FAQ, platform downloads, self-hosting and documentation |
|
|
| Getting-started guides | Which button or mode do I use? | Browser invitation, sharing, App setup and three mode choices |
|
|
| Self-hosting guides | How do I put my own site online? | Run the binary, set the domain and HTTPS proxy, open ports and verify; service management remains a separate reference |
|
|
| Developer and operations docs | How do I build or host it? | Existing configuration, deployment, architecture and diagnostic owners |
|
|
|
|
The [reader documentation](../guide/README.md) is the public help entry. Link it from the
|
|
website navigation and footer, with direct self-hosting, configuration and
|
|
update/recovery links in the documentation section. Keep the guides in this
|
|
repository; do not maintain a second GitHub Wiki copy of the same instructions.
|
|
The website build renders the selected guides at `/docs/`, with language navigation
|
|
and local search. The repository's [developer map](../README.md), standards,
|
|
research and work ledgers remain separate from that reader navigation.
|
|
|
|
Homepage FAQ answers questions before first use: installation, supported
|
|
platforms, audience size, sound and sharing across networks. Order them along
|
|
the visitor's decisions: device and installation requirements, joining friends,
|
|
shared media, then advanced hosting. Keep related questions together and place
|
|
material limitations beside their answers. Specific errors and recovery procedures
|
|
belong in the troubleshooting guide, linked directly from the header, the end
|
|
of the FAQ and the footer in the selected language. Keep these steps in one
|
|
reader guide; App references link to it rather than maintaining a second copy.
|
|
Do not duplicate troubleshooting steps on the homepage.
|
|
|
|
## Presentation
|
|
|
|
Keep three presentation responsibilities distinct:
|
|
|
|
| Layer | Owns | Review question |
|
|
| --- | --- | --- |
|
|
| Shared identity | Mascot geometry and wink, gold sparkle, wordmark/orange dot, public-page brand control | Does this read as the same Piik at every size and entry? |
|
|
| Product demonstration | Actual components, labels, source selection, room controls and participants with sample data | Does the pictured action still match the current product? |
|
|
| Promotional composition | Original scenery, large typography, framing, transitions and optional music | Does the spectacle help a newcomer understand the product and find the next action? |
|
|
|
|
Use one public-page brand component for the homepage and film. The mascot's
|
|
curved wink and gold sparkle are recognizable features; a prop or a pictured
|
|
game does not replace its face with another expression. Original RPG scenery
|
|
can suggest exploration through terrain, ruins and small discoveries without
|
|
borrowing another product's characters, named places, logos or artwork.
|
|
|
|
Homepage sections follow the visitor's decisions: understand Piik and find the
|
|
primary download action, see the sharing steps, choose a short tutorial, resolve
|
|
questions, then find platform downloads, detailed documentation and source.
|
|
The primary download link lets returning visitors skip the tutorials. Guide
|
|
choices run from the online site to App to an existing Piik site, with only the
|
|
online entry expanded initially. The existing-site guide explains connecting the
|
|
App to a site run by the reader or their group, and direct browser use. The App
|
|
tutorial's mode descriptions link to that guide. When using the public site as an example,
|
|
keep its P2P-only limitation beside the explanation of optional SFU fallback.
|
|
Watching requires no installation. Self-hosting belongs in the bottom
|
|
documentation section: mark it as advanced, name its server/domain requirements
|
|
and link its complete guide. The existing-site guide links there for visitors
|
|
who want to run their own site. Explain what App and site each provide; optional SFU
|
|
fallback requires the site to enable it and is not a connectivity guarantee.
|
|
Keep architecture choices beside each platform's download buttons, with one
|
|
centered link for more downloads below the cards. Tutorials remain in their own
|
|
sections. Keep section navigation available on phones rather than hiding the
|
|
only route to documentation.
|
|
The film can use bolder composition, but must show real operations and concrete
|
|
benefits before its closing action. The [copy guide](./naming.md#voice-and-terminology)
|
|
owns technical disclosure; a dramatic heading does not exempt copy from it.
|
|
|
|
Review whole Chinese phrases, English meaning and adjacent number labels in
|
|
finished frames, not just the source string. Recheck the smallest viewport and
|
|
both languages when changing a title or its timing. Keep enough still time to
|
|
read it; do not solve overflow by shrinking an important caption beyond legibility.
|
|
|
|
Use the [shared visual language](./visual-language.md) for cast, objects,
|
|
accessible interaction and motion. This document owns the website's editorial
|
|
layout and introduction, not a separate product-status vocabulary.
|
|
|
|
Each section needs one reader question, evidence that answers it and a clear
|
|
next action. A scene should demonstrate one action or benefit before changing
|
|
the topic. Keep decorative words and transitions away from control labels and
|
|
the primary action; sound and motion must not carry essential instructions alone.
|
|
Gameplay reactions follow a visible result: establish the action, show its
|
|
success, then celebrate. Keep enough of the play visible to make the reaction
|
|
understandable; a genre label or a score burst does not replace the action.
|
|
|
|
Use mint walls, clear control edges, a warm orange/yellow sofa and the curious TV
|
|
mascot. The site is a welcoming room, not a monitoring dashboard. Keep one
|
|
primary action, native navigation and short instructions. Language and theme
|
|
follow the system unless explicitly changed; unsupported languages use English.
|
|
Respect reduced motion and retain useful content without JavaScript.
|
|
|
|
The room illustration cycles through four distinct uses: an RPG, drawing,
|
|
travel photos and a movie. Treat coding and design as creative work rather than
|
|
proliferating overlapping examples. The host holds a gamepad during the game;
|
|
the role badge identifies the host independently of the activity.
|
|
Keep participant drawings consistent across the site, READMEs,
|
|
interface captures and tooltip/status comics.
|
|
|
|
Present Piik as an open-source project: plain explanations, room for tinkering,
|
|
and an invitation to contribute. Keep the friendly illustration and avoid
|
|
company-style pitches, repeated slogans or claims about a support team.
|
|
The short comics illustrate choosing, inviting and joining, following the
|
|
shared motion grammar and whole-control replay rule. The optional film starts
|
|
only after an explicit action and has native buttons and a seek slider. Open it
|
|
within the homepage, loading its single player on demand; closing it unloads
|
|
playback. Keep one homepage playback entry; the player document also supports
|
|
local recording. Fullscreen watching keeps touch controls available; hiding
|
|
them is an explicit recording action.
|
|
Both READMEs share the friendly opening and room illustration. Their feature,
|
|
limitation and setup sections use the factual register in the copy guide.
|
|
|
|
Use a consistent README structure:
|
|
a distinct brand opening, bold headings and key phrases, regular explanatory
|
|
text, quiet captions and optional detail. Use images and short demonstrations
|
|
to explain different things rather than filling space. Keep essential setup and
|
|
availability in readable text, and distinguish generated demo content from a
|
|
real captured workload. GitHub-native Markdown/HTML must remain useful on mobile
|
|
and in both themes without custom CSS.
|
|
|
|
The product UI remains mascot-only. On the website, keep the header's TV
|
|
mascot before the Piik name. The wordmark and mascot do not transform
|
|
into one another. Match the product's
|
|
playful style through the mascot's wink and short comic interactions. An
|
|
original room illustration is shared by the site and READMEs. Interface previews
|
|
use generated scenes and sample participants. Keep private invitations,
|
|
user identities and personal media out of published assets; no external fonts
|
|
or tracking are needed.
|
|
|
|
## Small implementation
|
|
|
|
The website and film initially follow the browser's primary language: Chinese
|
|
uses Chinese copy, and other languages use English. An explicit language choice
|
|
is shared between these two pages and remembered; linked language choices take
|
|
precedence when following a link.
|
|
|
|
Use static HTML, CSS, SVG and small scripts for the homepage and film; no router,
|
|
CMS, translation dependency or new application backend. The documentation section
|
|
uses VitePress's standard navigation and search with Piik's colours and mascot.
|
|
It compiles existing Markdown; [website operations](../operations/website.md#documentation-build)
|
|
owns its publication list and build boundary. The film's isolated
|
|
demonstration frame bundles the existing React product components and styles,
|
|
using staged inputs. It cannot access storage, run capture or contact the room
|
|
service. The film clock owns its actions and decorative CSS animation positions.
|
|
Rebuilding the site picks up component/style/copy changes; changes to the actual
|
|
workflow still require reviewing the sequence and camera framing. Do not replace
|
|
shared controls with a second hand-drawn UI or retain obsolete screenshot plates.
|
|
The existing App/Web
|
|
continues to own sharing. The homepage explains it rather than simulating a
|
|
second room authority. Public copies of advanced product/research documents
|
|
are not automatically included in the website artifact.
|
|
|
|
The [website operations guide](../operations/website.md) owns Pages publication,
|
|
public destinations and the separate P2P-only demo. The primary action leads
|
|
to the platform download section. The website operations guide owns each
|
|
platform's latest download routes and provider labels. Link release notes
|
|
separately and verify destinations as part of publication.
|
|
Online, App and self-hosting walkthroughs
|
|
use real action names and explain the first sharing and viewing steps. Keep
|
|
platform requirements and connection limitations beside the relevant steps.
|
|
|
|
## Review boundary
|
|
|
|
Review desktop/mobile, English/Chinese, light/dark, keyboard navigation,
|
|
reduced motion, no JavaScript and a nested project URL. Check links, accurate
|
|
platform/connection claims and a single copy of each responsibility. Remove
|
|
decorative controls or code that do not improve understanding. This is a public
|
|
introduction overhaul, not an excuse to change configuration or media policy.
|