Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation in doc/, in particular for the known Gen 1 bugs #258

Open
Rangi42 opened this issue Jul 4, 2020 · 14 comments
Open

Add documentation in doc/, in particular for the known Gen 1 bugs #258

Rangi42 opened this issue Jul 4, 2020 · 14 comments
Labels

Comments

@Rangi42
Copy link
Member

Rangi42 commented Jul 4, 2020

pokecrystal has at least 66 known bugs, as well as various design flaws (not really bugs, but still things a hack project would want to correct). pokegold has at least three unique bugs. I expect that pokered has many more:

Ideally these would be documented, with minimal fixes if possible.

Design flaws might not be worth documenting (since they're subjective and Gen 1 arguably has enough of them that the appropriate fix is to switch to Gen 2 or port its subsystems en masse—see pokered-crysaudio, pokered-gbc, pokered-clean, etc), but definite bugs are.

@Rangi42
Copy link
Member Author

Rangi42 commented Jul 14, 2020

With glitchcity.info shutting down, it would be that much more useful to have a central lookup for all Gen 1 bugs, with source code references.

@mid-kid
Copy link
Member

mid-kid commented Jul 14, 2020

I feel like the pret docs focus more on inappropriate behavior of the code, while glitchcity.info focusses more on practical applications of the bugs. These are two very different approaches to the documentation that are hard to combine while keeping consistent.

@Rangi42
Copy link
Member Author

Rangi42 commented Jul 14, 2020

You're right. I don't mean to document every single glitch they do. But their "natural glitch" list is a good starting point for a level of bug documentation similar to pokecrystal, and that first link to the forums already has YouTube and pokered links.

@Rangi42
Copy link
Member Author

Rangi42 commented Jul 14, 2020

There are also some bugs GCL wouldn't have documented which are nevertheless bugs in the code; for example:

; function to check the tile ahead to determine if the character should get on land or keep surfing
; sets carry if there is a collision and clears carry otherwise
; It seems that this function has a bug in it, but due to luck, it doesn't
; show up. After detecting a sprite collision, it jumps to the code that
; checks if the next tile is passable instead of just directly jumping to the
; "collision detected" code. However, it doesn't store the next tile in c,
; so the old value of c is used. 2429 is always called before this function,
; and 2429 always sets c to 0xF0. There is no 0xF0 background tile, so it
; is considered impassable and it is detected as a collision.
CollisionCheckOnWater::

@mid-kid
Copy link
Member

mid-kid commented Jul 14, 2020

Oh, yeah, all I'm saying is that this wiki is probably not a good replacement for what glitchcity.info used to provide.

@Rangi42 Rangi42 mentioned this issue Jul 16, 2020
54 tasks
@Rangi42
Copy link
Member Author

Rangi42 commented Aug 26, 2020

GCL is shutting down in a week (https://forums.glitchcity.info/index.php?topic=9149). Of course their documented glitches will still be archived, but this would be a good time to start a Bugs and Glitches doc for pokered.

@SatoMew
Copy link
Contributor

SatoMew commented Mar 30, 2022

Here's the current link to the GCRI wiki. The contents were carried over from the old GCL wiki.

I'll be sharing some info on bugs in a follow-up comment.

@SatoMew
Copy link
Contributor

SatoMew commented Mar 31, 2022

Here are a few examples that could be included in the document:

@vulcandth
Copy link
Contributor

vulcandth commented May 11, 2022

When I get some time; i'll see about starting this. I'll create a docs/bugs_and_glitches.md formatted similarly to pokecrystal's. I'll add a bug fix or two... and create a PR to merge. The idea, is that this will serve as a template for others to add to.

@Rangi42
Copy link
Member Author

Rangi42 commented May 11, 2022

It can start as a wiki page for easy contribution; I thought someone had already made one in the pokered wiki, but apparently not.

@vulcandth
Copy link
Contributor

It can start as a wiki page for easy contribution; I thought someone had already made one in the pokered wiki, but apparently not.

Yeah; that might be a better idea. Then we can look at merging it into the codebase later. I still do like the idea of it eventually making it into the codebase. As things in the codebase tend to be "vetted", and gives downstream users simple bug fixes they can implement with little worry of causing further bugs (in the vanilla rom).

@rawr51919
Copy link
Contributor

The 5 Pokéballs text issue and the Cinnabar Island glitch have both been given wiki articles. The latter just needs expansion to deal with the other 2x2 block encounter glitches.

@Rangi42
Copy link
Member Author

Rangi42 commented Jul 4, 2022

...please don't start adding issue comments with notifications for every incremental update to the wiki. There are possibly hundreds of Gen 1 bugs to document, certainly more than Gen 2. Just, go ahead and add to the wiki whenever you like, other people can too, and eventually if it looks like a comprehensive document of bugs we can consider putting it in the repo.

@rawr51919
Copy link
Contributor

It can start as a wiki page for easy contribution; I thought someone had already made one in the pokered wiki, but apparently not.

Yeah; that might be a better idea. Then we can look at merging it into the codebase later. I still do like the idea of it eventually making it into the codebase. As things in the codebase tend to be "vetted", and gives downstream users simple bug fixes they can implement with little worry of causing further bugs (in the vanilla rom).

Added the wiki page for the bugs and glitches document, still needs video docs otherwise it's pretty well formatted the same as pokegold's and pokecrystal's document: https://github.com/pret/pokered/wiki/Bugs-and-Glitches

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants