Problem
The README is a one-paragraph intro with no inventory of the tweaks, hacks, and overrides the mod applies to Just Cause 3's engine to make it playable in VR. A new contributor (or future maintainer) has no single place to see what the mod actually does to the game. The CONTRIBUTING guide likewise has no reminder to keep that list current when a tweak is added or removed.
Notes
The docs/mod/ directory documents the individual subsystems in depth, but there's no consolidated, scannable summary. Based on a survey of the codebase, the list spans at least:
- Camera & head tracking: per-eye off-axis projection, HMD-driven camera placement, head-bone override, tick-spaced pose interpolation, loading-screen camera handling, aim-direction override (
GetCameraMatrix)
- Head hiding: per-bone palette collapse to hide the player's head mesh from colour passes while keeping its shadow
- Body IK: HumanIK head/spine effector, body-follows-head yaw scheme, neck twist, posture swing
- Grapple comfort: body-frame hold filter, yaw handoff at landings, landing-snap anchor absorber
- HUD: floating-panel redirect, lazy-follow damping, per-eye stereo depth, world-marker reprojection, overlay suppression, egui debug panel
- Stereo double-draw: frame-counter restore, shared pre-passes, SSAO/GI/EffectInfo/add-buffer save-restore, post-block dedupe, eye-1 dt gating, exposure gating, force SMAA 1x
- Shadow & lighting fixes: shadow cascade anchor fix, shadow fit widening/stabilization, shadow PCF hash patch, terrain CB invalidation
- Culling: frustum/terrain/model cull widening, BFBC occlusion disable
- FSR: FSR 2.2.1 AA replacement, motion-vector decode, stereo MV correction, jitter cancellation
- Foveated rendering: radial stencil masking (on by default)
- Far field: monoscopic far-field sharing
- Input: look-effector tapping/consumption, FPS-movement flag forcing, mouse/UI pipeline remapping
- VR runtime: OpenXR session, per-eye resolution, desktop mirror, present suppression
The CONTRIBUTING guide should add a note (likely under the existing "Documentation" bullet in the Development workflow section) that the README tweak list must be updated whenever a tweak or hack is added, removed, or materially changed.
Problem
The README is a one-paragraph intro with no inventory of the tweaks, hacks, and overrides the mod applies to Just Cause 3's engine to make it playable in VR. A new contributor (or future maintainer) has no single place to see what the mod actually does to the game. The CONTRIBUTING guide likewise has no reminder to keep that list current when a tweak is added or removed.
Notes
The
docs/mod/directory documents the individual subsystems in depth, but there's no consolidated, scannable summary. Based on a survey of the codebase, the list spans at least:GetCameraMatrix)The CONTRIBUTING guide should add a note (likely under the existing "Documentation" bullet in the Development workflow section) that the README tweak list must be updated whenever a tweak or hack is added, removed, or materially changed.