Skip to main content

Playroll Documentation

Playroll Docs is the long-lived source of truth for how the product records gameplay, validates sessions, uploads artifacts, exposes monitoring data, and helps testers troubleshoot player reports.

This site should grow with the codebase. The goal is not to mirror every source file. The goal is to document the contracts and operational behavior that people rely on.

Current focus​

  • Recording session lifecycle across core, UI, local SQLite, Supabase, and upload infrastructure.
  • Pure-v2 capture pipeline behavior and FPS quality monitoring.
  • Pre-upload validation rules for MP4, CSV, and JSON metadata.
  • Contributor portal onboarding, payout readiness, and the Playroll app identity link.
  • Tester troubleshooting workflows for player sessions and uploaded files.
  • Telemetry events used to debug recording failures and performance regressions.

Repositories​

  • playroll-cpp: core recorder, pure-v2 capture, validation, local metadata, upload behavior.
  • playroll-ui: desktop UI, session history, update flow, user-facing status.
  • playroll-contributor-portal: contributor onboarding, document acceptance, payout receiving method, app identity bridge.
  • playroll-infra: infrastructure ownership target for Terraform and cloud resources.
  • playroll-docs: this documentation site.

What belongs here​

Use this docs site for stable or semi-stable knowledge:

  • Architecture and lifecycle diagrams.
  • Runbooks for testers and operators.
  • Database view contracts.
  • Telemetry event catalog.
  • Release process and rollout notes.
  • Architecture Decision Records.

Avoid using this site as a scratchpad. Drafts can live in tickets or PRs; once a decision becomes operationally relevant, move the final version here.