README gains "The team" -- the published VWE BattleTech credits roster (scan supplied July 2026) cross-referenced against the 1994-96 source in this tree; HISTORY.md links the podbay developer-script names to the credited team members. context/ adds the archive index README and its generator script. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
11 KiB
11 KiB
Context index — all project documentation
A single map of every hand-written .md in this repo, grouped by area with a
one-line description and a link. Use it to find the right note without grepping.
Scope: project-authored docs only. ~70 vendored/third-party READMEs (the DOSBox-X fork under
emulator/src/, SDL2, libpng, libpdcurses, freetype) are intentionally omitted — they document upstream libraries, not this project.
Keeping this current: the linked list below is generated. Run
context/gen-index.shto check for drift (new/removed docs) andcontext/gen-index.sh --writeto regenerate it. Hand-written descriptions are preserved across regenerations; only the block between the AUTOGEN markers is touched, so edit descriptions freely — just keep them inside that block.
Orientation
- HISTORY.md — provenance of the recovered developer drive ("Glaze"/
sda4) that sits alongside the release tree. - README.md — repo overview: source + content for Tesla:BattleTech and Tesla:Red Planet (Release 4.10).
Emulator — plan, phases & operations
- emulator/ENV-VARS.md — environment variables for both the pod (game) and host (emulator).
- emulator/LAUNCH.md — pod launch cheat-sheet (all commands, non-elevated PowerShell).
- emulator/PHASE0-RESULTS.md — Phase 0: baseline DOS boot test (complete).
- emulator/PHASE1-RESULTS.md — Phase 1: interface discovery via a VPX link-adapter logging build (complete).
- emulator/PHASE2-PROGRESS.md — Phase 2: boot-protocol emulation — handshake, i860 download, FIFO transport.
- emulator/PHASE3-PROGRESS.md — Phase 3: render backend (3a/3b/3c command decode + bridge).
- emulator/PLAN.md — master implementation plan for running unported DOS BattleTech/Red Planet under VPX emulation.
Emulator — subsystems
- emulator/CAMERA-REVIEW-NOTES.md — how the games did Live Cam & Mission Review (spool replay, host roles).
- emulator/GAUGE-NOTES.md — the cockpit gauge / secondary-display path (5 mono MFDs + color radar).
- emulator/NET-NOTES.md — networking subsystem recon & bring-up plan for pod boot/mesh.
- emulator/RENDER-HARNESS.md — FLYK + the VWETEST diagnostic suite as a render harness.
- emulator/RENDERER-COLLAB.md — shared working log for the two renderer efforts (VPX/Division backend).
- emulator/RIO-NOTES.md — RIO cockpit-controls passthrough tuning (COM1 input board).
- emulator/SOUND-NOTES.md — audio subsystem recon & plan (AWE32/SOS clock, faithful bring-up).
- emulator/VDB-NOTES.md — the VWE Video Distribution Board: one framebuffer → six cockpit displays.
Emulator — deployment & ports
- emulator/DEPLOYMENT-PLAN.md — network-agnostic pod-bay deployment (pcap bridge, two-IP design, mesh).
- emulator/EGRESS-HOLD-FIX-PLAN.md — egress-hold / floor-lighting investigation (CLOSED, won't-fix; findings kept).
- emulator/XP-PORT-PLAN.md — one archive from Windows XP → Windows 11 (back-burnered fleet plan).
Emulator — devices & support files
- emulator/deploy/README.md — install-side artifacts for the self-contained, air-gapped pod install.
- emulator/net-boot/README.md — files the pod mounts as
D:when booting the networked path. - emulator/pod-launch/README.md — the supervising launch entry-point for both DOSBox titles.
- emulator/rio-firmware/README.md — RIO cockpit I/O board firmware dump (v4.2).
- emulator/rio-firmware/RIOv4_2-ANALYSIS.md — RIO v4.2 firmware RE: the protocol-wedge analysis.
- emulator/roms/README.md — card ROM dumps (AWE32 1MGM sample ROM, etc.).
- emulator/vpx-device/README.md — VPX + AWE32 emulated-hardware sources for the DOSBox-X integration.
- emulator/vpx-device/serialport/README.md — modified DOSBox-X serial passthrough (RIO latency options).
Emulator — VelociRender firmware decompilation
- emulator/firmware-decomp/FPGA-RECONSTRUCTION.md — reconstructing the VelociRender in hardware (FPGA design note).
- emulator/firmware-decomp/GPU-RETARGET.md — GPU-compute retarget: the DOSBox-renderer shipping path.
- emulator/firmware-decomp/HARDWARE-ARCHITECTURE.md — the card's hardware architecture, reconstructed for emulation (+ photo inventory).
- emulator/firmware-decomp/IG-SHADING-MODEL.md — the IG-board shading model, ground truth distilled from shipped libDPL.
- emulator/firmware-decomp/IGC-ENCODING-DERIVATION.md — IGC instruction-word encoding derived from EOF.C ↔ EOF.S (Tier-1 decoder).
- emulator/firmware-decomp/M4-LIVE-SEAM.md — M4: the live DOSBox seam design note.
- emulator/firmware-decomp/M4B-RESULTS.md — M4b: offline end-to-end renderer-chain results.
- emulator/firmware-decomp/M5-TEXTURING.md — M5: faithful texturing, the last mile to recognizable frames.
- emulator/firmware-decomp/MICROCODE-DECODE-NOTES.md — PXPL5 IGC micro-code decode working notes (ground/sky path).
- emulator/firmware-decomp/PVISION-IMPLEMENTATION-GUIDE.md — implementing IR / "Predator" vision in a VelociRender renderer.
- emulator/firmware-decomp/README.md — decompilation reference hub (make this the authoritative VelociRender answer).
- emulator/firmware-decomp/i860-encoding.md — i860 instruction encoding, validated against our own object files.
Emulator — render bridge
- emulator/render-bridge/COCKPIT-CAGE-NOTES.md — cockpit cage, glances, and the "black rear view" (canopy/twist forensics).
- emulator/render-bridge/DEATH-SEQUENCE-NOTES.md — death-sequence camera findings.
dpl3-revive — DPL3 renderer port & format specs
- dpl3-revive/README.md — porting the VWE DPL3 renderer (BattleTech / Red Planet).
- dpl3-revive/patha/CAPTURE.md — capturing real FLYK.EXE link traffic (Path A validation).
- dpl3-revive/spec/B2Z_FORMAT.md — the DIV-BIZ2 (
.B2Z/.V2Z) binary geometry format. - dpl3-revive/spec/MAP_FORMAT.md —
.MAPgame maps and.MODgame objects (playable worlds). - dpl3-revive/spec/SCN_FORMAT.md —
.SCNscene format (from FLYK.C). - dpl3-revive/spec/SPL_FORMAT.md —
.SPLcamera-path spline format (from SPLINE.C). - dpl3-revive/spec/SVT_FORMAT.md —
.SVTtexture format (from DPL_LOAD.Cload_svt()). - dpl3-revive/spec/VELOCIRENDER_PROTOCOL.md — the VelociRender wire protocol (run the original binary unmodified).
restoration — scene re-renders
- restoration/README.md — modern re-renderings of the Division dVS scenes recovered from the Glaze drive.
restoration — RIO firmware & hardware
- restoration/rio-firmware/README.md — RIO board firmware (owner-facing entry point).
- restoration/rio-firmware/RIOv4_2-ANALYSIS.md — RIO v4.2 firmware RE: protocol-wedge analysis.
- restoration/rio-firmware/wedge-explained.md — plain-language "why the stick died mid-battle" for pod owners.
- restoration/rio-hardware/README.md — RIO cockpit hardware: boards, schematics, GAL dump.
- restoration/rio-hardware/display-board-1408.md — Display Board 1408 outputs and what the RIO shows on it.
- restoration/rio-hardware/gal/README.md — U7 GAL20V8A decode: the recovered RIO memory map.
restoration — source410 reconstruction
- restoration/source410/BT/BTCNSL.NOTES.md — BTCNSL reconstruction notes.
- restoration/source410/BT/BTPLAYER.NOTES.md — BTPLAYER reconstruction notes (ctor/Make/experience level).
- restoration/source410/BT/BTSCNRL.NOTES.md — BTSCNRL reconstruction notes.
- restoration/source410/BT/MECH-LAYOUT.md — MECH.HPP staging worksheet (the mech-family working ledger).
- restoration/source410/BT/MECH.NOTES.md — MECH.CPP/.HPP reconstruction notes.
- restoration/source410/BT/MECHSUB.NOTES.md — MECHSUB reconstruction notes.
- restoration/source410/BT/NAMEFILT.NOTES.md — NAMEFILT reconstruction notes.
- restoration/source410/BT/SENSOR.NOTES.md — SENSOR reconstruction notes.
- restoration/source410/BT/SEQCTL.NOTES.md — SEQCTL reconstruction notes.
- restoration/source410/BT/STAGED-HEADERS.NOTES.md — the 13 headers that closed the tree's compile (shared notes).
- restoration/source410/BT_L4/BTL4.NOTES.md — BTL4.CPP reconstruction notes (launch path).
- restoration/source410/BT_L4/BTL4APP.NOTES.md — BTL4APP.CPP reconstruction notes (12/12 functions).
- restoration/source410/MUNGA/ALARM.NOTES.md — ALARM.HPP reconstruction notes.
- restoration/source410/MUNGA/BACKFILLS.NOTES.md — engine header backfills, shared per-file evidence.
- restoration/source410/MUNGA/VDATA.NOTES.md — VDATA.HPP: the first engine-side header backfill.
- restoration/source410/README.md — overview of the missing-source reconstruction effort.