Unpack resdat and cldat files, create C headers for offsets into palette resdats #279

joshua-smith-12 · 2024-10-25T19:00:24Z

Uncovered how the resdat files and palette offsets were being used while I was working on #269 so figured I would unpack the files + add a build step while it was fresh in the brain

shoutout to the txt files such as res/data/tmapn_celact.txt which were probably left in the filesystem by mistake and contain a direct explanation for the binary format for resdat/cldat files, lol

I'll probably extend this to do a bit more documentation in the files I've already modified, specifically around unk_0200C6E4.c. I need to check if the other gen4 projects already did work in this area (I think pokeheartgold does have a bunch of this file documented already)

joshua-smith-12 · 2024-10-25T19:15:42Z

res/data/plist_canm.json

+            "narc": 20,
+            "member": 0,


I think it would be nice to reference the NARC and member by name here and have the build step convert them into IDs on the fly, but need to figure out where the data mapping NARCs and members to indices would be available at this point in the build

You could move them from the C constants in include/constants/narc.h to be a generated multi-lang constant in consts/. Then, you'd have access to these in the Python script that builds the NARCs.

lhearachel

Is there any documentation on what these files actually represent? Are they just packs of resources that should always be loaded together?

lhearachel · 2024-10-26T03:06:34Z

src/unk_0208EA44.c

