diff --git a/.github/APPROVED_CONTRIBUTORS b/.github/APPROVED_CONTRIBUTORS new file mode 100644 index 0000000..ba2edd6 --- /dev/null +++ b/.github/APPROVED_CONTRIBUTORS @@ -0,0 +1,9 @@ +# GitHub handles approved to bypass contribution auto-close +# Format: +# capability: +# issue future issues stay open +# pr future issues and PRs stay open +# Maintainers add people by replying `lgtmi` or `lgtm` on an issue +# (.github/workflows/approve-contributor.yml); editing this file by hand works too. + +fbl100 pr diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..2aa60c9 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +ko_fi: alexsouthwell diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..32009be --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,51 @@ +name: Bug report +description: Report something that's broken +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + **Before you start:** read [CONTRIBUTING.md](https://github.com/saphid/frame-control/blob/main/CONTRIBUTING.md). + + Issues from new contributors are auto-closed by default. A maintainer reviews them and reopens worthwhile ones. The [website feedback form](https://frame-control.pages.dev/feedback/) skips that queue. + + Keep this short. If it doesn't fit on one screen, it's too long. Write in your own voice. + + - type: textarea + id: description + attributes: + label: What happened? + description: Be specific. Include error messages and the last lines of the server log (Frame → Show Server Log). + validations: + required: true + + - type: textarea + id: repro + attributes: + label: Steps to reproduce + description: Minimal steps to trigger the bug. + validations: + required: false + + - type: textarea + id: expected + attributes: + label: Expected behavior + validations: + required: false + + - type: input + id: version + attributes: + label: Frame Control version + description: e.g. v0.3.1 + validations: + required: false + + - type: input + id: os + attributes: + label: Computer and SteamOS build + description: e.g. Windows 11, SteamOS 20260922.6101926 (Steam Settings → System) + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..af55e89 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Feedback form (no GitHub account needed, skips the queue) + url: https://frame-control.pages.dev/feedback/ + about: Bugs, ideas and questions from the website become issues here without being auto-closed. diff --git a/.github/ISSUE_TEMPLATE/idea.yml b/.github/ISSUE_TEMPLATE/idea.yml new file mode 100644 index 0000000..9f95ac7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/idea.yml @@ -0,0 +1,36 @@ +name: Idea or contribution proposal +description: Propose a change or feature (required for new contributors before opening a PR) +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + **Before you start:** read [CONTRIBUTING.md](https://github.com/saphid/frame-control/blob/main/CONTRIBUTING.md). + + Issues from new contributors are auto-closed by default. A maintainer reviews them and reopens worthwhile ones. + + Keep this short. If it doesn't fit on one screen, it's too long. Write in your own voice. + + - type: textarea + id: what + attributes: + label: What do you want to change? + description: Be specific and concise. + validations: + required: true + + - type: textarea + id: why + attributes: + label: Why? + description: What problem does this solve? + validations: + required: true + + - type: textarea + id: how + attributes: + label: How? (optional) + description: Brief technical approach, and whether you'd like to implement it yourself. + validations: + required: false diff --git a/.github/workflows/approve-contributor.yml b/.github/workflows/approve-contributor.yml new file mode 100644 index 0000000..9cf74ec --- /dev/null +++ b/.github/workflows/approve-contributor.yml @@ -0,0 +1,238 @@ +# Contributor gate adapted from badlogic/pi-mono (MIT) at 6f7551516b84. +# See CONTRIBUTING.md for how it works. + +name: Approve Contributor + +on: + issue_comment: + types: [created] + +jobs: + approve: + # Only maintainers' comments that might approve someone join the queue, and + # they run one at a time so two lgtm replies can't race on APPROVED_CONTRIBUTORS. + # (The script below still checks for write access.) + if: >- + contains(github.event.comment.body, 'lgtm') && + contains(fromJSON('["OWNER", "MEMBER", "COLLABORATOR"]'), github.event.comment.author_association) + concurrency: + group: approve-contributor + cancel-in-progress: false + queue: max + runs-on: ubuntu-latest + permissions: + contents: write + issues: write + pull-requests: write + steps: + - name: Checkout + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 + with: + ref: ${{ github.event.repository.default_branch }} + + - name: Update contributor approval + id: update + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + script: | + const fs = require('fs'); + + const APPROVED_FILE = '.github/APPROVED_CONTRIBUTORS'; + const VALID_CAPABILITIES = new Set(['issue', 'pr']); + const issueAuthor = context.payload.issue.user.login; + const commenter = context.payload.comment.user.login; + const commentBody = (context.payload.comment.body || '').trim(); + + const approvalAtStartPattern = /^[\s.]*(?:@[A-Za-z0-9](?:[A-Za-z0-9-]{0,37}[A-Za-z0-9])?(?:\s*,\s*|[.:]\s*|\s+))*(lgtmi|lgtm)(?=$|[\s]|[^\p{L}\p{N}_\s])/iu; + const approvalAtEndPattern = /(?:^|[\s.])(lgtmi|lgtm)\s*(?:[^\p{L}\p{N}_\s])?\s*$/iu; + const approvalMatch = commentBody.match(approvalAtStartPattern) ?? commentBody.match(approvalAtEndPattern); + + if (!approvalMatch) { + console.log('Comment does not start or end with lgtm or lgtmi'); + core.setOutput('status', 'skipped'); + return; + } + + const targetCapability = approvalMatch[1].toLowerCase() === 'lgtmi' ? 'issue' : 'pr'; + + try { + const { data: permissionLevel } = await github.rest.repos.getCollaboratorPermissionLevel({ + owner: context.repo.owner, + repo: context.repo.repo, + username: commenter, + }); + + if (!['admin', 'maintain', 'write'].includes(permissionLevel.permission)) { + console.log(`${commenter} does not have write access`); + core.setOutput('status', 'skipped'); + return; + } + } catch { + console.log(`${commenter} does not have collaborator access`); + core.setOutput('status', 'skipped'); + return; + } + + function parseMentionedUsers(body) { + const users = []; + const seenUsers = new Set(); + const mentionPattern = /(^|[^A-Za-z0-9_])@([A-Za-z0-9](?:[A-Za-z0-9-]{0,37}[A-Za-z0-9])?)(?![A-Za-z0-9-]|\/)/g; + + for (const match of body.matchAll(mentionPattern)) { + const username = match[2]; + const normalizedUser = username.toLowerCase(); + if (seenUsers.has(normalizedUser)) { + continue; + } + seenUsers.add(normalizedUser); + users.push(username); + } + + return users; + } + + function parseApprovedUsers(content) { + const lines = content.split('\n'); + const entries = []; + const users = new Map(); + + for (const line of lines) { + const trimmed = line.trim(); + if (!trimmed || trimmed.startsWith('#')) { + entries.push({ type: 'other', line }); + continue; + } + + const parts = trimmed.split(/\s+/); + if (parts.length !== 2) { + console.log(`Skipping malformed line: ${line}`); + entries.push({ type: 'other', line }); + continue; + } + + const [username, capability] = parts; + const normalizedCapability = capability.toLowerCase(); + if (!VALID_CAPABILITIES.has(normalizedCapability)) { + console.log(`Skipping line with invalid capability: ${line}`); + entries.push({ type: 'other', line }); + continue; + } + + const normalizedUser = username.toLowerCase(); + const entry = { type: 'user', username, normalizedUser, capability: normalizedCapability }; + entries.push(entry); + users.set(normalizedUser, entry); + } + + return { entries, users }; + } + + function stringifyApprovedUsers(entries) { + const normalizedEntries = [...entries]; + + while (normalizedEntries.length > 0) { + const lastEntry = normalizedEntries[normalizedEntries.length - 1]; + if (lastEntry.type !== 'other' || lastEntry.line.trim() !== '') { + break; + } + normalizedEntries.pop(); + } + + return `${normalizedEntries + .map((entry) => (entry.type === 'user' ? `${entry.username} ${entry.capability}` : entry.line)) + .join('\n')}\n`; + } + + const content = fs.readFileSync(APPROVED_FILE, 'utf8'); + const { entries, users } = parseApprovedUsers(content); + const mentionedUsers = parseMentionedUsers(commentBody); + const approvalTargets = mentionedUsers.length > 0 ? mentionedUsers : [issueAuthor]; + const changedTargets = []; + const alreadyTargets = []; + + for (const username of approvalTargets) { + const normalizedUser = username.toLowerCase(); + const existingEntry = users.get(normalizedUser); + const existingCapability = existingEntry?.capability ?? null; + + if (existingCapability === 'pr' || existingCapability === targetCapability) { + alreadyTargets.push(existingEntry?.username ?? username); + console.log(`${username} is already approved for ${existingCapability}`); + continue; + } + + if (existingEntry) { + existingEntry.capability = targetCapability; + changedTargets.push(existingEntry.username); + } else { + const entry = { type: 'user', username, normalizedUser, capability: targetCapability }; + entries.push(entry); + users.set(normalizedUser, entry); + changedTargets.push(username); + } + + console.log(`Set ${username} capability to ${targetCapability}`); + } + + core.setOutput('capability', targetCapability); + core.setOutput('changed_targets', JSON.stringify(changedTargets)); + core.setOutput('already_targets', JSON.stringify(alreadyTargets)); + + if (changedTargets.length === 0) { + core.setOutput('status', 'already'); + return; + } + + fs.writeFileSync(APPROVED_FILE, stringifyApprovedUsers(entries)); + core.setOutput('status', 'changed'); + + - name: Commit and push + if: steps.update.outputs.status == 'changed' + run: | + git config user.name "github-actions[bot]" + git config user.email "github-actions[bot]@users.noreply.github.com" + git add .github/APPROVED_CONTRIBUTORS + git diff --staged --quiet || git commit -m "chore: approve contributors from issue #${{ github.event.issue.number }}" + # main may have moved since checkout; replay the approval on top of it. + git pull --rebase origin "${{ github.event.repository.default_branch }}" + git push + + - name: Comment on issue + if: steps.update.outputs.status == 'changed' || steps.update.outputs.status == 'already' + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + CAPABILITY: ${{ steps.update.outputs.capability }} + CHANGED_TARGETS: ${{ steps.update.outputs.changed_targets }} + ALREADY_TARGETS: ${{ steps.update.outputs.already_targets }} + with: + script: | + const capability = process.env.CAPABILITY; + const changedTargets = JSON.parse(process.env.CHANGED_TARGETS || '[]'); + const alreadyTargets = JSON.parse(process.env.ALREADY_TARGETS || '[]'); + const defaultBranch = context.payload.repository.default_branch; + const formatTargets = (targets) => targets.map((target) => `@${target}`).join(', '); + const bodyLines = []; + + if (changedTargets.length > 0) { + if (capability === 'issue') { + bodyLines.push(`${formatTargets(changedTargets)} approved for issues. Future issues will not be auto-closed. PRs still require \`lgtm\` at the start of a maintainer reply (optionally after one or more \`@username\` mentions) or at the end.`); + } else { + bodyLines.push(`${formatTargets(changedTargets)} approved for issues and PRs. Future issues and PRs will not be auto-closed.`); + } + } + + if (alreadyTargets.length > 0) { + const verb = alreadyTargets.length === 1 ? 'is' : 'are'; + bodyLines.push(`${formatTargets(alreadyTargets)} ${verb} already approved.`); + } + + bodyLines.push('', `See [CONTRIBUTING.md](https://github.com/${context.repo.owner}/${context.repo.repo}/blob/${defaultBranch}/CONTRIBUTING.md).`); + const body = bodyLines.join('\n'); + + await github.rest.issues.createComment({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: context.issue.number, + body, + }); + diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml index 314bf4f..fb1e7fd 100644 --- a/.github/workflows/checks.yml +++ b/.github/workflows/checks.yml @@ -36,6 +36,8 @@ jobs: run: python -m unittest discover -s tests -v - name: App syntax run: node --check app/main.js && node --check app/build/make-icon.js && node --check app/build/fetch-deps.js && node --check app/preload.js && node --check app/install-link.js + - name: Website + run: node --test site/test/*.test.mjs && node --check site/public/js/site.js && node --check site/public/js/feedback.js # The server runs on each desktop OS the app ships for, on the Python version # the app bundles (app/build/fetch-deps.js) and, on Ubuntu, a newer one. diff --git a/.github/workflows/issue-gate.yml b/.github/workflows/issue-gate.yml new file mode 100644 index 0000000..8695373 --- /dev/null +++ b/.github/workflows/issue-gate.yml @@ -0,0 +1,134 @@ +# Contributor gate adapted from badlogic/pi-mono (MIT) at 6f7551516b84. +# See CONTRIBUTING.md for how it works. + +name: Issue Gate + +on: + issues: + types: [opened] + +jobs: + check-contributor: + runs-on: ubuntu-latest + permissions: + contents: read + issues: write + steps: + - name: Check issue author + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + script: | + const APPROVED_FILE = '.github/APPROVED_CONTRIBUTORS'; + const VALID_CAPABILITIES = new Set(['issue', 'pr']); + const TRUSTED_BOT_AUTHORS = new Set(['dependabot[bot]', 'sentry[bot]', 'claude[bot]']); + const issueAuthor = context.payload.issue.user.login; + const defaultBranch = context.payload.repository.default_branch; + const isBotAuthor = issueAuthor.endsWith('[bot]'); + + if (TRUSTED_BOT_AUTHORS.has(issueAuthor)) { + console.log(`Skipping trusted bot: ${issueAuthor}`); + return; + } + + async function getPermission(username) { + try { + const { data: permissionLevel } = await github.rest.repos.getCollaboratorPermissionLevel({ + owner: context.repo.owner, + repo: context.repo.repo, + username, + }); + return permissionLevel.permission; + } catch { + return null; + } + } + + async function getTextFile(path) { + const { data: fileContent } = await github.rest.repos.getContent({ + owner: context.repo.owner, + repo: context.repo.repo, + path, + ref: defaultBranch, + }); + + if (!('content' in fileContent) || typeof fileContent.content !== 'string') { + throw new Error(`Expected file content for ${path}`); + } + + return Buffer.from(fileContent.content, 'base64').toString('utf8'); + } + + function parseApprovedUsers(content) { + const users = new Map(); + + for (const rawLine of content.split('\n')) { + const line = rawLine.trim(); + if (!line || line.startsWith('#')) continue; + + const parts = line.split(/\s+/); + if (parts.length !== 2) { + console.log(`Skipping malformed line: ${rawLine}`); + continue; + } + + const [username, capability] = parts; + const normalizedCapability = capability.toLowerCase(); + if (!VALID_CAPABILITIES.has(normalizedCapability)) { + console.log(`Skipping line with invalid capability: ${rawLine}`); + continue; + } + + users.set(username.toLowerCase(), normalizedCapability); + } + + return users; + } + + const permission = await getPermission(issueAuthor); + if (!isBotAuthor && ['admin', 'maintain', 'write'].includes(permission)) { + console.log(`${issueAuthor} is a collaborator with ${permission} access`); + return; + } + + const approvedContent = await getTextFile(APPROVED_FILE); + const approvedUsers = parseApprovedUsers(approvedContent); + const capability = approvedUsers.get(issueAuthor.toLowerCase()); + + if (!isBotAuthor && (capability === 'issue' || capability === 'pr')) { + console.log(`${issueAuthor} is approved for ${capability}`); + return; + } + + const message = [ + 'This issue was auto-closed. All issues from new contributors are auto-closed by default.', + '', + `Maintainers review auto-closed issues regularly and reopen worthwhile ones. Issues that do not meet the quality bar in [CONTRIBUTING.md](https://github.com/${context.repo.owner}/${context.repo.repo}/blob/${defaultBranch}/CONTRIBUTING.md) will not be reopened or receive a reply.`, + '', + 'Just want to report a bug or share an idea? The [website feedback form](https://frame-control.pages.dev/feedback/) skips this queue.', + '', + 'If a maintainer replies `lgtmi` on one of your issues, your future issues will stay open. If a maintainer replies `lgtm`, your future issues and PRs will stay open. The command must be at the start of the reply (optionally after one or more `@username` mentions) or at the end.', + '', + `See [CONTRIBUTING.md](https://github.com/${context.repo.owner}/${context.repo.repo}/blob/${defaultBranch}/CONTRIBUTING.md).`, + ].join('\n'); + + await github.rest.issues.createComment({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: context.issue.number, + body: message, + }); + + await github.rest.issues.addLabels({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: context.issue.number, + labels: ['untriaged'], + }); + + await github.rest.issues.update({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: context.issue.number, + state: 'closed', + state_reason: 'not_planned', + }); diff --git a/.github/workflows/issue-triage-labels.yml b/.github/workflows/issue-triage-labels.yml new file mode 100644 index 0000000..0ce3f50 --- /dev/null +++ b/.github/workflows/issue-triage-labels.yml @@ -0,0 +1,145 @@ +# Contributor gate adapted from badlogic/pi-mono (MIT) at 6f7551516b84. +# See CONTRIBUTING.md for how it works. + +name: Issue Triage Labels + +on: + issues: + types: [reopened, labeled] + +jobs: + update-labels: + runs-on: ubuntu-latest + permissions: + issues: write + steps: + - name: Update triage labels + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + script: | + const UNTRIAGED_LABEL = 'untriaged'; + const NO_ACTION_LABEL = 'no-action'; + const LAST_READ_LABEL = 'last-read'; + const TO_DISCUSS_LABEL = 'to-discuss'; + const INPROGRESS_LABEL = 'inprogress'; + + function issueHasLabel(issue, labelName) { + return (issue.labels ?? []).some((label) => label.name === labelName); + } + + async function removeLabelIfPresent(issueNumber, issue, labelName) { + if (!issueHasLabel(issue, labelName)) { + console.log(`Issue #${issueNumber} does not have ${labelName}`); + return; + } + + try { + await github.rest.issues.removeLabel({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: issueNumber, + name: labelName, + }); + console.log(`Removed ${labelName} from #${issueNumber}`); + } catch (error) { + if (error.status === 404) { + console.log(`Label ${labelName} was already absent from #${issueNumber}`); + return; + } + throw error; + } + } + + if (context.payload.action === 'reopened') { + await removeLabelIfPresent(context.issue.number, context.payload.issue, UNTRIAGED_LABEL); + await removeLabelIfPresent(context.issue.number, context.payload.issue, NO_ACTION_LABEL); + return; + } + + if (context.payload.action === 'labeled' && context.payload.label?.name === NO_ACTION_LABEL) { + await removeLabelIfPresent(context.issue.number, context.payload.issue, UNTRIAGED_LABEL); + return; + } + + if (context.payload.action !== 'labeled' || context.payload.label?.name !== LAST_READ_LABEL) { + console.log('Not a last-read label event'); + return; + } + + const currentIssueNumber = context.issue.number; + const lastReadIssues = await github.paginate(github.rest.issues.listForRepo, { + owner: context.repo.owner, + repo: context.repo.repo, + state: 'all', + labels: LAST_READ_LABEL, + per_page: 100, + }); + + const previousIssueNumbers = lastReadIssues + .filter((issue) => !issue.pull_request) + .map((issue) => issue.number) + .filter((issueNumber) => issueNumber !== currentIssueNumber); + + if (previousIssueNumbers.length === 0) { + console.log('No previous last-read issue found'); + return; + } + + const previousIssueNumber = Math.max(...previousIssueNumbers); + if (currentIssueNumber <= previousIssueNumber) { + console.log( + `Last-read was added to old issue #${currentIssueNumber}; latest last-read is #${previousIssueNumber}`, + ); + return; + } + + const untriagedIssues = await github.paginate(github.rest.issues.listForRepo, { + owner: context.repo.owner, + repo: context.repo.repo, + state: 'all', + labels: UNTRIAGED_LABEL, + per_page: 100, + }); + + const issuesToMark = untriagedIssues + .filter((issue) => !issue.pull_request) + .filter((issue) => issue.number >= previousIssueNumber && issue.number <= currentIssueNumber) + .sort((a, b) => a.number - b.number); + + if (issuesToMark.length === 0) { + console.log(`No untriaged issues found from #${previousIssueNumber} to #${currentIssueNumber}`); + return; + } + + for (const issue of issuesToMark) { + if (issueHasLabel(issue, TO_DISCUSS_LABEL)) { + console.log(`Skipped ${NO_ACTION_LABEL} for #${issue.number} because it has ${TO_DISCUSS_LABEL}`); + } else { + await github.rest.issues.addLabels({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: issue.number, + labels: [NO_ACTION_LABEL], + }); + console.log(`Added ${NO_ACTION_LABEL} to #${issue.number}`); + } + + await github.rest.issues.update({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: issue.number, + state: 'closed', + state_reason: 'not_planned', + }); + console.log(`Closed #${issue.number} as not planned`); + + await removeLabelIfPresent(issue.number, issue, INPROGRESS_LABEL); + + await github.rest.issues.removeLabel({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: issue.number, + name: UNTRIAGED_LABEL, + }); + console.log(`Removed ${UNTRIAGED_LABEL} from #${issue.number}`); + } diff --git a/.github/workflows/pr-gate.yml b/.github/workflows/pr-gate.yml new file mode 100644 index 0000000..b5674c2 --- /dev/null +++ b/.github/workflows/pr-gate.yml @@ -0,0 +1,131 @@ +# Contributor gate adapted from badlogic/pi-mono (MIT) at 6f7551516b84. +# See CONTRIBUTING.md for how it works. + +name: PR Gate + +on: + pull_request_target: + types: [opened] + +jobs: + check-contributor: + runs-on: ubuntu-latest + permissions: + contents: read + issues: write + pull-requests: write + steps: + - name: Check if contributor is approved + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + script: | + const APPROVED_FILE = '.github/APPROVED_CONTRIBUTORS'; + const VALID_CAPABILITIES = new Set(['issue', 'pr']); + const TRUSTED_BOT_AUTHORS = new Set(['dependabot[bot]', 'sentry[bot]', 'claude[bot]']); + const prAuthor = context.payload.pull_request.user.login; + const defaultBranch = context.payload.repository.default_branch; + const isBotAuthor = prAuthor.endsWith('[bot]'); + + if (TRUSTED_BOT_AUTHORS.has(prAuthor)) { + console.log(`Skipping trusted bot: ${prAuthor}`); + return; + } + + async function getPermission(username) { + try { + const { data: permissionLevel } = await github.rest.repos.getCollaboratorPermissionLevel({ + owner: context.repo.owner, + repo: context.repo.repo, + username, + }); + return permissionLevel.permission; + } catch { + return null; + } + } + + async function getTextFile(path) { + const { data: fileContent } = await github.rest.repos.getContent({ + owner: context.repo.owner, + repo: context.repo.repo, + path, + ref: defaultBranch, + }); + + if (!('content' in fileContent) || typeof fileContent.content !== 'string') { + throw new Error(`Expected file content for ${path}`); + } + + return Buffer.from(fileContent.content, 'base64').toString('utf8'); + } + + function parseApprovedUsers(content) { + const users = new Map(); + + for (const rawLine of content.split('\n')) { + const line = rawLine.trim(); + if (!line || line.startsWith('#')) continue; + + const parts = line.split(/\s+/); + if (parts.length !== 2) { + console.log(`Skipping malformed line: ${rawLine}`); + continue; + } + + const [username, capability] = parts; + const normalizedCapability = capability.toLowerCase(); + if (!VALID_CAPABILITIES.has(normalizedCapability)) { + console.log(`Skipping line with invalid capability: ${rawLine}`); + continue; + } + + users.set(username.toLowerCase(), normalizedCapability); + } + + return users; + } + + async function closePullRequest(message) { + await github.rest.issues.createComment({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: context.payload.pull_request.number, + body: message, + }); + + await github.rest.pulls.update({ + owner: context.repo.owner, + repo: context.repo.repo, + pull_number: context.payload.pull_request.number, + state: 'closed', + }); + } + + const permission = await getPermission(prAuthor); + if (!isBotAuthor && ['admin', 'maintain', 'write'].includes(permission)) { + console.log(`${prAuthor} is a collaborator with ${permission} access`); + return; + } + + const approvedContent = await getTextFile(APPROVED_FILE); + const approvedUsers = parseApprovedUsers(approvedContent); + const capability = approvedUsers.get(prAuthor.toLowerCase()); + + if (!isBotAuthor && capability === 'pr') { + console.log(`${prAuthor} is approved for PRs`); + return; + } + + console.log(`${prAuthor} is not approved, closing PR`); + + const message = [ + 'This PR was auto-closed. Only contributors approved with `lgtm` can open PRs. Open an issue first and ask a maintainer for approval.', + '', + `Maintainers review auto-closed issues regularly. Issues that do not meet the quality bar in [CONTRIBUTING.md](https://github.com/${context.repo.owner}/${context.repo.repo}/blob/${defaultBranch}/CONTRIBUTING.md) will not be reopened or receive a reply.`, + '', + 'If a maintainer replies `lgtmi`, your future issues will stay open. If a maintainer replies `lgtm`, your future issues and PRs will stay open. The command must be at the start of the reply (optionally after one or more `@username` mentions) or at the end.', + '', + `See [CONTRIBUTING.md](https://github.com/${context.repo.owner}/${context.repo.repo}/blob/${defaultBranch}/CONTRIBUTING.md).`, + ].join('\n'); + + await closePullRequest(message); diff --git a/.github/workflows/remove-inprogress-on-close.yml b/.github/workflows/remove-inprogress-on-close.yml new file mode 100644 index 0000000..b1e9454 --- /dev/null +++ b/.github/workflows/remove-inprogress-on-close.yml @@ -0,0 +1,34 @@ +# Contributor gate adapted from badlogic/pi-mono (MIT) at 6f7551516b84. +# See CONTRIBUTING.md for how it works. + +name: Remove In Progress Label On Close + +on: + issues: + types: [closed] + +jobs: + remove-label: + runs-on: ubuntu-latest + permissions: + issues: write + steps: + - name: Remove inprogress label + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + script: | + const labelName = 'inprogress'; + const labels = context.payload.issue.labels ?? []; + const hasLabel = labels.some((label) => label.name === labelName); + + if (!hasLabel) { + console.log(`Issue does not have ${labelName} label`); + return; + } + + await github.rest.issues.removeLabel({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: context.issue.number, + name: labelName, + }); diff --git a/.gitignore b/.gitignore index d89ecc2..230bfe5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,7 @@ .DS_Store __pycache__/ apk-catalog/data/cache/ -apk-catalog/data/index-v2.json* +apk-catalog/data/index-v2*.json* compat-db/.env.lakebed.server compat-db/.lakebed/ tests/smoke/results/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f42d9fb --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,71 @@ +# Contributing to Frame Control + +This guide exists to save both sides time. The process is borrowed from +[pi](https://github.com/badlogic/pi-mono/blob/main/CONTRIBUTING.md). + +## Just want to report something? + +Use the [feedback form](https://frame-control.pages.dev/feedback/). It needs no +GitHub account, and what you send becomes an issue here that stays open. + +## The One Rule + +**You must understand your code.** If you can't explain what your change does +and how it interacts with the rest of the app, your PR will be closed. + +Using AI to write code is fine. Submitting AI-generated slop you don't +understand is not. + +## Contribution gate + +Issues and PRs opened on GitHub by new contributors are auto-closed by default. +A maintainer reviews auto-closed issues regularly and reopens worthwhile ones. +Issues that don't meet the quality bar below won't be reopened or get a reply. + +Approval happens through maintainer replies on issues: + +- `lgtmi`: your future issues won't be auto-closed +- `lgtm`: your future issues and PRs won't be auto-closed + +The word must be at the start of the reply (optionally after one or more +`@username` mentions) or at the end. Only `lgtm` lets you open PRs. Approved +people are listed in [`.github/APPROVED_CONTRIBUTORS`](.github/APPROVED_CONTRIBUTORS). + +## Quality bar for issues + +Use one of the issue templates, and keep it short, concrete and worth reading. + +- If it doesn't fit on one screen, it's too long. +- Write in your own voice. If you must use an LLM, say so in a clearly labelled + follow-up comment. +- State the bug or request clearly, and why it matters. +- For bugs, include your OS, your SteamOS build (Steam Settings → System), and + the server log (**Frame → Show Server Log** in the app). +- If you want to implement the change yourself, say so. + +## Before opening a PR + +Don't open a PR until a maintainer has approved you with `lgtm`. Open an +[idea or contribution proposal](https://github.com/saphid/frame-control/issues/new?template=idea.yml) +first. + +Then check your change: + +```sh +python3 -m unittest discover -s tests # server tests; no headset needed +node --test site/test/*.test.mjs # website feedback function +``` + +Say what you tested, and whether you tried it on a real Steam Frame. + +## Blocking + +If you ignore this document twice, or spam the tracker with agent-generated +issues, your GitHub account will be blocked from the repo. + +## Why auto-close? + +This is a hobby project with one maintainer. Auto-closing is a buffer against +burnout and tracker spam: issues get reviewed on the maintainer's schedule, and +the good ones are reopened. Short, concrete, reproducible reports and thoughtful +contributions are welcome. diff --git a/README.md b/README.md index 1fc7fc6..91cd678 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,17 @@ See what the headset sees, install games and Android apps, move files and text a [![Checks](https://img.shields.io/github/actions/workflow/status/saphid/steam-frame/checks.yml?branch=main&label=checks)](https://github.com/saphid/steam-frame/actions/workflows/checks.yml) [![License: MIT](https://img.shields.io/badge/license-MIT-66c0f4)](LICENSE) -[**Download**](#install) · [Features](#features) · [Set up the headset](#set-up-the-headset) · [Feedback](#feedback) · [Docs](#going-further) +[**Website**](https://frame-control.pages.dev) · [**Download**](#install) · [Trailer](#trailer) · [Features](#features) · [Set up the headset](#set-up-the-headset) · [Feedback](#feedback) · [Docs](#going-further)
Frame Control's Games tab: installed games, sideloaded titles, and your Steam library with Frame ratings + +Watch the Frame Control trailer + +The trailer: 66 seconds, with sound. Downloads the MP4 from the trailer release. + Unofficial hobby project, not affiliated with Valve. Free and open source. @@ -173,13 +178,17 @@ entry to `~/.ssh/config` and keys at `~/.ssh/id_ed25519_frame` and ## Feedback This is a first public test, so reports are really useful, especially from -Windows and Linux. Please [open an issue](https://github.com/saphid/steam-frame/issues/new) -with: +Windows and Linux. The quickest way is the +[feedback form](https://frame-control.pages.dev/feedback/): no GitHub account +needed, and it opens an issue here. Please include: - what you tried and what happened - your computer's OS and your SteamOS build (Steam Settings → System) - the server log: **Frame → Show Server Log** in the app +Issues and PRs opened directly on GitHub by new contributors are auto-closed +until a maintainer approves them; see [CONTRIBUTING.md](CONTRIBUTING.md). + ## Going further This repo also holds the scripts behind the app and field notes on how the diff --git a/docs/apks.md b/docs/apks.md index 050e58f..8bca60a 100644 --- a/docs/apks.md +++ b/docs/apks.md @@ -46,6 +46,33 @@ Lepton Development must be installed once. Over SSH, `ssh frame 'steam steam://install/3056000'` queues it, but the install still needs to be confirmed or started in the headset. +## When an app needs a newer Android + +Lepton is Android 11 (API 30), with arm64-v8a only. If Frame Control refuses +an APK, it shows compatible versions from F-Droid's main and archive repos and +IzzyOnDroid. It shows at most eight version names, newest first, preferring an +arm64-only build, and says how many compatible builds it found in total. +Each index is reduced to its compatible builds once a day and cached (about +16 MB). The first lookup takes about 30 s and 100 MB of memory; later ones are +instant. +Choose **Install** to download a listed version, verify its SHA-256 against +the index, and install it as its own app. + +You can also inspect a file or look up a package from the command line: + +```sh +python3 ui/frame_android.py info some-app.apk +python3 ui/frame_android.py versions some-app.apk +python3 ui/frame_android.py versions org.example.app +``` + +The search links open APKMirror, APKPure, Uptodown, F-Droid and GitHub. Pick a +version whose minimum is Android 11 or lower and that has an arm64-v8a build +(or no native code). Frame Control does not fetch APKs from those search sites. +Older versions may lack fixes, and being installable does not guarantee an +app will run: see the missing services below. Android may refuse a downgrade +or an update signed by a different publisher; removing the app deletes its data. + ## Installed apps disappear when Lepton Development closes (verified 2026-09-25) Lepton Development runs in a throwaway "dev" context. When it exits for any diff --git a/docs/how-the-frame-works.md b/docs/how-the-frame-works.md index 696854e..7657f75 100644 --- a/docs/how-the-frame-works.md +++ b/docs/how-the-frame-works.md @@ -33,6 +33,7 @@ Lepton (Android 11, podman container "lepton-dev") ← its own panel, app 305600 | SteamVR's `steamvr-v4l2cam.service` (`/opt/steamvr/bin/linuxarm64/v4l2cam --output=99`) copies the headset view (the `system.HeadsetView` mirror, one undistorted image) into the v4l2loopback device `/dev/video99` ("SteamVR"), 1920×1080 RGB24. `ffmpeg -f v4l2 -i /dev/video99` reads it at about 70 new frames/s; the first frame read can be black. The Frame's hardware encoder (`iris_encoder`, `/dev/video-enc0`) crashes ffmpeg's `h264_v4l2m2m`, so encode with `libx264 -preset ultrafast -tune zerolatency`: 720p30 takes about 0.7 of a core and 1080p60 about 1.7 (of 8). gamescope also publishes a PipeWire `gamescope` video source, but the Frame's GStreamer has no `pipewiresrc`. **Verified 2026-09-26.** | Frame Control's live video (`/api/stream`) | | Battery: `/sys/class/power_supply/max1720x_bat_7-36` gives µV/µA (current is positive while charging), `time_to_full_now`/`time_to_empty_now` in seconds, and `temp` in tenths of °C. The charger shows up as `tcpm-source-psy-…` (`type=USB`, `usb_type=C PD [PD_PPS]`), for example 12 V × 1.67 A. | Frame Control's battery card | | `vrcmd --stats` reports `activity_level` (3 = standby). | Telling whether the headset is being worn | +| **Testing VR apps without wearing the headset.** In standby SteamVR keeps OpenXR sessions hidden, so they render one frame and stop. `vrcmd` (in `/opt/steamvr/bin/linuxarm64`) settings use `section.key`: `vrcmd --set-settings-bool power.pauseCompositorOnStandby 0` and `vrcmd --set-settings-float power.turnOffScreensTimeout 3600`, then `vrcmd --handlewakeup`, keep the compositor running, and the scene app becomes visible. If it stays `visible-blurred`, the Steam dashboard is open: `SteamClient.OpenVR.VROverlay.HideDashboard()` in Steam's `SharedJSContext` (CDP on 8080) closes it. The headset view then captures with `ui/frame_vrshot.py`. Restore afterwards with `--set-settings-bool power.pauseCompositorOnStandby 1` and `--set-settings-float power.turnOffScreensTimeout 5`. The bool setter reads `true` as false, so use 1/0. A Steam launch that stalls in standby at `ShowInterstitials` or `CreatingProcess` (see `console_log.txt`) continues with `SteamClient.Apps.ContinueGameAction(, "", "")`. **Verified 2026-09-27.** | Proving VR output remotely, [webxr-chromium.md](webxr-chromium.md) | | The SteamVR dashboard has docking: Float in World, Move, Size, Curvature, controller docking, Theater, Multitasking View. **Inferred** from `/opt/steamvr/resources/webinterface/dashboard/` and not yet driven by hand. | [panels.md](panels.md) | | SteamVR settings live in `~/.config/openvr/config/steamvr.vrsettings`, not under `~/.local/share/Steam/config/`. `dashboard.lastAccessedExternalOverlayKey` names the last panel you used. | Settings tweaks | | The Steam client's journal (`journalctl --user`) carries SteamVR system UI lines such as `[Overlays] Created: …` and `vroverlay_uid`. It's the quickest way to see panels come and go. | Debugging | diff --git a/docs/img/trailer.jpg b/docs/img/trailer.jpg new file mode 100644 index 0000000..0f48fa6 Binary files /dev/null and b/docs/img/trailer.jpg differ diff --git a/docs/open-questions.md b/docs/open-questions.md index 44583b2..13b4c45 100644 --- a/docs/open-questions.md +++ b/docs/open-questions.md @@ -33,14 +33,19 @@ build 20260922.6101926, kernel 6.18, aarch64): - **10.** `install-apps.sh remmina --vnc-host .local` installed Remmina as a `--user` Flatpak over SSH and wrote the profile. The desktop's `XDG_DATA_DIRS` includes the user Flatpak exports, so it shows up in the menu. - The Frame can reach the Mac's Screen Sharing port (5900). The Remmina - connection itself hasn't been tried in the headset yet (part of 11). + The Frame can reach the Mac's Screen Sharing port (5900). +- **11.** Answered 2026-09-27 (BUILD_ID 20260925.6191901, macOS 27.0): the + pre-seeded profile connects and shows the Mac in its own panel. It asks for + the Mac account login rather than the VNC password, needs scale-to-fit at + Retina resolutions, and doesn't show the Mac cursor without + `scripts/mac-cursor-ring.lua`. It's usable but noticeably laggy. See + [streaming.md](streaming.md). - **Panels.** An X11 window on gamescope's `:0` with its own `STEAM_GAME` id gets its own SteamVR overlay (`valve.steam.desktopgame.`). Three were created side by side with `panel-on-frame.sh`. See [panels.md](panels.md). -Still open: 4, 6, 7, 11 (in-headset connect), 12–15, 16 (off-LAN and after a reboot), 17–21. +Still open: 4, 6, 7, 12–15, 16 (off-LAN and after a reboot), 17–21. ## Check on the headset (in order) @@ -70,12 +75,10 @@ Still open: 4, 6, 7, 11 (in-headset connect), 12–15, 16 (off-LAN and after a r `ssh frame 'command -v wl-copy xclip rsync flatpak'`. 10. **Can Flatpaks be installed `--user` over SSH, and do they appear in the headset's desktop?** Test with `./scripts/install-apps.sh remmina`. -11. **Remmina → macOS Screen Sharing:** does it connect, and is it usable at - Retina resolutions? Is the pre-seeded profile path - (`~/.var/app/org.remmina.Remmina/data/remmina/`) the one Remmina - actually reads? -12. **Moonlight Flatpak (aarch64) + Sunshine on macOS:** worth trying only if - VNC is too slow. +11. ~~**Remmina → macOS Screen Sharing**~~: answered 2026-09-27; see above + and [streaming.md](streaming.md). +12. **Moonlight Flatpak (aarch64) + Sunshine on macOS:** VNC works but is + noticeably laggy, so this is worth trying. 13. **KDE Connect**: is it preinstalled or installable on the Frame, and does it pair with KDE Connect for macOS? 14. **Bluetooth keyboard pairing** on the Frame, for the rare times you do need @@ -86,8 +89,9 @@ Still open: 4, 6, 7, 11 (in-headset connect), 12–15, 16 (off-LAN and after a r runs as a lingering user service with no sudo; see [tailscale.md](tailscale.md). Still open: reaching the Frame from outside the home network, and the service starting after a reboot. -17. **Floating panels in the headset** (see [panels.md](panels.md)): do the - panels from `panel-on-frame.sh` show up, take input, and offer **Float in +17. **Floating panels in the headset** (see [panels.md](panels.md)): panels + from `panel-on-frame.sh` show up and take controller input (verified + 2026-09-27 with `mac-screen`). Still open: do they offer **Float in World** / **Move** / **Size**? Do floating positions survive closing and reopening the app, or a reboot? 18. **`LEPTON_NO_CLEANUP=1 %command%`** as Lepton Development's launch @@ -129,8 +133,6 @@ Still open: 4, 6, 7, 11 (in-headset connect), 12–15, 16 (off-LAN and after a r - `/home` and `/etc` persist across Frame OS updates. This is inferred from Steam Deck behaviour. -- The whole Mac → Frame desktop path (VNC → Remmina). Each part is documented - separately, but the combination is untested. - Steam Remote Play with a Mac as host is broken. That's based on community reports, not tested with the Frame. - `connect.sh --harden`, `serve-bootstrap.sh` and diff --git a/docs/scripts.md b/docs/scripts.md index 464c5a6..ad11ebd 100644 --- a/docs/scripts.md +++ b/docs/scripts.md @@ -93,7 +93,8 @@ controls to place each panel. See [docs/panels.md](panels.md). | `scripts/install-apps.sh` | Mac → Frame | Install Flatpaks (Remmina, Moonlight, …) on the Frame over SSH as `--user` (**verified** with Remmina) | | `scripts/paste-to-frame.sh` | Mac → Frame | Send the Mac clipboard (or stdin) to the Frame clipboard (**verified**) | | `scripts/install-apk.sh` | Mac → Frame | Install APKs, each as its own persistent Lepton instance with a Steam library shortcut (`--dev`: old ADB path into Lepton Development) (**verified**; see [docs/apks.md](apks.md)) | -| `scripts/panel-on-frame.sh` | Mac → Frame | Start an app as its own floating VR panel, outside the desktop (**verified**: overlays created; in-headset placement not yet checked) | +| `scripts/panel-on-frame.sh` | Mac → Frame | Start an app as its own floating VR panel, outside the desktop (**verified**, including `mac-screen` in the headset) | +| `scripts/mac-cursor-ring.lua` | Mac | Hammerspoon script: a ring around the Mac pointer so it shows in the VNC mirror (**verified**) | | `scripts/run-on-frame.sh` | Mac → Frame | Start an app on the headset desktop, e.g. `mac-screen` opens Remmina straight into the Mac (**verified**) | | `scripts/frame-ui.sh` | Mac | Start the Frame Control web UI (`ui/server.py`) and open it (**verified**) | | `scripts/apk-catalog.sh` | Mac | Refresh the rated F-Droid catalogue that Frame Control's Android section shows (**verified**) | diff --git a/docs/streaming.md b/docs/streaming.md index a9a4f5f..6d85ac6 100644 --- a/docs/streaming.md +++ b/docs/streaming.md @@ -34,7 +34,7 @@ flat 2D desktop streaming into a window on the Frame's Linux desktop. | Option | Setup | Confidence | Verdict | |---|---|---|---| -| **macOS Screen Sharing (VNC) → Remmina on the Frame** | **Mac:** System Settings → General → Sharing → Screen Sharing on → (i) → enable "VNC viewers may control screen with password". **Frame:** `./scripts/install-apps.sh remmina` from the Mac, then open Remmina in the headset and connect to `vnc://.local` | **Inferred.** Remmina is on Flathub for **aarch64** with VNC and RDP ([Flathub](https://flathub.org/apps/org.remmina.Remmina)). The Frame desktop runs Flatpaks ([UploadVR](https://www.uploadvr.com/flatpaks-open-source-steam-frame/)). macOS VNC is built in. | **Recommended.** Nothing to install on the Mac, and it's easy to set up. Latency is fine for productivity but not for games. You'll type the Mac's hostname once in Remmina on the headset, then save the profile. To avoid even that, the script can pre-seed a Remmina profile over SSH (see below). | +| **macOS Screen Sharing (VNC) → Remmina on the Frame** | **Mac:** System Settings → General → Sharing → Screen Sharing on → (i) → enable "VNC viewers may control screen with password". **Frame:** `./scripts/install-apps.sh remmina` from the Mac, then open Remmina in the headset and connect to `vnc://.local` | **Verified 2026-09-27** (Frame BUILD_ID 20260925.6191901, macOS 27.0), in its own panel via `panel-on-frame.sh mac-screen`. Remmina is on Flathub for **aarch64** with VNC and RDP ([Flathub](https://flathub.org/apps/org.remmina.Remmina)). The Frame desktop runs Flatpaks ([UploadVR](https://www.uploadvr.com/flatpaks-open-source-steam-frame/)). macOS VNC is built in. | **Recommended.** Nothing to install on the Mac, and it's easy to set up. Noticeable lag, even at lower Remmina quality settings on a good 5 GHz link, where neither Wi-Fi nor the Frame's CPU was the bottleneck. Usable for reading and coding, but not for games. You'll type the Mac's hostname once in Remmina on the headset, then save the profile. To avoid even that, the script can pre-seed a Remmina profile over SSH (see below). | | Sunshine (Mac) → Moonlight (Frame Flatpak) | `brew install` Sunshine on the Mac, then `./scripts/install-apps.sh moonlight` | Moonlight Flatpak supports **aarch64** ([Flathub](https://flathub.org/apps/com.moonlight_stream.Moonlight)). **Sunshine on macOS is poorly supported**: install problems on Apple Silicon/Sequoia, and no virtual gamepads ([LizardByte discussion #777](https://github.com/orgs/LizardByte/discussions/777)). | Try it if VNC is too laggy. Expect some friction. | | Steam Remote Play with the Mac as host | Steam on the Mac, Steam Link/Remote Play on the Frame | macOS-hosted Remote Play is reported broken or flaky in 2024–2026 ([Steam discussion](https://steamcommunity.com/groups/homestream/discussions/1/574921459914429988/)) | Not recommended. It's only for games, if it works at all. | | Immersed / Virtual Desktop | Vendor apps | Immersed has a Mac agent but no known Frame client. Virtual Desktop's developer said he'd "try" to port it ([NewsBreak](https://www.newsbreak.com/news/4892834783961-virtual-desktop-dev-says-he-ll-try-to-bring-the-app-to-steam-frame)). | Not available as of 2026-09-25. Check again later. | @@ -47,11 +47,38 @@ them on the Frame in DeoVR instead: see [vr-video.md](vr-video.md). `scripts/install-apps.sh remmina --vnc-host .local` writes `~/.var/app/org.remmina.Remmina/data/remmina/mac-screen-sharing.remmina` on the Frame over -SSH. The profile then appears in Remmina's list, and you just click it. You'll -still be asked for the VNC password in the headset the first time, unless you -choose to save it. Remmina stores passwords encrypted with a per-install key, -so the script doesn't try to write the password. (The Remmina file format is -standard; the Flatpak data path is inferred.) +SSH. The profile then appears in Remmina's list, and you just click it. It +scales the Mac's desktop to fit the window (`scale=1`, `viewmode=1`). Without +that, Remmina shows a Retina Mac's native pixels 1:1, so you see a zoomed-in +corner. (Verified 2026-09-27.) + +**Expect a Mac login prompt, not the VNC password.** macOS offers Apple's own +authentication (RFB security type 30) ahead of plain VNC auth (type 2), and +Remmina picks it. So Remmina asks for your **Mac account name and login +password**; the "VNC viewers may control screen" password isn't used. To store +the password without typing it in the headset, run on the Frame: + +```sh +printf '%s' "$PASSWORD" | flatpak run org.remmina.Remmina \ + --update-profile ~/.var/app/org.remmina.Remmina/data/remmina/mac-screen-sharing.remmina \ + --set-option password +``` + +Remmina encrypts it into the profile with its own key, because there's no +secret service in the SSH session. (Verified 2026-09-27.) + +### The Mac's cursor + +The mirror doesn't show the Mac's pointer, with either `showcursor` value. +macOS keeps the pointer out of the picture it sends, and Remmina's cursor mode +draws the cursor shape only at the Frame's own pointer, which doesn't follow +the Mac trackpad. `scripts/mac-cursor-ring.lua` works around this: a +[Hammerspoon](https://www.hammerspoon.org/) script that draws a ring around the +Mac pointer as a real window, so it's part of the mirrored picture. Setup is in +its header. (Verified 2026-09-27.) + +Going the other way, pointing a controller at the panel moves the Mac's mouse, +because Remmina forwards input (`viewonly=0`). ## C. Show the iPhone's screen inside the Frame diff --git a/docs/webxr-chromium.md b/docs/webxr-chromium.md index df151fc..f07d8c0 100644 --- a/docs/webxr-chromium.md +++ b/docs/webxr-chromium.md @@ -3,9 +3,11 @@ Goal: open a web VR180 or 360 player (DeoVR and DL8 embeds, WebXR samples), press its VR button, and watch in 3D in the headset. -A standalone, public version of this build (build script, the SO_PEERCRED -patch, and a Frame-side installer that adds "Chromium XR" to the Steam library) -is at [saphid/chromium-webxr-steam-frame](https://github.com/saphid/chromium-webxr-steam-frame). +The build and installer now live in their own public repo, +[saphid/chromium-webxr-steam-frame](https://github.com/saphid/chromium-webxr-steam-frame): +a build script for an x86-64 Linux host, the SO_PEERCRED patch, and a +Frame-side installer that adds "Chromium XR" to the Steam library. This page +keeps the findings and what was verified on this Frame. ## Why Flathub Chromium can't @@ -45,76 +47,52 @@ gets both. SteamVR (`bin/linuxarm64/vrclient.so`, `VALVE_runtime_is_steamvr`). The Linux backend uses Vulkan (`XR_USE_GRAPHICS_API_VULKAN`). -## Building it +## Building and installing it -[`scripts/build-chromium-xr.sh`](../scripts/build-chromium-xr.sh) -cross-compiles arm64 Linux Chromium on an x64 Linux host. It doesn't need -sudo: the arm64 sysroot comes from Chromium's own script. It needs about -90 GB of disk. It shallow-fetches the CL ref (patchset 44), runs -`gclient sync --no-history`, installs the sysroot, applies one extra seccomp -fix (below), builds `chrome` with `symbol_level=0` and proprietary codecs, and -packs `chromium-xr-arm64.tar.xz` (about 145 MB, GPU libraries included). -Progress is logged to `~/chromium-xr/stage`. The build aborts if the disk -holding `~/chromium-xr` drops below 12 GB free. +Follow the [public repo's README](https://github.com/saphid/chromium-webxr-steam-frame#build). +In short: `build/build.sh` on an x64 Linux host (no sudo, about 90 GB of +disk) produces `chromium-xr-arm64.tar.xz` (about 145 MB), and +`frame/install.sh` on the Frame unpacks it to `~/chromium-xr`, installs the +`chromium-xr` launcher in `~/.local/bin`, and adds the Steam library shortcut +through the Steam client's DevTools port, the same way as T3 Code +([apks.md](apks.md)). Launching the shortcut gives Chromium its own panel, +`valve.steam.desktopgame.`, like any other app. -First run, 2026-09-25, on a 12-core, 31 GB x64 Linux box: 9 h 33 min for +First build, 2026-09-25, on a 12-thread, 31 GB x64 Linux box: 9 h 33 min for 94,835 steps, giving Chromium 156.0.8071.0. A rebuild after a one-file change takes under a minute, plus about 4 minutes to repack. -**The extra fix.** The CL's XR seccomp policy refuses `getsockopt`. SteamVR's +To debug from the Mac, launch it as a panel with DevTools on the Frame +(verified 2026-09-27): +`scripts/panel-on-frame.sh -- '~/.local/bin/chromium-xr' --remote-debugging-port=9223 URL` +([panels.md](panels.md)). DevTools has no authentication. It listens on +loopback, but with the userspace Tailscale from [tailscale.md](tailscale.md) +running, loopback ports are reachable from your tailnet. Close the browser +when you're done. Chromium runs one browser per profile, so close the +Steam-launched one first or the flag is ignored. + +**The SO_PEERCRED fix.** The XR seccomp policy refuses `getsockopt`. SteamVR's client calls `getsockopt(SOL_SOCKET, SO_PEERCRED)` inside `xrCreateInstance`, -so the XR process died with a seccomp crash (arm64 syscall 209). The script -allows that one option. That's needed but not enough: `launch` still turns +so the XR process died with a seccomp crash (arm64 syscall 209). The patch +allows that one option. It's needed but not enough: the launcher still turns seccomp off (below), so the patch only matters once that's fixed too. -## Running it on the Frame +**Seccomp is off.** The launcher passes `--disable-seccomp-filter-sandbox`. +With the XR seccomp policy on, SteamVR's client reads `/proc/self/status` +through Chrome's file broker and gets the broker's pid. SteamVR then binds +the app to the wrong process ("Unable to init path manager: +VRInitError_Init_Internal") and `xrCreateInstance` fails. The broker can't +answer `/proc/self` for another process, so fixing this needs a change in +Chromium's broker client or in the CL. The namespace sandbox stays on, but +seccomp is off for every process, so use this profile for VR sites rather +than everyday browsing. -[`scripts/chromium-xr.sh`](../scripts/chromium-xr.sh): - -```sh -BUILD_HOST=my-linux-box scripts/chromium-xr.sh install # your build host; scp, unpack to ~/chromium-xr -scripts/chromium-xr.sh launch [URL] # its own VR panel, --enable-features=OpenXR -scripts/chromium-xr.sh steam # adds "Chromium XR" to the Steam library -scripts/chromium-xr.sh check # prints isSessionSupported('immersive-vr') -``` - -It runs natively, not as a Flatpak. `launch` opens it as its own panel on -gamescope's X display, the same way as [`panel-on-frame.sh`](../scripts/panel-on-frame.sh) ([panels.md](panels.md)), so -the Plasma desktop doesn't need to be open. It uses its own profile -(`~/.config/chromium-xr`) and DevTools on loopback port 9223, so it doesn't -collide with the Flatpak's 9222. When a page enters VR, Chrome asks -**Allow VR?** in the browser panel; choose *Allow this time* or *Allow while -visiting the site*. - -Both ways of starting it run -[`frame/chromium-xr/launch.sh`](../frame/chromium-xr/launch.sh), copied to -`~/Applications/ChromiumXR/launch.sh` on the Frame, which holds Chrome's flags. -It sits outside `~/chromium-xr` so `install` doesn't delete it. - -**From the Steam library (verified 2026-09-26).** `steam` adds a non-Steam -shortcut called "Chromium XR" (with the Flathub Chromium icon, if that's -installed) through the Steam client's DevTools port, the same way as T3 Code -([apks.md](apks.md)), without restarting Steam. It saves the app id in -`~/Applications/ChromiumXR/shortcut-appid`, so rerunning it, even after you -rename the shortcut in the library, doesn't add a second one. On this Frame -the shortcut app id is 2240749789. Launching it from the library gives -Chromium its own panel, `valve.steam.desktopgame.2240749789`, like any other -app. A Steam launch doesn't open a DevTools port, so `check` needs `launch`. -Chromium runs one browser per profile: while the Steam-launched one is open, -`launch` opens its URL in that window, without DevTools, then prints -`failed: ... exited` because no new window appeared. Close it first. - -**Seccomp is off.** The wrapper passes `--disable-seccomp-filter-sandbox`. With -the XR seccomp policy on, SteamVR's client reads `/proc/self/status` through -Chrome's file broker and gets the broker's pid. SteamVR then binds the app to -the wrong process ("Unable to init path manager: VRInitError_Init_Internal") -and `xrCreateInstance` fails. The broker can't answer `/proc/self` for another -process, so fixing this needs a change in Chromium's broker client or in the -CL. The namespace sandbox stays on, but seccomp is off for every process, so -use this profile for VR sites rather than everyday browsing. DevTools on -port 9223 has no authentication. It listens on loopback, but with the -userspace Tailscale from [tailscale.md](tailscale.md) running, loopback ports -are reachable from your tailnet. Close the browser when you're done. +**Upstream (2026-09-27).** CL 8441736 (the XR sandbox) has merged into +Chromium, still refusing `getsockopt`; CL 8132979 is still in review. Valve +and the CLs' author are working on Steam Frame support +([utzcoz/chromium-webxr-linux#5](https://github.com/utzcoz/chromium-webxr-linux/issues/5)). +Both sandbox problems above, with the patch, are reported in +[utzcoz/chromium-webxr-linux#7](https://github.com/utzcoz/chromium-webxr-linux/issues/7). **Verified 2026-09-26** (Frame BUILD_ID 20260922.6101926, SteamVR 2.17.10, this build): @@ -138,9 +116,26 @@ this build): [`webxr_vr_video`](https://threejs.org/examples/webxr_vr_video.html) demo, a stereo 360 video, played in 3D after pressing Enter VR. -**Not verified yet:** +- **Launched from the Steam library, verified remotely 2026-09-27** with + nobody wearing the headset (standby workaround in + [how-the-frame-works.md](how-the-frame-works.md)). The installer's Steam + shortcut starts Chromium, and SteamVR takes it as scene app + `steam.app.`. A minimal WebXR session that clears every frame + to red ran at about 75 frames per second, and the stereo headset capture + showed both eyes solid red. Steam preloads its overlay + (`gameoverlayrenderer.so`), which crashed Chromium's zygote about 30 s after + a Steam launch. The public repo's launcher now removes it from + `LD_PRELOAD`. With the headset outside its playspace, SteamVR shows + passthrough wherever the page leaves transparent pixels. -- Frame rate and dropped frames during playback (nothing was measured; it - looked fine). -- Third-party VR180 players (DeoVR and DL8 web embeds). -- Controller and hand input inside a WebXR page. +- **Frame rate and input, measured 2026-09-27** (standby workaround, red + test session): 72 fps with every frame at 13.9–14 ms over 16 s, and SteamVR + dropped frames only at startup. The right controller showed up as an + `oculus-touch` `tracked-pointer` with an `xr-standard` gamepad and a + 25-joint hand, with poses on every frame. A real squeeze reached the page + as `squeezestart`/`squeeze`. Haptics aren't exposed (no actuators). + Details are in the public repo's technical notes. + +**Not verified yet:** trigger, thumbstick and face buttons, the left +controller, bare-hand tracking, and third-party VR180 players (DeoVR and +DL8 web embeds). diff --git a/frame/chromium-xr/launch.sh b/frame/chromium-xr/launch.sh deleted file mode 100755 index f31e027..0000000 --- a/frame/chromium-xr/launch.sh +++ /dev/null @@ -1,27 +0,0 @@ -#!/bin/bash -# Frame-side: start the WebXR Chromium build (~/chromium-xr). The Steam -# library shortcut "Chromium XR" runs this, and so does -# `scripts/chromium-xr.sh launch` (which adds a DevTools port). Extra -# arguments go to Chrome, so a URL opens that page. -# -# Lives in ~/Applications/ChromiumXR, outside ~/chromium-xr, so reinstalling -# the build doesn't delete it. -set -euo pipefail - -CHROME="$HOME/chromium-xr/chrome" -[[ -x "$CHROME" ]] || { echo "launch.sh: no build at $CHROME (run chromium-xr.sh install)" >&2; exit 1; } - -# Without --no-first-run and --password-store=basic, startup can stop at a -# first-run or keyring prompt. -# --disable-seccomp-filter-sandbox: under the XR seccomp policy, SteamVR's -# client reads /proc/self/status through the file broker, gets the broker's -# pid, and SteamVR binds the app to the wrong process, so xrCreateInstance -# fails. The namespace sandbox stays on, but seccomp is off for every -# process, so keep this profile for VR sites. -exec "$CHROME" \ - --user-data-dir="$HOME/.config/chromium-xr" \ - --enable-features=OpenXR \ - --ozone-platform=x11 \ - --no-first-run --no-default-browser-check --password-store=basic \ - --disable-seccomp-filter-sandbox \ - "$@" diff --git a/scripts/build-chromium-xr.sh b/scripts/build-chromium-xr.sh deleted file mode 100755 index 4b1dafb..0000000 --- a/scripts/build-chromium-xr.sh +++ /dev/null @@ -1,135 +0,0 @@ -#!/bin/bash -# Linux-side (x64 host): cross-compile arm64 Chromium with the Linux OpenXR CLs -# (8441736 + 8132979, bug 506004811), plus a one-option seccomp fix, so WebXR -# immersive-vr works on the Frame. -# Needs ~90 GB free, no sudo. Takes hours; run it detached on the build host: -# scp scripts/build-chromium-xr.sh buildhost:chromium-xr/build.sh -# ssh buildhost 'cd ~/chromium-xr && tmux new -d -s chromium-xr "./build.sh > build.log 2>&1"' -# Progress: ~/chromium-xr/stage. Output: ~/chromium-xr/chromium-xr-arm64.tar.xz, -# which scripts/chromium-xr.sh install copies to the Frame. -# Re-running resumes: existing checkout and out/XR are reused. -set -euo pipefail -W=~/chromium-xr -cd "$W" -stage(){ echo "$(date -Is) $*" | tee -a "$W/stage"; } -# Returns non-zero below 12 GB free; set -e turns that into an exit at top level. -guard(){ avail=$(df --output=avail -BG "$W" | tail -n 1 | tr -dc 0-9); if [ "$avail" -lt 12 ]; then stage "ABORT: only ${avail}G free for $W"; return 3; fi; } -[ -d depot_tools ] || git clone -q https://chromium.googlesource.com/chromium/tools/depot_tools.git -export PATH="$W/depot_tools:$PATH" DEPOT_TOOLS_UPDATE=1 DEPOT_TOOLS_METRICS=0 -CL_REF=refs/changes/79/8132979/44 -if [ ! -f .gclient ]; then - cat > .gclient <<'G' -solutions = [{ "name": "src", "url": "https://chromium.googlesource.com/chromium/src.git", - "managed": False, "custom_deps": {}, "custom_vars": { "checkout_nacl": False } }] -target_os = ["linux"] -target_cpu = ["arm64"] -G -fi -# Keyed on a real commit, so an interrupted first fetch is retried on re-run. -if ! git -C src rev-parse -q --verify HEAD >/dev/null 2>&1; then - stage "clone src at $CL_REF" - mkdir -p src - [ -d src/.git ] || git -C src init -q - git -C src remote get-url origin >/dev/null 2>&1 || git -C src remote add origin https://chromium.googlesource.com/chromium/src.git - git -C src fetch -q --depth=1 origin "$CL_REF" - git -C src checkout -q FETCH_HEAD -fi -guard -stage "src at $(git -C src log -1 --format='%h %s')" -rev=$(git -C src rev-parse HEAD) -# Sync once per revision: once the patch below is applied, gclient sync -# refuses to run on the modified checkout, so re-runs must skip it. -if [ "$(cat "$W/synced" 2>/dev/null)" != "$rev" ]; then - stage "gclient sync" - gclient sync --nohooks --no-history -D --shallow --revision "src@$rev" -j 8 - guard - stage "runhooks" - gclient runhooks - src/build/linux/sysroot_scripts/install-sysroot.py --arch=arm64 - echo "$rev" > "$W/synced" -fi -guard -cd src -# CL 8441736's XR seccomp policy refuses getsockopt, and SteamVR's IPC client -# calls getsockopt(SO_PEERCRED) inside xrCreateInstance, which crashes the XR -# process (verified on the Frame 2026-09-26). Allow only that option. -IFS= read -r -d '' PEERCRED_PATCH <<'P' || true -diff --git a/sandbox/policy/linux/bpf_xr_policy_linux.cc b/sandbox/policy/linux/bpf_xr_policy_linux.cc -index 435e13d396..297453f582 100644 ---- a/sandbox/policy/linux/bpf_xr_policy_linux.cc -+++ b/sandbox/policy/linux/bpf_xr_policy_linux.cc -@@ -11,6 +11,7 @@ - #include "sandbox/linux/system_headers/linux_syscalls.h" - #include "sandbox/policy/linux/sandbox_linux.h" - -+using sandbox::bpf_dsl::AllOf; - using sandbox::bpf_dsl::Allow; - using sandbox::bpf_dsl::Arg; - using sandbox::bpf_dsl::Error; -@@ -27,8 +28,8 @@ XrProcessPolicy::~XrProcessPolicy() = default; - ResultExpr XrProcessPolicy::EvaluateSyscall(int system_call_number) const { - switch (system_call_number) { - // The runtime reaches its compositor over an AF_UNIX socket and passes fds -- // with SCM_RIGHTS, neither of which the GPU policy allows. get/setsockopt -- // stay disallowed; add a narrow level/optname restriction if ever needed. -+ // with SCM_RIGHTS, neither of which the GPU policy allows. setsockopt -+ // stays disallowed; getsockopt is limited to SO_PEERCRED below. - #if defined(__NR_getpeername) - case __NR_getpeername: - #endif -@@ -49,6 +50,16 @@ ResultExpr XrProcessPolicy::EvaluateSyscall(int system_call_number) const { - case __NR_get_robust_list: - #endif - return Allow(); -+#if defined(__NR_getsockopt) -+ case __NR_getsockopt: { -+ // SteamVR's IPC client checks who is on the other end of its socket -+ // with SO_PEERCRED. Nothing else is readable. -+ const Arg level(1); -+ const Arg optname(2); -+ return If(AllOf(level == SOL_SOCKET, optname == SO_PEERCRED), Allow()) -+ .Else(Error(EPERM)); -+ } -+#endif - #if defined(__NR_kill) - case __NR_kill: { - // SteamVR probes its sibling processes for liveness with kill(pid, 0). -P -if ! printf '%s\n' "$PEERCRED_PATCH" | git apply --reverse --check 2>/dev/null; then - printf '%s\n' "$PEERCRED_PATCH" | git apply - stage "applied SO_PEERCRED patch" -fi -mkdir -p out/XR -cat > out/XR/args.gn <<'A' -target_os = "linux" -target_cpu = "arm64" -is_debug = false -is_official_build = false -is_component_build = false -dcheck_always_on = false -symbol_level = 0 -blink_symbol_level = 0 -v8_symbol_level = 0 -proprietary_codecs = true -ffmpeg_branding = "Chrome" -use_remoteexec = false -use_siso = true -treat_warnings_as_errors = false -A -stage "gn gen" -gn gen out/XR -gn args out/XR --list=enable_openxr --short | tee -a "$W/stage" -stage "build" -( while sleep 600; do guard || { pkill -u "$(id -u)" -f "siso|ninja"; exit 3; }; done ) & -GUARD=$! -trap 'kill $GUARD 2>/dev/null || true' EXIT -autoninja -C out/XR chrome chrome_sandbox chrome_crashpad_handler -stage "package" -cd out/XR -files=(chrome chrome_sandbox chrome_crashpad_handler *.pak *.bin icudtl.dat locales) -# GPU libraries aren't produced by every config; pack the ones that exist. -for f in libEGL.so libGLESv2.so libvk_swiftshader.so libvulkan.so.1 vk_swiftshader_icd.json; do - [ -e "$f" ] && files+=("$f") -done -tar -cJf "$W/chromium-xr-arm64.tar.xz" "${files[@]}" -stage "DONE $(ls -la $W/chromium-xr-arm64.tar.xz)" diff --git a/scripts/chromium-xr.sh b/scripts/chromium-xr.sh deleted file mode 100755 index f1a6be2..0000000 --- a/scripts/chromium-xr.sh +++ /dev/null @@ -1,140 +0,0 @@ -#!/usr/bin/env zsh -# Mac-side: install and launch the WebXR-enabled Chromium build on the Frame. -# -# Flathub Chromium can't enter immersive WebXR on Linux: upstream only wires -# the OpenXR device on Windows (see docs/webxr-chromium.md). This deploys an -# arm64 build with the Linux OpenXR CLs, made on a Linux host by -# scripts/build-chromium-xr.sh, into ~/chromium-xr on the Frame (not a -# Flatpak, so SteamVR's sockets and the XR sandbox work unmodified). -# -# Usage: -# scripts/chromium-xr.sh install [TARBALL] # default: scp from $BUILD_HOST -# scripts/chromium-xr.sh launch [URL] # opens as its own panel in the headset -# scripts/chromium-xr.sh steam # adds "Chromium XR" to the Steam library -# scripts/chromium-xr.sh check # isSessionSupported via DevTools -set -euo pipefail - -FRAME_ALIAS=${FRAME_ALIAS:-frame} -BUILD_HOST=${BUILD_HOST:-} -BUILD_TARBALL=${BUILD_TARBALL:-chromium-xr/chromium-xr-arm64.tar.xz} -DEVTOOLS_PORT=${DEVTOOLS_PORT:-9223} -STEAM_NAME=${STEAM_NAME:-Chromium XR} -here=${0:A:h} -wrapper='~/Applications/ChromiumXR/launch.sh' - -# frame/chromium-xr/launch.sh holds Chrome's flags; both launch paths run it. -push_wrapper() { - # Write then rename, so a dropped connection can't leave a torn script. - ssh "$FRAME_ALIAS" 'mkdir -p ~/Applications/ChromiumXR && cd ~/Applications/ChromiumXR && cat > launch.sh.new && chmod +x launch.sh.new && mv launch.sh.new launch.sh' \ - < "$here/../frame/chromium-xr/launch.sh" -} - -case "${1:-}" in - install) - tarball=${2:-} - if [[ -z "$tarball" ]]; then - [[ -n "$BUILD_HOST" ]] || { print -u2 "Pass a tarball, or set BUILD_HOST to the build machine"; exit 2; } - tmp=$(mktemp -d) - trap 'rm -rf "$tmp"' EXIT - tarball=$tmp/chromium-xr-arm64.tar.xz - scp -q "$BUILD_HOST:$BUILD_TARBALL" "$tarball" - fi - ssh "$FRAME_ALIAS" 'rm -rf ~/chromium-xr.new && mkdir -p ~/chromium-xr.new' - ssh "$FRAME_ALIAS" 'tar -xJf - -C ~/chromium-xr.new' < "$tarball" - # Check the new build runs before replacing the old one. - ssh "$FRAME_ALIAS" '~/chromium-xr.new/chrome --version && rm -rf ~/chromium-xr && mv ~/chromium-xr.new ~/chromium-xr' - ;; - launch) - # Its own VR panel on gamescope's X display, so the Plasma desktop doesn't - # need to be open. DevTools is only on for this path (for `check`). - push_wrapper - exec "$here/panel-on-frame.sh" --name chromium-xr -- "$wrapper" \ - --remote-debugging-port="$DEVTOOLS_PORT" \ - "${2:-https://immersive-web.github.io/webxr-samples/}" - ;; - steam) - # A non-Steam shortcut, added through the Steam client's DevTools port - # without restarting Steam (see docs/apks.md). Launching it from the - # library gives Chromium its own panel like any game. Safe to rerun: it - # refreshes the wrapper and only adds the shortcut if it's missing. - ssh "$FRAME_ALIAS" 'test -x ~/chromium-xr/chrome' || - { print -u2 "No build in ~/chromium-xr on the Frame: run 'chromium-xr.sh install' first"; exit 1; } - push_wrapper - # The app id is kept next to the wrapper, so renaming the shortcut in the - # library doesn't make a rerun add a second one. - shortcuts=$here/../frame/android/steam_shortcuts.py - home=$(ssh "$FRAME_ALIAS" 'printf %s "$HOME"') - saved=$(ssh "$FRAME_ALIAS" 'cat ~/Applications/ChromiumXR/shortcut-appid 2>/dev/null || true') - existing=$(ssh "$FRAME_ALIAS" python3 - list < "$shortcuts" | - python3 -c 'import json,sys -apps = json.load(sys.stdin) -ids = [a["appid"] for a in apps if str(a["appid"]) == sys.argv[2]] or [a["appid"] for a in apps if a["name"] == sys.argv[1]] -print(ids[0] if ids else "")' "$STEAM_NAME" "$saved") - if [[ -n "$existing" ]]; then - print -r -- "The shortcut is already in the Steam library (app id $existing)" - else - icon='' - for dir in /var/lib/flatpak '~/.local/share/flatpak'; do - candidate=$dir/exports/share/icons/hicolor/256x256/apps/org.chromium.Chromium.png - if ssh "$FRAME_ALIAS" "test -f $candidate"; then icon=${candidate/#\~/$home}; break; fi - done - existing=$(ssh "$FRAME_ALIAS" python3 - add ${(q)STEAM_NAME} ${(q)home}/Applications/ChromiumXR/launch.sh ${(q)home} ${(q)icon} < "$shortcuts") - [[ "$existing" == <-> ]] || { print -u2 -r -- "Steam didn't return a shortcut app id: $existing"; exit 1; } - print -r -- "Added $STEAM_NAME to the Steam library (shortcut app id $existing)" - fi - ssh "$FRAME_ALIAS" "printf '%s\n' $existing > ~/Applications/ChromiumXR/shortcut-appid" - ;; - check) - # DevTools listens on the Frame's loopback only; evaluate there. - ssh "$FRAME_ALIAS" python3 - "$DEVTOOLS_PORT" <<'EOF' -import json, sys, urllib.request, base64, os, socket, struct -port = int(sys.argv[1]) -tabs = json.load(urllib.request.urlopen(f"http://127.0.0.1:{port}/json", timeout=10)) -page = next((t for t in tabs if t["type"] == "page"), None) -if page is None: - sys.exit("no open page: run 'chromium-xr.sh launch' first") -path = page["webSocketDebuggerUrl"].split(f":{port}", 1)[1] -s = socket.create_connection(("127.0.0.1", port), timeout=30) -key = base64.b64encode(os.urandom(16)).decode() -s.sendall(f"GET {path} HTTP/1.1\r\nHost: 127.0.0.1\r\nUpgrade: websocket\r\n" - f"Connection: Upgrade\r\nSec-WebSocket-Key: {key}\r\n" - "Sec-WebSocket-Version: 13\r\n\r\n".encode()) -s.recv(4096) -msg = json.dumps({"id": 1, "method": "Runtime.evaluate", "params": { - "expression": "navigator.xr ? navigator.xr.isSessionSupported('immersive-vr') : 'no navigator.xr'", - "awaitPromise": True}}).encode() -mask = os.urandom(4) -hdr = bytes([0x81]) + (bytes([0x80 | len(msg)]) if len(msg) < 126 - else bytes([0x80 | 126]) + struct.pack(">H", len(msg))) -s.sendall(hdr + mask + bytes(b ^ mask[i % 4] for i, b in enumerate(msg))) -buf = b"" -reply = None -while reply is None: - chunk = s.recv(65536) - if not chunk: - sys.exit("DevTools closed the connection") - buf += chunk - # Consume every complete frame already buffered before reading again. - while len(buf) >= 2: - n = buf[1] & 0x7F - off = 2 - if n == 126: - if len(buf) < 4: - break - n, off = struct.unpack(">H", buf[2:4])[0], 4 - elif n == 127: - if len(buf) < 10: - break - n, off = struct.unpack(">Q", buf[2:10])[0], 10 - if len(buf) < off + n: - break - frame, buf = buf[off:off + n], buf[off + n:] - msg = json.loads(frame) - if msg.get("id") == 1: - reply = msg - break -print("immersive-vr supported:", reply["result"]["result"].get("value")) -EOF - ;; - *) sed -n '2,14p' "$0"; exit 2 ;; -esac diff --git a/scripts/install-apps.sh b/scripts/install-apps.sh index 0a7afec..70fbd79 100755 --- a/scripts/install-apps.sh +++ b/scripts/install-apps.sh @@ -59,9 +59,13 @@ colordepth=32 quality=9 viewonly=0 showcursor=1 +scale=1 +viewmode=1 +window_maximize=1 EOF echo \"wrote \$d/mac-screen-sharing.remmina\" " print "On the Mac: System Settings > General > Sharing > Screen Sharing (i) >" print " enable 'VNC viewers may control screen with password' and set one." + print "Remmina may ask for your Mac account name + login password instead (Apple auth)." fi diff --git a/scripts/mac-cursor-ring.lua b/scripts/mac-cursor-ring.lua new file mode 100644 index 0000000..edcfe20 --- /dev/null +++ b/scripts/mac-cursor-ring.lua @@ -0,0 +1,40 @@ +-- Hammerspoon: draw a ring around the Mac pointer so it shows in the VNC +-- mirror on the Frame. macOS Screen Sharing leaves the pointer out of the +-- framebuffer; a real on-screen window is captured like anything else. +-- +-- Install: brew install --cask hammerspoon, then in ~/.hammerspoon/init.lua: +-- dofile("/path/to/frame-control/scripts/mac-cursor-ring.lua") +-- Toggle: ctrl+alt+cmd+M. Polls the pointer position, so no Accessibility +-- permission is needed. + +local SIZE, WIDTH = 34, 3 +local COLOR = { red = 1, green = 0.2, blue = 0.2, alpha = 0.9 } + +local ring = hs.canvas.new({ x = 0, y = 0, w = SIZE, h = SIZE }) +ring:appendElements({ + type = "circle", action = "stroke", + strokeColor = COLOR, strokeWidth = WIDTH, + radius = (SIZE - WIDTH) / 2, +}) +ring:level(hs.canvas.windowLevels.cursor) +ring:behavior({ "canJoinAllSpaces", "stationary", "ignoresCycle" }) + +local last = {} +local function follow() + local p = hs.mouse.absolutePosition() + if p.x ~= last.x or p.y ~= last.y then + ring:topLeft({ x = p.x - SIZE / 2, y = p.y - SIZE / 2 }) + last = p + end +end + +frameCursorRing = { canvas = ring, timer = hs.timer.new(1 / 60, follow) } + +local function show() follow(); ring:show(); frameCursorRing.timer:start() end +local function hide() frameCursorRing.timer:stop(); ring:hide() end + +hs.hotkey.bind({ "ctrl", "alt", "cmd" }, "M", function() + if ring:isShowing() then hide() else show() end +end) + +show() diff --git a/site/.gitignore b/site/.gitignore new file mode 100644 index 0000000..a933f10 --- /dev/null +++ b/site/.gitignore @@ -0,0 +1,3 @@ +node_modules/ +.wrangler/ +.dev.vars diff --git a/site/README.md b/site/README.md new file mode 100644 index 0000000..1180f4e --- /dev/null +++ b/site/README.md @@ -0,0 +1,35 @@ +# Website + +The Frame Control website, , on Cloudflare Pages. + +- `public/`: static pages. `/` is the landing page, `/feedback/` the feedback form, `/privacy/` the privacy note. +- `functions/api/feedback.js`: `POST /api/feedback`, which turns the form into a GitHub issue labelled `feedback`. +- `lib/feedback.js`: validation and issue formatting, tested by `test/feedback.test.mjs`. +- `public/js/site.js`: settings, including the Ko-fi page name for the donate buttons. + +## Feedback → GitHub issues + +The function needs a `GITHUB_TOKEN` secret: a fine-grained token with **Issues: read and write** on +`saphid/frame-control` only. Issues are opened as the token's owner, so they pass the contributor gate +(`.github/workflows/issue-gate.yml`) and stay open. Without the token the form answers 503 and offers a +prefilled GitHub issue instead. + +```sh +cd site +npx wrangler pages secret put GITHUB_TOKEN --project-name frame-control +``` + +Spam protection: a hidden honeypot field, a 3-second minimum fill time, 5 submissions per hour per IP +(a salted hash, kept in the `FEEDBACK_RL` KV namespace for about an hour), and 100 a day in total. +User text has `@mentions` and `#123` references broken so nobody gets pinged. + +## Run and deploy + +```sh +cd site +node --test test/*.test.mjs +npx wrangler pages dev --port 8788 # local; put GITHUB_TOKEN/GITHUB_REPO in .dev.vars to test issues +npx wrangler pages deploy --branch main # production +``` + +Point `GITHUB_REPO` in `.dev.vars` at a scratch repo when testing locally so test issues don't land on the real tracker. diff --git a/site/functions/api/feedback.js b/site/functions/api/feedback.js new file mode 100644 index 0000000..67a29f7 --- /dev/null +++ b/site/functions/api/feedback.js @@ -0,0 +1,86 @@ +// POST /api/feedback: turns the website's feedback form into a GitHub issue. +// +// Environment (Cloudflare Pages → Settings → Variables and Secrets): +// GITHUB_TOKEN secret. Fine-grained token with Issues: read and write on GITHUB_REPO only. +// GITHUB_REPO owner/name, e.g. saphid/frame-control (wrangler.toml sets it). +// FEEDBACK_RL KV namespace binding for rate limits (optional; without it there is no limit). + +import { buildIssue, hashIp, validate } from "../../lib/feedback.js"; + +const PER_IP_PER_HOUR = 5; +const TOTAL_PER_DAY = 100; + +const json = (status, data) => + new Response(JSON.stringify(data), { + status, + headers: { "content-type": "application/json; charset=utf-8", "cache-control": "no-store" }, + }); + +async function overLimit(kv, key, limit, ttl) { + const count = Number(await kv.get(key)) || 0; + if (count >= limit) return true; + await kv.put(key, String(count + 1), { expirationTtl: ttl }); + return false; +} + +export async function onRequestPost({ request, env }) { + if (!env.GITHUB_TOKEN || !env.GITHUB_REPO) { + return json(503, { error: "Feedback isn't connected to GitHub yet. Use the GitHub link instead." }); + } + + const origin = request.headers.get("origin"); + if (origin && new URL(origin).host !== new URL(request.url).host) { + return json(403, { error: "Send feedback from the website's form." }); + } + + let input; + try { + input = await request.json(); + } catch { + return json(400, { error: "Send the form as JSON." }); + } + + const checked = validate(input); + // Bots get a success-shaped answer so they don't learn what tripped them. + if (checked.spam) return json(200, { ok: true }); + if (checked.error) return json(400, { error: checked.error }); + + // Best effort: KV is eventually consistent, so bursts can slip past, and a + // storage error lets the feedback through rather than losing it. + if (env.FEEDBACK_RL) try { + const ip = request.headers.get("cf-connecting-ip") || "unknown"; + const hour = Math.floor(Date.now() / 3600e3); + const day = Math.floor(Date.now() / 86400e3); + // Salted with the secret token, so the stored hashes can't be reversed by trying every IP. + const who = await hashIp(ip, env.GITHUB_TOKEN); + if (await overLimit(env.FEEDBACK_RL, `ip:${who}:${hour}`, PER_IP_PER_HOUR, 3900)) { + return json(429, { error: "That's a lot of feedback in one hour. Try again later, or use GitHub." }); + } + if (await overLimit(env.FEEDBACK_RL, `day:${day}`, TOTAL_PER_DAY, 90000)) { + return json(429, { error: "The form has had a busy day. Try again tomorrow, or use GitHub." }); + } + } catch (err) { + console.log(`Rate limit check failed: ${err}`); + } + + const res = await fetch(`https://api.github.com/repos/${env.GITHUB_REPO}/issues`, { + method: "POST", + headers: { + authorization: `Bearer ${env.GITHUB_TOKEN}`, + accept: "application/vnd.github+json", + "x-github-api-version": "2022-11-28", + "user-agent": "frame-control-website", + "content-type": "application/json", + }, + body: JSON.stringify(buildIssue(checked.value)), + }); + + if (!res.ok) { + console.log(`GitHub answered ${res.status}: ${(await res.text()).slice(0, 500)}`); + return json(502, { error: "GitHub didn't accept it just now. Try again, or use the GitHub link." }); + } + const issue = await res.json(); + return json(201, { ok: true, number: issue.number, url: issue.html_url }); +} + +export const onRequest = () => json(405, { error: "POST only." }); diff --git a/site/lib/feedback.js b/site/lib/feedback.js new file mode 100644 index 0000000..698575d --- /dev/null +++ b/site/lib/feedback.js @@ -0,0 +1,102 @@ +// Feedback form → GitHub issue. Pure functions, so tests can run them without +// Cloudflare or GitHub (site/test/feedback.test.mjs). + +export const KINDS = { + bug: { label: "bug", title: "Bug report" }, + idea: { label: "enhancement", title: "Idea" }, + question: { label: "question", title: "Question" }, + other: { label: null, title: "Other feedback" }, +}; + +export const LIMITS = { title: [5, 120], message: [10, 5000], field: 120 }; + +// Anyone who fills the form in under this many milliseconds is a script. +export const MIN_FILL_MS = 3000; + +const GITHUB_LOGIN = /^[A-Za-z0-9](?:[A-Za-z0-9-]{0,37}[A-Za-z0-9])?$/; + +const oneLine = (value, max) => String(value ?? "").replace(/\s+/g, " ").trim().slice(0, max); + +// Mentions in someone else's text would ping strangers, and issue references +// (#1, owner/repo#1, GH-1, github.com links) would add backlinks to other +// people's issues, so break them all with a zero-width space. Escaping & first +// stops @ and # from turning back into @ and # when GitHub renders, +// escaping < keeps out raw HTML such as an unclosed