Docs & rules

long2know/nflblitzGitHub

This is a public, read-only report. Striff reads this repository's docs, turns each sentence that makes a claim about the code into a rule, and checks the rule against the code on the default branch. How this works

main5cee009Last read Nov 19

Is this yours? Install to manage it

Once installed, Striff checks every pull request.

Rules summary
Documents
Rules
45
28
28
17
2
2
6
3
3
8
8
1
1
121 docs
long2know/nflblitzOpen repository

long2know/nflblitz — documented rules

45 of 45 rules, printed November 22, 2026.

The sentence in your docs
The M1 successor keeps the same 281 animation bytes and uses fourteen bindings/482 impact sites, strict new callback/ services identities and actual SourceC2Composition.CreateM1Simulation.
SourceC2Composition has CreateM1Simulation
Holds
GameSimulation(ISourceAnimationLibrary animations, int seed = 1) selects OriginalRelease57Hz.
GameSimulation depends on ISourceAnimationLibrary
HoldsGameplay Contracts
BlitzRuntime injects the same immutable library into simulation and presentation.
BlitzRuntime depends on ISourceAnimationLibrary
HoldsRuntime Contracts
FieldVector.X runs lengthwise in yards, Home goal line 0, Away goal line 100; end zones extend to -10 and 110. Z is lateral, centered at zero. Use SliceRules.FieldHalfWidthYards, the normalized archive geometry ratio, not an assumed regulation-NFL width. Actors and ball positions are centers.
3 rules from this sentence
FieldVector has X
checks “FieldVector.X”
Holds
FieldVector has Z
checks “FieldVector.X runs lengthwise in yards, Home goal line 0, Away goal line 100; end zones extend to -10 and 110. Z is lateral, centered at zero.”
Holds
SliceRules has FieldHalfWidthYards
checks “Use SliceRules.FieldHalfWidthYards”
Holds
Rendering maps (X, Height, Z) to Unity (X - 50, Height, Z), with one Unity unit per yard; player ground height is zero. Velocity is yards/second. BallView.Height is yards above ground. No Unity Physics result changes rules.
BallView has Height
Holds
Team is the affected/ scoring/new-possessing team, PlayerId the affected carrier/receiver or -1.
2 rules from this sentence
GameEvent has Team
checks “Team is the affected/ scoring/new-possessing team”
Holds
GameEvent has PlayerId
checks “PlayerId the affected carrier/receiver or -1”
Holds
For GameEvent: Tick equals the published state tick;
GameEvent has Tick
Holds
Position is the action/end/new-scrimmage position as relevant.
GameEvent has Position
Holds
Value is six or two for scoring events, the ended quarter number for QuarterEnded, and +1 Home win / -1 Away win / 0 tie for GameEnded;
GameEvent has Value
Holds
ISourceGameState is an optional detached IGameState extension with SourceTick, SourceTicksPerSecond, PackedGameTime, ClockActive.
5 rules from this sentence
ISourceGameState extends IGameState
Holds
ISourceGameState has SourceTick
Holds
ISourceGameState has SourceTicksPerSecond
Holds
ISourceGameState has PackedGameTime
Holds
ISourceGameState has ClockActive
Holds
IGameState.Tick remains the host-step counter;
IGameState has Tick
Holds
Shared data API: SourceAnimationLibrary implements ISourceAnimationLibrary.GetClip(string) and ISourceAnimationClip.GetFrame(int sourceFrame).
2 rules from this sentence
SourceAnimationLibrary implements ISourceAnimationLibrary
checks “SourceAnimationLibrary implements ISourceAnimationLibrary.GetClip(string)”
HoldsAssetImport Contracts
SourceAnimationLibrary has a GetClip method
Holds
SourceAnimationFrame exposes immutable fifteen-joint Pose, raw AuthoringRoot and pre-actor-scale ScaledRoot in source units.
3 rules from this sentence
SourceAnimationFrame has Pose
checks “SourceAnimationFrame exposes immutable fifteen-joint Pose”
Holds
SourceAnimationFrame has AuthoringRoot
checks “SourceAnimationFrame exposes”
Holds
SourceAnimationFrame has ScaledRoot
checks “SourceAnimationFrame exposes”
Holds
Identity: SourceAnimationLayer.ScriptSymbol is the exact active script (e.g.
SourceAnimationLayer has ScriptSymbol
Holds
A layer's nonzero FacingDirection overrides the actor heading; zero inherits.
SourceAnimationLayer has FacingDirection
Holds
Position/heading: PlayerView.Position is the simulation's object X/Z in existing yard coordinates; Height is object Y in yards, excluding pelvis root height.
2 rules from this sentence
PlayerView has Position
checks “PlayerView.Position”
Holds
PlayerView has Height
Holds
PlayCamera.Render(IGameState, bool) reads detached snapshots only.
PlayCamera depends on IGameState
HoldsPresentation Contracts
Use Blitz.Editor.SourceTeamImporter.ImportMovement157FromCommandLine with the same all31 prepared team and original impact inputs, but -teamAnimationRoot "$NEW_BUNDLE157".
SourceTeamImporter has ImportMovement157FromCommandLine
Holds
FieldScene.Render consumes actual ISourcePresentationState directly, including raw actor/ball flags, original player mode, explicit designated home side and station heads.
FieldScene depends on ISourcePresentationState
HoldsPresentation Contracts
Only the trusted OriginalRelease57Hz-C2-M1-PreSnapSwitch-InitSoundBanks-v1 generation admits (plyrseq.c,m_hopclp_anim,3409,attack_snd,127,0,0), with SourceC2SoundFunctionKind.AttackSoundFixed=5.
SourceC2SoundFunctionKind has AttackSoundFixed
Holds
SourceC2SoundFunctions.Select requires the exact registered original cue, actual script instance/ANI_CODE, actor/tick/arguments, new data generation and same executing process/order/call cursor.
SourceC2SoundFunctions has Select
Holds
The historical SourceCinematicPlayback.ConsumeResolvedSourceSound still rejects kind5 and its retained per-call C2 context.
SourceCinematicPlayback has ConsumeResolvedSourceSound
Holds
SourceAudioBankReader.Read(bytes, frozenPackageSha256) reads the strict .saud binary companion to the audit JSON.
SourceAudioBankReader has a Read method
Holds
SourceAudioIsolatedPlayer leases an explicitly dedicated, empty AudioSource.
SourceAudioIsolatedPlayer uses AudioSource
Holds
BlitzRuntime.BindSourcePortablePcmOutput binds a separate SourceUnityPcmSoundOutput, never the isolated preview.
BlitzRuntime depends on SourceUnityPcmSoundOutput
HoldsRuntime Presentation
SourceC2Composition.CreateSimulation passes SourceC2Bootstrap.FromOriginalProgramBootAtSoundBanks(data) as the appended Core constructor input: announcer then taunt bank draws happen before initial AI.
SourceC2Composition depends on SourceC2Bootstrap
HoldsRuntime Gameplay
these internal types cannot be called from Unity's separate Editor assembly.
2 rules from this sentence
nothing in Blitz.Editor may depend on Blitz.AssetImport.RosterJson
HoldsBlitz Assets
nothing in Blitz.Editor may depend on Blitz.AssetImport.RosterObject
HoldsBlitz Assets
Assets/Scripts/Editor/SourceTeamInterfaceImporter.cs: actual AssetDatabase packaging, using the existing PlayerAssetImporter file/folder helpers, SourceHudAsset.Initialize, and SourceInterfaceServices.Initialize.
3 rules from this sentence
SourceTeamInterfaceImporter depends on SourceHudAsset
checks “SourceHudAsset.Initialize”
HoldsEditor Presentation
SourceTeamInterfaceImporter depends on SourceInterfaceServices
checks “SourceInterfaceServices.Initialize”
HoldsEditor Runtime
SourceTeamInterfaceImporter depends on PlayerAssetImporter
checks “using the existing PlayerAssetImporter file/folder helpers”
Holds
Blitz.Editor.SourceTeamInterfaceChecks.VerifySoundVmBindingsFromCommandLine checks saved resource/configuration references and exact SAFN bytes/pin.
SourceTeamInterfaceChecks has VerifySoundVmBindingsFromCommandLine
Holds
Blitz.Editor.SourceTeamInterfaceChecks.VerifySoundVmFromCommandLine additionally requires real graphics for existing complete atlas-pixel checks.
SourceTeamInterfaceChecks has VerifySoundVmFromCommandLine
Holds
catalog.tsv: actual functional play, formation, route, direction and handicap fields accepted by Blitz.Gameplay.SourcePlaybook.LoadConverted(TextReader).
SourcePlaybook has a LoadConverted method
Holds
45 rules from 6 docs

More open-source reports

Every report →

Other public repositories whose docs Striff read and checked against their code.