From fd87c97ef833d5f94f7c9dfdf0e5b76c0316fb9a Mon Sep 17 00:00:00 2001 From: tustin2121 Date: Wed, 2 Nov 2022 12:42:58 -0400 Subject: [PATCH] Adding documentation about GFHeader --- src/rom_header_gf.c | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/rom_header_gf.c b/src/rom_header_gf.c index 2723e1200e..472efe994a 100644 --- a/src/rom_header_gf.c +++ b/src/rom_header_gf.c @@ -6,6 +6,15 @@ #include "item.h" #include "pokeball.h" +// The purpose of this struct is for outside applications to be +// able to access parts of the ROM or its save file, like a public API. +// In vanilla, it was used by Colosseum and XD to access pokemon graphics. +// +// If this struct is rearranged in any way, it defeats the purpose of +// having it at all. Applications like PKHex or streaming HUDs may find +// these values useful, so there's some potential benefit to keeping it. +// If there's a compilation problem below, just comment out the assignment +// instead of changing this struct. struct GFRomHeader { u32 version;