Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

zmachine

package module

Go to main page

Versions in this module

v0

v0.2.0

Jul 30, 2026

v0.1.7

Jul 30, 2026

v0.1.6

Jul 30, 2026

v0.1.5

Jul 30, 2026

v0.1.4

Jul 30, 2026

v0.1.3

Jul 30, 2026

v0.1.2

Jul 30, 2026

v0.1.1

Jul 30, 2026

v0.1.0

Jul 30, 2026

Changes in this version

+ var ErrExecutionFault = errors.New("execution fault")

+ var ErrExecutionLimit = errors.New("execution limit exceeded")

+ var ErrInvalidOpcode = errors.New("invalid opcode")

+ var ErrInvalidState = errors.New("invalid saved state")

+ var ErrInvalidStory = errors.New("invalid Z3 story")

+ var ErrInvalidText = errors.New("invalid Z-string")

+ var ErrMemoryAccess = errors.New("invalid memory access")

+ func Version() string

+ type DecodeError struct

+ Addr uint32

+ Detail string

+ Err error

+ Opcode uint8

+ func (e *DecodeError) Error() string

+ func (e *DecodeError) Unwrap() error

+ type ExecutionError struct

+ Detail string

+ Err error

+ Op opcode

+ PC uint32

+ func (e *ExecutionError) Error() string

+ func (e *ExecutionError) Unwrap() error

+ type Machine struct

+ func New(story *Story, opts ...Option) (*Machine, error)

+ func (m *Machine) Halted() bool

+ func (m *Machine) Restore(data []byte) error

+ func (m *Machine) Run(ctx context.Context, input string) (Result, error)

+ func (m *Machine) Start(ctx context.Context) (Result, error)

+ type MemoryError struct

+ Addr uint32

+ Detail string

+ Err error

+ Op MemoryOp

+ Region Region

+ Width int

+ func (e *MemoryError) Error() string

+ func (e *MemoryError) Unwrap() error

+ type MemoryOp uint8

+ const MemoryRead

+ const MemoryWrite

+ func (o MemoryOp) String() string

+ type Option func(*config) error

+ func WithFrotzRandomSeed(seed uint64) Option

+ func WithInstructionLimit(limit uint64) Option

+ func WithLogger(logger *slog.Logger) Option

+ func WithRandomSeed(seed uint64) Option

+ func WithTracer(tracer Tracer) Option

+ type Region uint8

+ const RegionDynamic

+ const RegionHigh

+ const RegionStatic

+ const RegionUnknown

+ func (r Region) String() string

+ type Result struct

+ Output string

+ State []byte

+ Status Status

+ StatusLine StatusLine

+ UpperWindow string

+ type Status uint8

+ const Halted

+ const WaitingForInput

+ func (s Status) String() string

+ type StatusLine struct

+ Available bool

+ Hours uint8

+ Minutes uint8

+ Name string

+ Object uint16

+ Score int16

+ TimeGame bool

+ Turns int16

+ type Story struct

+ func LoadStory(data []byte) (*Story, error)

+ func (s *Story) Checksum() uint16

+ func (s *Story) Release() uint16

+ func (s *Story) Serial() string

+ func (s *Story) Size() int

+ func (s *Story) Version() uint8

+ type StoryError struct

+ Detail string

+ Err error

+ Field string

+ Value uint32

+ func (e *StoryError) Error() string

+ func (e *StoryError) Unwrap() error

+ type TextError struct

+ Addr uint32

+ Detail string

+ Err error

+ func (e *TextError) Error() string

+ func (e *TextError) Unwrap() error

+ type TraceInstruction struct

+ Branched bool

+ CallDepth int

+ Called bool

+ Next uint32

+ Opcode string

+ Operands []uint16

+ PC uint32

+ ReturnValue uint16

+ Returned bool

+ StoreValue uint16

+ StoreVariable uint8

+ Stored bool

+ type Tracer interface

+ Instruction func(TraceInstruction)