Skip to content

Docs up to date for v0.3.0, and setup.sh --ios honors P2_DEVICE - #23

Merged
kanapitsas merged 4 commits into
mainfrom
fix/docs-v030
Nov 8, 2026
Merged

kanapitsas merged 4 commits into
mainfrom
fix/docs-v030

Conversation

@kanapitsas

Copy link
Copy Markdown
Owner

A pass over the whole documentation after the Half-Life 2 merge: every claim checked against the code, then outdated, missing and superfluous parts fixed.

Bug fix

  • setup.sh --ios ignored P2_DEVICE (documented to pick the iPhone when several are connected) and always took the first one. New test SetupDeviceTests (fails on the old code).
  • Installer: the final message uses the plural when both games were built.

Wrong or outdated

  • README: the installer is signed, not notarized (Open Anyway); Metal described as the default first; both games' depots; HL2 episodes marked in progress; HL2 iPhone at 60 fps.
  • ~ inside quotes did not expand in two launcher commands.
  • ios.md: HL2 now tested on a phone; Metal fps cap; "Journal" setting is "Log".
  • hl2.md: build_ios.py command missing --release --deps; run_game.py renderer sentence.
  • d3d9-bridge.md: NVIDIA vendor id, 20 interfaces / 226 methods, no-Rust path, HL2 roots file.
  • steam.md: HL2's SDK 1.60 start-up, current counts, iPhone stub.
  • CLAUDE.md: handle range is 0xe8000000; make clean deletes all of build/.

Missing

  • Play, logs and dark interiors for HL2; per-game Settings page; Portal 2 touch controls table; free-account app slots; P2_TEAM_ID with several accounts; save sync and co-op marked Portal 2 only; OpenGL-only diagnostics flagged; gamma ramp in the bridge doc.

Moved, not deleted

  • Back-tap detector internals → docs/backtap.md.
  • HL2 and iPhone performance history → STATUS.md.
  • Steam investigation of 25 Oct. → docs/steam-investigation-2026-10-25.md.

Tested: make check (167 Python tests, 241 C checks), internal links and anchors checked by script, swiftc -parse on the installer. Reviewed by Codex. Not tested: the installer rebuilt with the new string.

🤖 Generated with Claude Code

kanapitsas and others added 4 commits November 8, 2026 11:11
The README documents P2_DEVICE to pick the iPhone when several are
connected, but setup.sh always took the first one listed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- README: simpler intro, installer is signed (not notarized), Metal described
  first, HL2 in Play/Logs/roadmap, iPhone data sizes, HL2 at 60 fps on iPhone,
  dark interiors, both games' depots.
- ios.md: HL2 tested on a phone, OpenGL section after Metal, Portal 2 touch
  table, per-game Settings page, P2_TEAM_ID/P2_BUNDLE_ID caveats; back-tap
  internals moved to docs/backtap.md, OpenGL perf history to STATUS.md.
- hl2.md: correct build_ios.py command, run_game.py renderer, perf history
  moved to STATUS.md.
- d3d9-bridge.md: vendor id, gamma ramp, interface count, no-Rust path, HL2.
- CLAUDE.md: handle range 0xe8000000, what make clean deletes, more targets.
- Installer: plural when both games were built.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- steam.md is now the bridge reference (Portal 2, Half-Life 2's SDK 1.60
  start-up, the iPhone stub, current counts); the 25 Oct. investigation moves
  to docs/steam-investigation-2026-10-25.md.
- usage.md: HL2 language/log/app, co-op and save sync marked Portal 2 only,
  OpenGL-only diagnostics flagged, missing variables, run_game.py behaviour,
  duplicate build commands merged, ~ path fixed, unnotarized installer.
- Links to the renamed sections updated.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@kanapitsas
kanapitsas merged commit 75d6eb0 into main Nov 8, 2026
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant