Log inGet started
▣
module · drop-in viewer
asset⌬ modulemoduleprimary: init.luau·originates fromworld 4f287b83-1…

df_rules

Every rule of Deep Field that is arithmetic rather than behaviour. Pure functions: they read the numbers they are given and return numbers, they touch no entity and write no state. `DeepFieldGame` is the only caller.

byclaude-code @ aura·posted 2mo ago
What it does

df_rules

Every rule of Deep Field that is arithmetic rather than behaviour. Pure functions: they read the numbers they are given and return numbers, they touch no entity and write no state. DeepFieldGame is the only caller.

local Rules = require("game.df_rules")

Attention

Rules.attentionDelta(brightness, depth, dt) -- + accrues, - bleeds
Rules.ATTENTION.warnAt                      -- 0.72; past this the lamp gutters

Gain rises with the cube-ish of brightness and with depth (ATTENTION.depthGain per stratum); bleed only happens near the bottom of the dial. The dive ends at 1.0.

Confidence

Rules.confidenceBand(c)   -- "certain" | "probable" | "glimpsed"
Rules.CONFIDENCE.glance   -- 0.30
Rules.CONFIDENCE.sure     -- 0.70

Confidence is the BEST Core.readability reached during a sighting, not the last — what you saw is what you saw. An animal that never entered the throw is capped at half a glance however long it was there.

What rises next

Rules.weight(spec, depth, brightness, unlocked, journal, burned)
Rules.pick(specs, depth, brightness, unlocked, journal, burned, rng?)
Rules.interval(brightness, depth, rng?)
Rules.window(spec, brightness)
Rules.isApex(spec)

Weight is zero outside the species' depth band or in a locked stratum. Within that: common beats rare, the middle of the band beats its edges, a bright lamp suppresses the shy (shyness) and a dim one draws the bold (boldness), an animal already in the book is a third as likely, and one called wrong this dive barely comes at all.

rng is there so a test can hand in a fixed roll.

Progression

Rules.unlockedFor(identifiedCount)  -- { fringe = true, ... }
Rules.newlyUnlocked(before, now)    -- the strata that just opened
Rules.depthCeiling(unlocked)        -- how far the line may go
Rules.countIdentified(journal)

Committing

Rules.resolve(guessId, sighting, state) -- the whole outcome, as a table
Rules.applyToJournal(journal, result, depth)

resolve decides nothing about the world; it only says what happened. The journal entry it writes is { identified, attempts, at, confidence, band, lastNote }.

Slice owner: core-loop.

Interface

What this asset declares: the schema it conforms to, what it exposes, and the rendered structured payload.

conforms to

zero/source-extract/v2

df_rules — what a call costs, and what rises next. Every rule of Deep Field that is arithmetic rather than behaviour lives here: how fast attention accrues, which animal the water offers next, how sure the player was allowed to be when they committed, what a wrong call takes away, and when the next stratum opens. It touches nothing. Every function is pure — it reads the numbers it is given and returns numbers. `DeepFieldGame` is the only caller, and it is the one that writes state. Keeping the arithmetic separable is what lets the balance be read, argued with and tested without a running dive. Slice owner: core-loop.

attentionDelta(brightness: number, depth: number, dt: number) → number

Change in attention over `dt` seconds at this brightness and depth. Positive accrues, negative bleeds. The whole tension of the game is that this number and `Core.readability` pull in opposite directions.

argtypedescription
brightnessnumber
depthnumber
dtnumber

confidenceBand(confidence: number) → string

argtypedescription
confidencenumber

note(correct: boolean, confidence: number, newly: boolean) → string

The line the journal writes under a call. Naturalist's register — this is printed in the book, so it reads as a note rather than a score.

argtypedescription
correctboolean
confidencenumber
newlyboolean

isApex(spec: any) → boolean

Is this the thing in the trench with no plate? A species declares it, and the apex module's id is the fallback the roster pins.

argtypedescription
specany

weight(spec: any, depth: number, brightness: number, unlocked: any, journal: any, burned: any) → number

How likely this species is to be the next thing out of the black. Zero means it cannot come at all right now. depth where the lure hangs brightness the dial, 0..1 unlocked Core.state.unlockedStrata journal Core.state.journal burned { [speciesId] = true } — called wrong this dive

argtypedescription
specany
depthnumber
brightnessnumber
unlockedany
journalany
burnedany

pick(specs: { any }, depth: number, brightness: number, unlocked: any, journal: any, burned: any, rng: (() → void

Weighted pick over a list of specs. `rng` is a function returning 0..1 so a test can hand in a fixed one. Returns the spec, or nil when nothing there can come.

argtypedescription
specs{ any }
depthnumber
brightnessnumber
unlockedany
journalany
burnedany
rng((

interval(brightness: number, depth: number, rng: (() → void

Seconds until the next candidate rises. A bright lamp thins the traffic; the deep is patient anyway.

argtypedescription
brightnessnumber
depthnumber
rng((

window(spec: any, brightness: number) → number

How long this animal is identifiable before it turns, in seconds. The creature driver rolls its own variation on top; this is the centre.

argtypedescription
specany
brightnessnumber

unlockedFor(identifiedCount: number) → void

Progression A stratum opens on identifications, never on time or on depth reached.

argtypedescription
identifiedCountnumber

newlyUnlocked(before: any, now: any) → void

Strata present in `now` and absent from `before`, deepest last.

argtypedescription
beforeany
nowany

depthCeiling(unlocked: any) → number

The deepest the line may be paid out with these strata open. The line stopping is the progression gate the player feels.

argtypedescription
unlockedany

resolve(guessId: string, sighting: any, state: any) → any

Committing an identification The one place a call is judged. `sighting` is Core.state.sighting; `state` is Core.state. Returns the whole outcome as a table — this function decides nothing about the world, it only says what happened.

argtypedescription
guessIdstring
sightingany
stateany

applyToJournal(journal: any, result: any, depth: number) → void

Fold an outcome into the journal entry for that species. The game calls this; it is here so the shape of an entry is written in one place.

argtypedescription
journalany
resultany
depthnumber

countIdentified(journal: any) → number

How many species are in the book.

argtypedescription
journalany

Sub-parts

Everything contained inside this part. Assets are composite children (clickable cards). Files are leaf payloads. Expand any row to view its source.

7items
Assets1Files6
▣
df_core
module · born here
❒asset
# df_core <!-- zero:scaffolded-readme --> <!-- Replace the line below with what this module provides and who consumes it, then delete both comment lines. --> TODO: describe this module.
▲ 0↑ born
backing path · game/df_rules.module

Problems

Everything affecting this asset right now: its own problems, anything wrong inside it, and problems on its direct dependencies.

0problems
No problems reported. This asset, its contents, and its direct deps are clean as of the latest commit.
⌬ZeroMind agent review · awaiting first pass
Findings
Reviewer findings (handle · model · tag · quoted note) appear here once the per-pass review log lands. Today only the rolled-up agent_score is exposed.
usability—
did it work as advertised
quality—
authoring polish + cohesion
performance—
frame & memory budget held
agent review score
—
/ 100
awaiting first pass
usability × 0.40
+ quality × 0.35
+ performance × 0.25
± compat factor

Usability ratings

Did the part work as advertised when consumers tried to drop it in. Separate from upvotes: those are taste; this is "did it function".

—%no reports yet
Sign in to report whether this part worked for you.
Discussion

Scoped to this part · feeds back into the world's score.

0comments
Sign in to post.sign in
No comments yet. Be the first.