A restart point should restore a coherent snapshot, not whichever fields happened to be copied before a failed attempt.
Use it in a project
MODE=0 captures the three live byte fields, XOR checksum and SAVED=1. MODE=1 restores only if SAVED is exactly 1 and the saved bytes match CHECKSUM. RESULT=1 reports a completed capture or restore; other modes, absent snapshots or checksum mismatch return zero and leave live fields unchanged. Coordinates and resource counts have no additional game-specific range policy.
Include component.inc once (MOS callers include the shared 6502 implementation through it). Reserve the public fields in this exact order: RESULT, SAVED, LIVE_X, LIVE_Y, LIVE_RESOURCE, MODE, SAVED_X, SAVED_Y, SAVED_RESOURCE, CHECKSUM. They occupy 10 contiguous bytes. Also reserve the private workspace: T0 (1 bytes). Array names in the explanation refer to the numbered consecutive bindings, such as C0, C1 and so on.
Call checkpoint_state_init once at the intended reset boundary. It clears inputs as well as outputs and workspace. Set your starting state and configuration afterwards, then call checkpoint_state_step whenever the described event occurs. The helper reads no device, waits for no frame and installs no interrupt handler.
| Ownership | Fields |
|---|---|
| Retain between calls | SAVED, SAVED_X, SAVED_Y, SAVED_RESOURCE and CHECKSUM |
| Supply before service | MODE and the live fields before capture |
| Read after service | RESULT and the live fields after successful restore |
Restoration validates the complete saved record before touching any live field. That makes a failed restore a no-op on the player state rather than a partial rollback.
Reusable initialisation and service
; SPDX-License-Identifier: MIT
; Capture and Restore a Checked Checkpoint. See README.md for the byte interface and ownership.
; init clears the public fields and private workspace; set inputs afterwards.
checkpoint_state_init:
ld a,0
ld (RESULT),a
ld (SAVED),a
ld (LIVE_X),a
ld (LIVE_Y),a
ld (LIVE_RESOURCE),a
ld (MODE),a
ld (SAVED_X),a
ld (SAVED_Y),a
ld (SAVED_RESOURCE),a
ld (CHECKSUM),a
ld (T0),a
ret
checkpoint_state_step:
; RESULT = 0
ld a,0
ld (RESULT),a
; if MODE == 0:
ld a,(MODE)
cp 0
jp z,checkpoint_state_L1
jp checkpoint_state_L2
checkpoint_state_L1:
; SAVED_X = LIVE_X
ld a,(LIVE_X)
ld (SAVED_X),a
; SAVED_Y = LIVE_Y
ld a,(LIVE_Y)
ld (SAVED_Y),a
; SAVED_RESOURCE = LIVE_RESOURCE
ld a,(LIVE_RESOURCE)
ld (SAVED_RESOURCE),a
; CHECKSUM = SAVED_X ^ SAVED_Y
ld a,(SAVED_X)
ld b,a
ld a,(SAVED_Y)
ld c,a
ld a,b
xor c
ld (CHECKSUM),a
; CHECKSUM = CHECKSUM ^ SAVED_RESOURCE
ld a,(CHECKSUM)
ld b,a
ld a,(SAVED_RESOURCE)
ld c,a
ld a,b
xor c
ld (CHECKSUM),a
; SAVED = 1
ld a,1
ld (SAVED),a
; RESULT = 1
ld a,1
ld (RESULT),a
; return
ret
jp checkpoint_state_L3
checkpoint_state_L2:
checkpoint_state_L3:
; if MODE != 1:
ld a,(MODE)
cp 1
jp nz,checkpoint_state_L4
jp checkpoint_state_L5
checkpoint_state_L4:
; return
ret
jp checkpoint_state_L6
checkpoint_state_L5:
checkpoint_state_L6:
; if SAVED != 1:
ld a,(SAVED)
cp 1
jp nz,checkpoint_state_L7
jp checkpoint_state_L8
checkpoint_state_L7:
; return
ret
jp checkpoint_state_L9
checkpoint_state_L8:
checkpoint_state_L9:
; T0 = SAVED_X ^ SAVED_Y
ld a,(SAVED_X)
ld b,a
ld a,(SAVED_Y)
ld c,a
ld a,b
xor c
ld (T0),a
; T0 = T0 ^ SAVED_RESOURCE
ld a,(T0)
ld b,a
ld a,(SAVED_RESOURCE)
ld c,a
ld a,b
xor c
ld (T0),a
; if T0 != CHECKSUM:
ld a,(T0)
ld b,a
ld a,(CHECKSUM)
ld c,a
ld a,b
cp c
jp nz,checkpoint_state_L10
jp checkpoint_state_L11
checkpoint_state_L10:
; return
ret
jp checkpoint_state_L12
checkpoint_state_L11:
checkpoint_state_L12:
; LIVE_X = SAVED_X
ld a,(SAVED_X)
ld (LIVE_X),a
; LIVE_Y = SAVED_Y
ld a,(SAVED_Y)
ld (LIVE_Y),a
; LIVE_RESOURCE = SAVED_RESOURCE
ld a,(SAVED_RESOURCE)
ld (LIVE_RESOURCE),a
; RESULT = 1
ld a,1
ld (RESULT),a
ret
component_end:Machine contract
AF/BC/DE/HL may change; IX/IY are preserved. A direct CALL needs two return-address stack bytes. The helper makes no nested calls and adds no other stack use. Its named scratch is private workspace, not a pointer, a ROM variable or shared zero-page space that the game may borrow concurrently. The samples use fixed symbol bindings. Scope or rename every label and binding, including the component_end measurement marker, and allocate a separate block for each independent instance. Different helpers can also use common field names, so combining them needs separate namespaces or explicitly renamed bindings. Give each block one mutation owner.
The 48K diagnostic boots through ROM tape loading and USR, disables interrupts and owns the screen. The helper performs no port or screen writes.
Adapt the caller
demo.asm supplies the bindings and include order. exercise.inc first runs table cases, then a separate client retaining state between calls. A game can call the public step entry directly and remove the diagnostic packet and display. Do not copy the diagnostic’s hardware takeover into an existing game loop.
Build with make ASM198X=/path/to/asm198x. The Makefile produces normal, custom, deliberately wrong and repaired programs. Tools must already be installed; the sample downloads nothing.
Bindings and include order
org $8000
CUSTOM equ 0
BROKEN equ 0
COYOTE_STEPS equ 4
BUFFER_STEPS equ 4
TEXT_CAP equ 8
PROPERTY_COUNT equ 16
STREAM_BYTES equ 13
CRC_POLY equ 7
include "caller.inc"
include "exercise.inc"
component_start:
include "component.inc"
include "data.inc"
include "cases.inc"
include "../../physics/rectangle-overlap/display.inc"
code_end:
STATE:
RESULT: defb 0
SAVED: defb 0
LIVE_X: defb 0
LIVE_Y: defb 0
LIVE_RESOURCE: defb 0
MODE: defb 0
SAVED_X: defb 0
SAVED_Y: defb 0
SAVED_RESOURCE: defb 0
CHECKSUM: defb 0
T0: defb 0
input_ptr: defw 0
output_ptr: defw 0
cases_left: defb 0
ready: defb 0
preview: defs 8,0
OUTPUT: defs 1300,0
end startA client retaining state between calls
preview_rules:
if CUSTOM
; LIVE_X = 250
ld a,250
ld (LIVE_X),a
; LIVE_Y = 1
ld a,1
ld (LIVE_Y),a
; LIVE_RESOURCE = 255
ld a,255
ld (LIVE_RESOURCE),a
if BROKEN
; SAVED_RESOURCE = 0
ld a,0
ld (SAVED_RESOURCE),a
endif
call checked_step
call emit_state
; LIVE_X = 0
ld a,0
ld (LIVE_X),a
; MODE = 1
ld a,1
ld (MODE),a
if BROKEN
; SAVED_RESOURCE = 0
ld a,0
ld (SAVED_RESOURCE),a
endif
call checked_step
call emit_state
ret
else
; LIVE_X = 20
ld a,20
ld (LIVE_X),a
; LIVE_Y = 30
ld a,30
ld (LIVE_Y),a
; LIVE_RESOURCE = 4
ld a,4
ld (LIVE_RESOURCE),a
if BROKEN
; SAVED_RESOURCE = 0
ld a,0
ld (SAVED_RESOURCE),a
endif
call checked_step
call emit_state
; LIVE_X = 99
ld a,99
ld (LIVE_X),a
; LIVE_Y = 88
ld a,88
ld (LIVE_Y),a
; LIVE_RESOURCE = 0
ld a,0
ld (LIVE_RESOURCE),a
; MODE = 1
ld a,1
ld (MODE),a
if BROKEN
; SAVED_RESOURCE = 0
ld a,0
ld (SAVED_RESOURCE),a
endif
call checked_step
call emit_state
endif
retCustomise it
Capture high coordinate/resource values and restore after a different live change. The maintained custom caller changes its inputs or client sequence rather than hiding a different implementation behind the same label. Compare every state of the two clients, not only their final display.
Custom client selection
org $8000
CUSTOM equ 1
BROKEN equ 0
COYOTE_STEPS equ 2
BUFFER_STEPS equ 2
TEXT_CAP equ 4
PROPERTY_COUNT equ 16
STREAM_BYTES equ 13
CRC_POLY equ 49
include "caller.inc"
include "exercise.inc"
component_start:
include "component.inc"
include "data.inc"
include "cases.inc"
include "../../physics/rectangle-overlap/display.inc"
code_end:
STATE:
RESULT: defb 0
SAVED: defb 0
LIVE_X: defb 0
LIVE_Y: defb 0
LIVE_RESOURCE: defb 0
MODE: defb 0
SAVED_X: defb 0
SAVED_Y: defb 0
SAVED_RESOURCE: defb 0
CHECKSUM: defb 0
T0: defb 0
input_ptr: defw 0
output_ptr: defw 0
cases_left: defb 0
ready: defb 0
preview: defs 8,0
OUTPUT: defs 1300,0
end startThe custom diagnostic row is 01 01 FA 01 FF 01 FA 01. The full client trace in the source explains how it gets there.
Mistake and repair
The wrong caller overwrites a saved field before restoring. The checksum rejects the damaged snapshot and preserves the current live state. Keep snapshot ownership with the capture/restore routine.
The BROKEN branch lives in the sequential client, not the reusable helper. wrong.asm selects it; repaired.asm restores the normal call sequence. The repaired executable matches the normal program (for Spectrum, compare loaded CODE rather than the tape filename).
Select the deliberately wrong client
org $8000
CUSTOM equ 0
BROKEN equ 1
COYOTE_STEPS equ 4
BUFFER_STEPS equ 4
TEXT_CAP equ 8
PROPERTY_COUNT equ 16
STREAM_BYTES equ 13
CRC_POLY equ 7
include "caller.inc"
include "exercise.inc"
component_start:
include "component.inc"
include "data.inc"
include "cases.inc"
include "../../physics/rectangle-overlap/display.inc"
code_end:
STATE:
RESULT: defb 0
SAVED: defb 0
LIVE_X: defb 0
LIVE_Y: defb 0
LIVE_RESOURCE: defb 0
MODE: defb 0
SAVED_X: defb 0
SAVED_Y: defb 0
SAVED_RESOURCE: defb 0
CHECKSUM: defb 0
T0: defb 0
input_ptr: defw 0
output_ptr: defw 0
cases_left: defb 0
ready: defb 0
preview: defs 8,0
OUTPUT: defs 1300,0
end start
Cost and alternatives
The measured helper extent is 210 code bytes; public state is 10 bytes and private scratch is 1 bytes. There are no immutable helper tables. Caller data, the test cases, return-address stack, alignment and display buffers cost additional space. These are assembled sizes, not cycle measurements.
Constant work for three fields. Larger games need an explicit snapshot schema, versioning and ownership; copying an entire object pool may cost much more RAM than a small checkpoint.
This is an in-memory checkpoint, not disk persistence or interrupt-safe saving. XOR can miss multi-byte changes that cancel; it is a small accidental-damage guard, not authentication. Use stronger checksums and an atomic storage protocol for durable saves.
Execution evidence
Four variants run on 48K PAL ROM tape load and USR, using Asm198x 0.0.72, Emu198x 0.44.2. Each executes 64 boundary/varied/error table cases, dirty initialisation and the separate retained-state client. An independent mathematical/container model checks every public byte after every call. This is bounded example coverage, not exhaustive correctness for every possible state.
The records retain loaded immutable code, completion, register sentinels, full packets, source/tool/firmware hashes and captures. The public gate validates these retained observations and rejects altered evidence; it does not run restricted firmware. No firmware is distributed. The eight displayed bytes are the first eight public fields, zero-padded when shorter; the packet includes every field.
Where it fits
Streaming CRC: A stronger checksum can detect more accidental changes, but it still does not make a write atomic.