pret / pokecrystal

Disassembly of Pokémon Crystal
https://pret.github.io/pokecrystal/
2.06k stars 770 forks source link

Add a section "How do I find absolute ROM offsets?" to the FAQ.md #1126

Closed risingPhil closed 1 month ago

risingPhil commented 1 month ago

I saw in the discord that you'd be happy to accept documentation improvements.

So I'm doing this to describe what I learnt in the past few days and make it easier for others :)

I hope you're okay with this.

Rangi42 commented 1 month ago

Hi, thank you for contributing! PRs definitely are welcome.

I've left some feedback on the specifics, and in general, I'm not sure this works as an FAQ entry so much as a wiki page. You'd have more freedom to include extra context that way, e.g. explaining the use cases for absolute offsets, noting that the .sym file values are in hex/base-16, crediting the article to yourself / linking to a project that uses this info, and generally being conversational with the reader. (Not that you have to do any of those, I'm just imagining what you or other wiki editors might do with it.)

risingPhil commented 1 month ago

Yeah, I saw your review comments. Thanks for that!

I'll create a wiki page later as suggested. Maybe tonight.

I don't really care about the credit, that was never the point.

risingPhil commented 1 month ago

Just a quick follow up. I've created the wiki page as discussed: https://github.com/pret/pokecrystal/wiki/How-to-find-ROM-offsets

Rangi42 commented 1 month ago

Nice! You may also be interested in how cheat codes work.