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

List more open-source projects that use RGBDS for testing and statstical purposes #1611

Open
Rangi42 opened this issue Jan 14, 2025 · 8 comments
Labels
good first issue New to the codebase? You can help no problem! meta This isn't related to the tools directly: repo organization, maintainership... tests This affects the test suite

Comments

@Rangi42
Copy link
Contributor

Rangi42 commented Jan 14, 2025

Please comment with your projects' URLs that use RGBDS if you have them!

Unlike #849, this would not be a new set of projects to add to CI: that's slow enough already, and most projects don't need to be built for every commit and PR.

However, it would be really nice to have a large suite of open-source GitHub repos (or GitLab, Sourcehut, etc) that we could use:

  • There could be an optional script to build all the projects, which we could manually run before releases to make sure there's no unexpected breakage. (Probably a lot of projects would require patching their Makefiles or other build systems, but we have the testing capability for that.)
  • We could analyze the source code to gauge which RGBDS features are heavily used, not used, used in combination, etc; as well as users' choices of symbol names, file structure, formatting, etc. This would be valuable information when we're deciding if+how to implement new features or deprecate+remove old ones. And it would be a less controversial option than any telemetry (not to mention not needing any networking code).
@Rangi42 Rangi42 added meta This isn't related to the tools directly: repo organization, maintainership... good first issue New to the codebase? You can help no problem! labels Jan 14, 2025
@aaaaaa123456789
Copy link
Member

I believe my RTC test ROM has never been added to the list, but at the same time, I'm not sure it builds on latest, since I haven't touched it since 2019...

@Rangi42
Copy link
Contributor Author

Rangi42 commented Jan 14, 2025

Note that CI currently tests pokecrystal, pokered, LADX, ucity, libbet, and the SameBoy bootroms. So projects that are just forks of those (in particular, the many pret-based Pokemon hacks) would not provide new info. (Although the prevalence of pret's style should be considered when making change decisions.)

@pinobatch
Copy link
Member

I update the RGBDS projects in these repositories the first chance I get after receiving word of imminent deprecation:

@aaaaaa123456789
Copy link
Member

aaaaaa123456789 commented Jan 14, 2025

Note that CI currently tests pokecrystal, pokered, LADX, ucity, libbet, and the SameBoy bootroms. So projects that are just forks of those (in particular, the many pret-based Pokemon hacks) would not provide new info. (Although the prevalence of pret's style should be considered when making change decisions.)

Projects that are significantly different from the originals might be useful. Your own Polished Crystal probably uses way more RGBASM features than pret/pokecrystal does...

@vulcandth
Copy link

vulcandth commented Jan 14, 2025

Going to mention pokegold-spaceworld, just because its one of the projects that still uses rgblink's "overlay" option for the baserom. If not it, might be worth including any other project that uses that feature.

My other projects are all pret-based so its probably not worth mentioning them. Although I do agree with ax6 regarding polished using more features than most.

@Rangi42
Copy link
Contributor Author

Rangi42 commented Jan 14, 2025

Thanks y'all, the actively-updated projects are good to add! (And you're right about overlay usage; I'd add that to CI if it weren't, you know, a leaked ROM.) However, a 5-years-dead project is not going to be a good test case or measurement for feature usage. :P Also, I expect the same author will be using the same style, so libbet might already represent what Numism etc would test. (Although like pret, they count for prevalence.)

@Rangi42
Copy link
Contributor Author

Rangi42 commented Jan 17, 2025

There are some disassemblies of Medabots and Dragon Warrior titles by @VariantXYZ.

@VariantXYZ
Copy link

Happy if it can be of use, but those projects rely on the overlay functionality and need a baserom to work.

If they are useful, the telefang project may also be helpful: https://github.com/telefang/telefang

@Rangi42 Rangi42 added the tests This affects the test suite label Jan 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue New to the codebase? You can help no problem! meta This isn't related to the tools directly: repo organization, maintainership... tests This affects the test suite
Projects
None yet
Development

No branches or pull requests

5 participants