Various RAM map documentation and alignment with SA3

include/game/game.h

@@ -5,4 +5,10 @@
 
 void GameStart(void);
 
+#define GAME_SA1     1
+#define GAME_SA2     2
+#define GAME_SA3     3
+#define GAME_KATAM   4
+#define CURRENT_GAME GAME_SA2
+
 #endif // GUARD_GAME_H

include/game/parameters/characters.h

@@ -3,6 +3,8 @@
 
 #include "constants/zones.h"
 
+// TODO: Be consistent about whether these are Q() or I() values!
+
 /*** Common ***/
 #define PLAYER_FLYING_END_GRAVITY  (0.033) // = (8. / 256.)
 #define PLAYER_GRAVITY             42.0 / 256.0

include/sprite.h

@@ -93,11 +93,18 @@ typedef struct {
 } Background; /* size = 0x40 */
 
 typedef struct {
+#if (CURRENT_GAME >= GAME_SA3)
+    // In SA3 flip-bits are integrated into the oamIndex.
+    // X-Flip: Bit 14
+    // Y-Flip: Bit 15
+    /* 0x00 */ u16 oamIndex;
+#else
     /* 0x00 */ u8 flip;
 
     // every animation has an associated oamData pointer, oamIndex starts at
     // 0 for every new animation and ends at variantCount-1
     /* 0x01 */ u8 oamIndex;
+#endif
 
     // some sprite frames consist of multiple images (of the same size
     // as GBA's Object Attribute Memory, e.g. 8x8, 8x32, 32x64, ...)

ldscript.txt

@@ -39,6 +39,7 @@ SECTIONS
 
         /* engine */
         src/core.o(.data);
+        src/input_recorder.o(.data);
 
         /* "SA1 Leftovers" */
         . = ALIGN(32); 

src/core.c

@@ -35,7 +35,8 @@ u8 gNumHBlankIntrs = 0;
 struct BlendRegs gBldRegs ALIGNED(8) = {};
 u8 gOamFreeIndex = 0;
 struct Task gEmptyTask ALIGNED(16) = {};
-BgAffineReg gBgAffineRegs[NUM_AFFINE_BACKGROUNDS] ALIGNED(8) = {};
+u8 gNextFreeAffineIndex = 0;
+BgAffineReg gBgAffineRegs[NUM_AFFINE_BACKGROUNDS] = {};
 void *gVramHeapStartAddr = NULL;
 u16 gUnknown_03001944 ALIGNED(4) = 0;
 u8 gUnknown_03001948 ALIGNED(4) = 0;
@@ -124,8 +125,6 @@ FuncType_030053A0 gUnknown_030053A0[] ALIGNED(16) = {};
 const u8 *gInputPlaybackData = NULL;
 bool8 gExecSoundMain ALIGNED(4) = FALSE;
 s32 gPseudoRandom = 0;
-struct InputRecorder gInputRecorder ALIGNED(8) = {};
-u16 *gInputRecorderTapeBuffer = NULL;
 
 static void UpdateScreenDma(void);
 static void UpdateScreenCpuSet(void);
@@ -252,6 +251,9 @@ void GameInit(void)
     gBgAffineRegs[1].x = 0;
     gBgAffineRegs[1].y = 0;
 
+#if (CURRENT_GAME >= GAME_SA3)
+    gNextFreeAffineIndex = 0;
+#endif
     gUnknown_03001944 = 0;
     gUnknown_030017F0 = 0x100;
     gUnknown_03005394 = 0x100;
@@ -379,6 +381,10 @@ void GameLoop(void)
         gFlagsPreVBlank = gFlags;
         VBlankIntrWait();
 
+#if (CURRENT_GAME >= GAME_SA3)
+        gNextFreeAffineIndex = 0;
+#endif
+
         if (gFlags & FLAGS_4000) {
             UpdateScreenCpuSet();
 

src/game/math.c

@@ -27,6 +27,15 @@ u32 gRngValue = 0;
 
 const u16 gUnknown_080E0290[] = { 0x0AAA, 0x02AA };
 
+typedef struct {
+    void *unk0;
+    void *start;
+    void *next;
+    void *unkC;
+} UNK_8085DEC;
+
+bool8 sub_8085D98(UNK_8085DEC *thing, UNK_8085DEC *target);
+
 #define RAND_CONST 0x37119371;
 
 NONMATCH("asm/non_matching/game/math/unused_sub_80832FC.inc", void sub_80832FC()) { }
@@ -609,15 +618,6 @@ void sub_8085D14(UNK_8085D14 *p1, u32 p2, u32 p3, u32 p4)
     p1->unk12 = p4;
 }
 
-typedef struct {
-    void *unk0;
-    void *start;
-    void *next;
-    void *unkC;
-} UNK_8085DEC;
-
-bool8 sub_8085D98(UNK_8085DEC *thing, UNK_8085DEC *target);
-
 void sub_8085D44(UNK_8085DEC *thing)
 {
     thing->unk0 = NULL;

src/game/title_screen.c

@@ -1892,9 +1892,7 @@ static void Task_StartTitleScreenDemo(void)
     gSelectedCharacter = CHARACTER_SONIC;
     gCurrentLevel = sDemoLevels[0];
 
-    gDemoPlayCounter++;
-    // Don't count higher than 3
-    gDemoPlayCounter &= 3;
+    gDemoPlayCounter = (gDemoPlayCounter + 1) % 4u;
 
     gGameMode = GAME_MODE_SINGLE_PLAYER;
 

src/input_recorder.c

@@ -11,6 +11,9 @@
 #define TAPE_LENGTH 0x800
 #endif
 
+struct InputRecorder gInputRecorder ALIGNED(8) = { 0 };
+u16 *gInputRecorderTapeBuffer = NULL;
+
 static void Task_InputRecorder(void);
 static void InputRecorderEject(struct Task *);
 

src/multi_sio.c

@@ -1,4 +1,5 @@
 #include "global.h"
+#include "game/game.h"
 #include "multi_sio.h"
 #include "sio32_multi_load.h"
 
@@ -10,7 +11,9 @@ u32 gMultiSioIntrFuncBuf[0x120 / 4] = {}; // Interrupt Routine RAM Execution Buf
 
 struct MultiSioArea gMultiSioArea = {};
 
+#if (CURRENT_GAME <= GAME_SA2)
 UNUSED u32 gUnusedMultiSioSpace[2] = {};
+#endif
 
 #ifdef MULTI_SIO_DI_FUNC_FAST
 u32 gMultiSioRecvFuncBuf[0x40 / 4] = {}; // Receive Data/Check Buffer Change Routine RAM Execution Buffer

src/sprite.c

@@ -629,7 +629,7 @@ void DisplaySprite(Sprite *sprite)
     }
 }
 
-void sub_081569A0(Sprite *sprite, u16 *sp08, u8 sp0C)
+void DisplaySprites(Sprite *sprite, u16 *sp08, u8 sp0C)
 {
     vs32 x, y;
     s32 sprWidth, sprHeight;