more SGB border suggestions/notes
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation, game-dev
Research direction
Start by reading the linked examples in src/sub.sm83 and code/init.sm83, then locate the guide sections covering .mltOff, packet bytes and sizes, tile mappings, and PCT_TRN addresses. Done means revising the examples and wording, clarifying packet and mapping behavior, adding the proposed address table, and correcting the listed text issues.
Written by the indexing model from the issue text.
Description
- change or better document the example code
* https://github.com/zlago/violence-gbc/blob/11cfdb6ee8a35e042fa9712484d814e0961cea7c/src/sub.sm83#L413-L463
* https://github.com/zlago/snek-gbc/blob/baef0369f57d2b0d58316cb1c28c6cc22475a6c9/code/init.sm83#L208-L230 - the guide confusingly states that .mltOff is for 2 players and that if you wish to return to 1 player mode you will have to send the packet yourself
- "
$99, $00if the screen is loaded with the first 4KiB of tile data" could these be worded less awkwardly? like "$99, $00for the first 4KiB of tiles" - is it clear that the hex values next to packet names are the bytes to send? is it clear that packets can have sizes shorter than 16 but still require sending 16 bytes?
- shouldnt we just assume the user uses tile blocks 0 and 1 and have what to do for the other mapping as a side note?
- wouldnt a table (like the memory maps on pandocs) for the PCT_TRN addresses (including the unused space) look better?
- etc:
* "ccomon" -> "common"
* "in my case it was blue" -> "in the example its blue"
* "You can add a row of the transparent color at the top of the image to force superfamiconv to make it tile #0" -> "You can add a row of tiles of the transparent color at the top of the image to force superfamiconv to use that for tile #0"
* change "[^1]" and "[^1]:" to a "(see notes)" and a note, respectively
- Dominant language
- Assembly
- Stars
- 34
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from gbdev/gbdev.github.io
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
gbdev/gbdev.github.io#107 · 2 reactions ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
gbdev/gbdev.github.io#106 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
gbdev/gbdev.github.io#86 ·
-
help wanted question
Difficulty 5/5 Over a week Newbie friendliness 20/100
gbdev/gbdev.github.io#103 · 54 comments · 2 reactions ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
gbdev/gbdev.github.io#89 ·
All issues in gbdev/gbdev.github.io
Similar issues
-
triage
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
feature pydanty:is-working
Difficulty 1/5 Under an hour Newbie friendliness 88/100
pydantic/pydantic-ai#8647 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
:watch: Not Triaged dotnet-fsharp/svc
Difficulty 1/5 Under an hour Newbie friendliness 90/100