@@ -430,7 +431,7 @@ void sub_0208F16C(PokemonSummaryApp *param0)
 static void sub_0208F194(PokemonSummaryApp *param0, u8 param1, u8 param2, u8 param3)
 {
    sub_0200D948(param0->renderer, param0->gfxHandler, sub_0207C944(), sub_0207C908(param3), 1, param2);
-    sub_0200D414(param0->unk_41C[param1], sub_0207C92C(param3) + 3);
+    sub_0200D414(param0->unk_41C[param1], sub_0207C92C(param3) + RESDAT_PST_PAL_NARC_27_MEMBER_74_1_OFFSET);


Should this be an naix value?

…sets

joshua-smith-12 · 2024-11-06T17:50:28Z

Is there any documentation on what these files actually represent? Are they just packs of resources that should always be loaded together?

yes! if I understand it right,

each resdat file contains a list of resources of 1 type (e.g. cells, tiles, anims, palettes) which are all loaded as SpriteResource types into a SpriteResourceCollection
each cldat file contains a list of indices into these collections which can be used to construct a CellActorResourceData type which contains data for each resource type (NNSG2dImageProxy, NNSG2dCellAnimBankData, etc)

so all of these resdat files get loaded together, and then the cldat file constructs what is essentially templates of CellActorResourceData from the data in the resdats which can be used for constructing a CellActor

lhearachel

Some cursory questions and basic polish comments.

lhearachel · 2024-11-10T01:18:18Z

include/sprite_renderer.h

+typedef struct CellActorPropsTemplate {
+    int resourceIndex;
+    s16 x;
+    s16 y;
+    s16 z;
+    u16 anim;
+    int priority;
+    int palette;
+    int vramType;
+    int unk_18;
+    int unk_1C;
+    int unk_20;
+    int unk_24;
+} CellActorPropsTemplate;


question: How does this differ from the existing SpriteTemplate?

lhearachel · 2024-11-10T01:18:46Z

include/sprite_renderer.h

+#ifndef POKEPLATINUM_UNK_0200C6E4_H
+#define POKEPLATINUM_UNK_0200C6E4_H


polish: Modify the include guards (and the comment at the end of this file).

lhearachel · 2024-11-10T01:21:00Z

res/meson.build

@@ -68,3 +68,4 @@ subdir('items')
 subdir('pokemon')
 subdir('sound')
 subdir('trainers')
+subdir('data')


polish: Keep this list sorted in lexicographical order, unless a specific processing order is needed.

lhearachel · 2024-11-10T01:21:57Z

src/applications/pokemon_summary_screen/sprite.c

@@ -7,8 +7,7 @@

 #include "applications/pokemon_summary_screen/main.h"
 #include "applications/pokemon_summary_screen/subscreen.h"
-#include "overlay007/struct_ov7_0224F2EC.h"
-#include "overlay007/struct_ov7_0224F358.h"
+#include "data/pst_pal.naix"


polish: #include "res/data/pst_pal.naix" will sort this to the bottom of the includes, which I think is preferable.

lhearachel · 2024-11-10T01:24:17Z

src/sprite_renderer.c

+
+BOOL SpriteRenderer_CreateCellActorList(SpriteRenderer *renderer, SpriteGfxHandler *gfxHandler, int numCells)
+{
+    if ((renderer == NULL) || (gfxHandler == NULL)) {


polish: Unnecessary parens.

lhearachel · 2024-11-10T01:24:47Z

src/sprite_renderer.c

+    {
+        UnkStruct_ov22_022559F8 v0;
+
+        v0.unk_00 = param2->unk_00;
+        v0.unk_04 = param2->unk_04;
+        v0.unk_08 = param2->unk_08;
+        v0.unk_0C = renderer->heapID;
+
+        sub_0201E88C(&v0, param2->unk_0C, param2->unk_10);
+    }


polish: I'll leave it up to you if you want to break down this unnecessary scope-block or not; since the inner struct here is undocumented, I can let it slide.

lhearachel · 2024-11-10T01:25:54Z

src/sprite_renderer.c

+static BOOL sub_0200D27C(SpriteResourceCollection *resourceCollection, SpriteResourceList *resourceList, int resourceID)
+{
+    for (int i = 0; i < resourceList->capacity; i++) {
+        if (resourceList->resources[i] == NULL) {
+            continue;
+        }
+
+        int spriteResourceID = SpriteResource_GetID(resourceList->resources[i]);
+
+        if (spriteResourceID == resourceID) {
+            sub_0201EB50(resourceID);
+            SpriteResourceCollection_Remove(resourceCollection, resourceList->resources[i]);
+
+            resourceList->resources[i] = NULL;
+            resourceList->count--;
+
+            return TRUE;
+        }
+    }
+
+    return FALSE;
+}
+
+static BOOL sub_0200D2D0(SpriteResourceCollection *resourceCollection, SpriteResourceList *resourceList, int resourceID)
+{
+    for (int i = 0; i < resourceList->capacity; i++) {
+        if (resourceList->resources[i] == NULL) {
+            continue;
+        }
+
+        int spriteResourceID = SpriteResource_GetID(resourceList->resources[i]);
+
+        if (spriteResourceID == resourceID) {
+            sub_0201F9F0(resourceID);
+            SpriteResourceCollection_Remove(resourceCollection, resourceList->resources[i]);
+
+            resourceList->resources[i] = NULL;
+            resourceList->count--;
+
+            return TRUE;
+        }
+    }
+
+    return FALSE;
+}


polish: Can we name these functions?

lhearachel · 2024-11-10T01:28:56Z

res/data/btower_canm.json

+        {
+            "narc": 123,
+            "file": 3,
+            "compressed": false,
+            "id": 0
+        }


suggestion: I think that, in general, I would rather we get these to map to NARCs and NAIX files. Maybe this means that the conversion utility should be in C code so that we can easily import the necessary header files.

joshua-smith-12 marked this pull request as draft October 25, 2024 19:08

joshua-smith-12 commented Oct 25, 2024

View reviewed changes

lhearachel reviewed Oct 26, 2024

View reviewed changes

lhearachel marked this pull request as ready for review October 26, 2024 03:07

joshua-smith-12 added 10 commits November 6, 2024 10:27

unpack all resdat/cldat, document format, add headers for palette off…

ab41e0c

…sets

make use of resdat headers in a couple locations

027070f

remove irrelevant description field

5548ce1

start doing some cleanup/renaming related to cldat/resdat code

92af8e5

roughly align resdat JSON format with how pokeheartgold handles

b539da1

halfway through sprite_renderer, continuing to document

1e9bd57

finish first pass over sprite_renderer files

217a90c

document struct for cldat files

476319c

fix missed changes after rebasing

ba2359a

document CellActorPropsTemplate struct

d429b1c

joshua-smith-12 force-pushed the resdat_unpack branch from 8991602 to d429b1c Compare November 6, 2024 17:50

formatting

a3b5172

lhearachel reviewed Nov 10, 2024

View reviewed changes

lhearachel mentioned this pull request Nov 17, 2024

Summary screen documentation pt. 2 #305

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Unpack resdat and cldat files, create C headers for offsets into palette resdats #279

Unpack resdat and cldat files, create C headers for offsets into palette resdats #279

joshua-smith-12 commented Oct 25, 2024 •

edited

Loading

joshua-smith-12 Oct 25, 2024

lhearachel Oct 26, 2024

lhearachel left a comment

lhearachel Oct 26, 2024

joshua-smith-12 commented Nov 6, 2024

lhearachel left a comment

lhearachel Nov 10, 2024

lhearachel Nov 10, 2024

lhearachel Nov 10, 2024

lhearachel Nov 10, 2024

lhearachel Nov 10, 2024

lhearachel Nov 10, 2024

lhearachel Nov 10, 2024

lhearachel Nov 10, 2024

		#ifndef POKEPLATINUM_UNK_0200C6E4_H
		#define POKEPLATINUM_UNK_0200C6E4_H

Unpack resdat and cldat files, create C headers for offsets into palette resdats #279

Are you sure you want to change the base?

Unpack resdat and cldat files, create C headers for offsets into palette resdats #279

Conversation

joshua-smith-12 commented Oct 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lhearachel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joshua-smith-12 commented Nov 6, 2024

lhearachel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joshua-smith-12 commented Oct 25, 2024 •

edited

Loading