Skip to content

Latest commit

 

History

History
30 lines (25 loc) · 3.06 KB

File metadata and controls

30 lines (25 loc) · 3.06 KB

RingOut engineering documents

This directory contains source-led audits, implementation research, release handoffs, and technical roadmaps. The repository-root README.md remains the user-facing project overview; documents here preserve deeper evidence and claim boundaries for maintainers.

Current documents

Document Purpose
Netplay audit Executive verdict, scorecard, evidence summary, priority order, and index for all netplay research
Netplay lobby Entry points, restart lifecycle, LAN discovery, connection topology, roster, mapping, start synchronization, and lobby UX
Netplay connectivity Current direct-IP behavior, Dolphin/Slippi traversal research, proposed room codes, ICE/STUN/TURN relay architecture, privacy UX, and NAT-matrix tests
Netplay protocol and security Input transport, trust boundaries, parser/save-transfer risks, desync and compatibility protection, and hardening plan
Netplay rollback roadmap Fixed-delay behavior, historical rollback measurements, test coverage, performance constraints, and staged rollback design
Rollback implementation handoff Branch-local live rollback architecture, safety policy, final Linux/source evidence, and remaining platform/connectivity gaps
Live rollback test harness Production, correction, horizon, confirmed-state mismatch, and fixed-delay commands; retained evidence and claim boundaries
Build and release pipeline Windows cross-compilation, build parallelism, caching, ZIP publication, draft releases, and Linux AppImage packaging
Windows runtime and controls Package contents, first-run module compilation, media/runtime dependencies, controls, netplay startup, and troubleshooting
Release history and testing ell tag lineage, change provenance, validation evidence, artifact status, and unproven platform cases
Launcher UI research Existing launcher capabilities, release setup gap, recommended cross-platform architecture, UX, and delivery stages
Launcher experience prototype Implemented source-tree launcher, integrated setup flow, UI decisions, end-to-end RVZ evidence, and release boundary

Maintenance rules

  • Pin audits and measurements to a commit and date.
  • Cite exact source paths and line numbers where practical.
  • Include reproduction commands and prerequisites.
  • Distinguish current shipped behavior from historical evidence, proposed work, and unverified assumptions.
  • Update conclusions when later code or measurements invalidate them; do not silently leave contradictory claims.
  • Keep new research Markdown in this directory rather than at the repository root.
  • Leave user-facing and subsystem-owned README.md, CONTRIBUTING.md, and provenance files beside the code they govern.