mirror of
https://github.com/gbdev/pandocs.git
synced 2026-07-25 23:19:45 +00:00
The single, most comprehensive Game Boy technical reference.
https://gbdev.io/pandocs/
- Markdown 84.7%
- Rust 6.4%
- JavaScript 5.4%
- Python 1.7%
- CSS 1.5%
- Other 0.3%
fe246067b6* Rewrite BCPD description of the colour data format - less ambiguous description of the colour data format - clarify meaning of endianness (byte order) - reverse the order of the bit table, so MSB appears first, matching others * Update src/Palettes.md Co-authored-by: Eldred Habert <me@eldred.fr> * Apply suggestions from code review Co-authored-by: Eldred Habert <me@eldred.fr> * Add SVG diagrams describing GBC colour format Co-authored-by: "Janni K." <24881711+nummacway@users.noreply.github.com> Co-authored-by: Rangi42 <sylvie.oukaour+rangi42@gmail.com> * Move description of color format outside of BGPI/BGPD * Touch up description of CGB pal regs * Use new names for CGB pal regs Those have been deprecated in newer `hardware.inc`, and really, the header names were hard to read with the duplicated names, especially the OBJ ones. Anyone being confused by old code should be able to deduce the alternate naming from their definitions in the accompanying `hardware.inc`, or they can look it up on older versions of Pan Docs, or they can ask and be explained. I nonetheless expect that the impact will be very low at this point. * Update src/Palettes.md * Update src/Palettes.md * Update src/Palettes.md Co-authored-by: Quinn <3379314+quinnyo@users.noreply.github.com> * Update src/Palettes.md Co-authored-by: Quinn <3379314+quinnyo@users.noreply.github.com> * Update src/Palettes.md Fix wildy incorrect arithmetic Co-authored-by: Eldred Habert <me@eldred.fr> * Add an overview of the palette systems * Tweak wording of bit 15 footnote * Clarify use of “little-endian” * Improve wording of CRAM interface introduction Co-authored-by: Quinn <3379314+quinnyo@users.noreply.github.com> * Clarify effect of PPU locking on CRAM regs Co-authored-by: Quinn <3379314+quinnyo@users.noreply.github.com> * Move and reword tip about BG color initialisation --------- Co-authored-by: Antonio Vivace <avivace4@gmail.com> Co-authored-by: Eldred Habert <me@eldred.fr> Co-authored-by: "Janni K." <24881711+nummacway@users.noreply.github.com> Co-authored-by: Rangi42 <sylvie.oukaour+rangi42@gmail.com> |
||
|---|---|---|
| .github | ||
| custom | ||
| historical | ||
| preproc | ||
| renderer | ||
| src | ||
| theme | ||
| .gitattributes | ||
| .gitignore | ||
| book.toml | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CONTRIBUTING.md | ||
| DEPLOY.md | ||
| Dockerfile | ||
| LICENSE | ||
| README.md | ||
| requirements.txt | ||
Pan Docs
"Pan Docs" is a document started in early 1995, considered the single most comprehensive technical reference to Game Boy available to the public.
This git repository hosts a renewed version of it, mantained in the Markdown format and enjoying renewed community attention.
Go to gbdev.io/pandocs to read the document.
Contributing
Everyone is welcome to contribute opening issues, expressing feedback, adding and improving content or share new findings. Please, check the contributing guidelines for a complete view on how to contribute to this project or read the deploy instructions to run a local copy of Pan Docs.
License
Pan Docs is released into the public domain.