List every Pan Docs chapter, grouped by part.

Use this to orient yourself in the book or to find the page name to pass to pandocs_get_page. Returns chapter titles, page ids, URLs and section counts.

Search all ~580 Pan Docs sections and return ranked snippets.

Good for open questions ("why does my sprite flicker", "OAM DMA timing"). For a specific register or address, gb_lookup_register or gb_memory_map give an exact answer more cheaply.

Read a whole Pan Docs chapter.

Custom syntax is expanded: {{#bits}} tables become readable bit layouts, :::warning callouts become labelled blockquotes, and cross-references are resolved to real gbdev.io URLs. Pass sections_only=True first if you only need to find the right section.

Read one section, with its bitfields, hardware caveats and cross-references.

Accepts anything you were handed elsewhere: a ref from a search result, a section title such as "FF40 - LCDC: LCD control", or an anchor found inside returned prose.

Resolve a #Section Name cross-reference to its page, slug and URL.

Pan Docs anchors are book-wide section-name lookups, not same-page anchors, so following one needs this. Flags titles that occur on more than one page.

Look up a hardware register by address, name, RGBDS alias, or description.

Returns the address, every alias, access (R/W/Mixed), which models have it, the full bitfield layout with per-bit meanings, and the documentation text.

List hardware registers, optionally filtered by model, group or address range.

Use this to survey a subsystem ("all audio registers") before drilling into one with gb_lookup_register.

Explain what writing a specific byte to a register actually configures.

This is the tool for disassembly constants: given ld a,$91 / ldh [rLCDC],a, it reports every bit's documented meaning. Bits with no documented meaning are listed separately rather than guessed at.

Build the byte that produces a desired register configuration.

The inverse of gb_decode_register_value. Returns the byte, its binary breakdown, a shift expression, and RGBDS-style assembly.

Identify what lives at an address, across every relevant source.

With no address, returns the full region table, the I/O ranges and the jump vectors. With one, reports the memory region plus -- where they apply -- the hardware register, RST/interrupt vector, cartridge-header field, and (given mbc) which banking register a write there would hit.

Show the cartridge header layout, or one field's full documentation.

Decode a cartridge-header code, list a whole table, or search it by name.

Covers cartridge type ($13 -> MBC3+RAM+BATTERY), ROM and RAM sizes, destination, both licensee tables, and the CGB flag.

Decode a real cartridge header and verify its checksum.

Resolves every code, checks the Nintendo logo against the reference dump, and recomputes the header checksum the boot ROM validates (a mismatch means the ROM will not run).

Summarise a mapper: its mapped memory ranges, control registers and quirks.

The quirks are the chapter's warning/tip callouts -- MBC1's bank-0 aliasing, MBC3's RTC latching, MBC2's built-in nibble RAM.

Identify which banking register a ROM-area write hits.

Turns an opaque ld [$2000], a into "MBC1 ROM Bank Number", with the documented behaviour (masking, the $00->$01 rule, mode dependence) attached.

Disassemble SM83 bytes into instructions.

Mnemonics, operands and encoding come from Pan Docs; cycle counts and flag effects come from gbdev.io/gb-opcodes (Pan Docs documents neither), and each field says which. Invalid opcodes that hard-lock the CPU are flagged.

Look up how an instruction is encoded, and what it costs.

Returns the bit pattern, every opcode byte in the group, an example decoding, and its cycles and flag effects.

Show the structural opcode map: the four blocks, the $CB block, and the placeholder definitions (r8, r16, r16mem, cond, b3, tgt3) they are built from.

Use this to reason about encoding patterns; use gb_decode_opcode for concrete bytes.

Explain the interrupt system, or one interrupt in detail.

Returns each vector with its IE/IF bit and priority; with an argument, adds the source's full documentation and the dispatch rules.

List Pan Docs' hardware caveats -- its tip/warning/danger callouts.

This is where "why does the original code do this strange thing" is usually answered: LCD-disable timing, OAM corruption, MBC1 aliasing, STAT blocking.

Report the register values a ROM inherits from the boot ROM at PC=$0100.

Tells you what state the entry point can rely on, and which values are non-deterministic on a given model.