gbdev / gbdev/pandocs

Document exact behavior of WX=0

Open
#358 0 comments 1 reaction 0 assignees View on GitHub
research
Dominant language
Markdown
Stars
783
Forks
134
Avg merge
6h 54m
Merged PRs (30d)
3

Description

It is mentioned in passing in the "Scrolling" page that the behavior "depends on SCX % 8", but that's all.

The exact behavior is supposedly a little complicated; it could be RE'd from SameBoy, but since #66 we've tried to rely on test ROMs rather than emulator sources whenever possible.

So:
- [ ] Investigate the exact behavior (being careful that even SameBoy can contain mistakes)
- [ ] Create a test ROM (if possible, verifiable without graphical output)
- [ ] Document the exact behavior based on that test ROM, and quote it

Originally discussed in https://github.com/gbdev/pandocs/pull/341#discussion_r708695972

Contributor guide

Open the contributing guide

Research direction

Start with the "Scrolling" page and the discussion in pandocs#341, then compare the described WX=0 behavior with SameBoy while treating emulator behavior as a hypothesis. Investigate whether a test ROM can verify the result without graphical output; done means a verified test ROM and documentation quoting its exact behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation, game-dev
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.