Add autobuild (#1)

* add autobuilds

* track game libs

* track thumb compatiblity files

Author: Yanis002

.github/workflows/build.yml

@@ -0,0 +1,37 @@
+name: Build
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  build:
+    container: ghcr.io/yanis002/st-build:main
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        version: [eur]
+    defaults:
+      run:
+        shell: bash
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Git config
+        run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
+
+      - name: Prepare
+        run: |
+          mv /extract/* ./extract
+          mv /tools/armips/* ./tools/armips
+
+      - name: Build
+        run: |
+          COMPARE=0 make init
+          make

.gitignore

@@ -6,7 +6,7 @@ extract/eu
 extract/jp
 extract/us
 build/
-libs/*.a
+libs/libgz.a
 
 # workspace files
 *.nds

Makefile

@@ -47,6 +47,8 @@ STGZ_DECOMP_DIR ?= resources/decomp
 # game region, only eur is supported atm
 REGION := eur
 
+COMPARE ?= 1
+
 ### project tools ###
 
 MAKE = make
@@ -70,14 +72,15 @@ DSROM := tools/dsrom
 
 # armips setup
 ARMIPS_DIR := tools/armips
-ARMIPS ?= $(ARMIPS_DIR)/build/armips
+ARMIPS ?= $(ARMIPS_DIR)/out/armips
 
 # main source/objects
 BUILD_DIR := build/$(REGION)
-ASM_FILES := $(wildcard src/*.s)
-C_FILES := $(wildcard src/*.c)
-CPP_FILES := $(wildcard src/*.cpp)
-OBJ := $(foreach f,$(ASM_FILES),$(BUILD_DIR)/$(f:.s=.o)) $(foreach f,$(C_FILES),$(BUILD_DIR)/$(f:.c=.o)) $(foreach f,$(CPP_FILES),$(BUILD_DIR)/$(f:.cpp=.o)) $(BUILD_DIR)/thumb-$(REGION).o
+ALL_FILES := $(shell find src/ -path "src/thumb" -prune -o -print)
+ASM_FILES := $(filter %.s, $(ALL_FILES))
+C_FILES := $(filter %.c, $(ALL_FILES))
+CPP_FILES := $(filter %.cpp, $(ALL_FILES))
+OBJ := $(foreach f,$(ASM_FILES),$(BUILD_DIR)/$(f:.s=.o)) $(foreach f,$(C_FILES),$(BUILD_DIR)/$(f:.c=.o)) $(foreach f,$(CPP_FILES),$(BUILD_DIR)/$(f:.cpp=.o)) $(BUILD_DIR)/src/thumb/thumb-$(REGION).o
 DEPS := $(foreach f,$(ASM_FILES),$(BUILD_DIR)/$(f:.s=.d)) $(foreach f,$(C_FILES),$(BUILD_DIR)/$(f:.c=.d)) $(foreach f,$(CPP_FILES),$(BUILD_DIR)/$(f:.cpp=.d))
 
 # hooks source/objects
@@ -111,8 +114,10 @@ RESERVED_SIZE := 0x10
 RESERVED_ADDR := $(shell $(PYTHON) -c "print(f'0x{$(OVLGZ_ADDR) + $(OVLGZ_SIZE) - $(RESERVED_SIZE):08X}')")
 
 # compiler settings
-CC := arm-none-eabi-gcc -marm -mthumb-interwork -march=armv5te -mtune=arm946e-s -nostdlib -nodefaultlibs -nostartfiles
-WARNINGS := -Wall -Wno-multichar -Wno-unknown-pragmas
+CFLAGS_BASE := -marm -mthumb-interwork -march=armv5te -mtune=arm946e-s -nostdlib -nodefaultlibs -nostartfiles
+CC := arm-none-eabi-gcc $(CFLAGS_BASE)
+CXX := arm-none-eabi-g++ $(CFLAGS_BASE)
+WARNINGS := -Wall -Wno-multichar -Wno-unknown-pragmas -Wno-strict-aliasing -Wno-unused-variable
 INCLUDES := -I include -I $(STGZ_DECOMP_DIR)/include -I $(STGZ_DECOMP_DIR)/libs/c/include
 CPP_DEFINES := -DGZ_OVL_ID=114 -DPACKAGE_VERSION='$(PACKAGE_VERSION)' -DPACKAGE_NAME='$(PACKAGE_NAME)' -DPACKAGE_COMMIT_AUTHOR='$(PACKAGE_COMMIT_AUTHOR)' -DPACKAGE_AUTHOR='$(PACKAGE_AUTHOR)'
 CFLAGS := -Os -fno-short-enums -fomit-frame-pointer -ffast-math -fno-builtin -fshort-wchar -MMD -MP $(WARNINGS) $(INCLUDES) $(CPP_DEFINES)
@@ -136,8 +141,8 @@ HOOKS_GAME_BIN := $(HOOKS_GAME_ELF:.elf=.bin)
 HOOKS_GAME_MAP := $(HOOKS_GAME_ELF:.elf=.map)
 
 # create output directories
-$(shell mkdir -p $(BUILD_DIR)/src)
-$(shell mkdir -p $(HOOKS_BUILD_DIR)/src)
+$(shell $(MKDIR) -p $(BUILD_DIR)/src/thumb)
+$(shell $(MKDIR) -p $(HOOKS_BUILD_DIR)/src)
 
 ### project settings ###
 
@@ -197,9 +202,11 @@ extract:
 
 hooks: overlay $(HOOKS_BIN) $(HOOKS_GAME_BIN)
 
-init: venv libs
+init: venv
 	$(call print_no_args,Verifying baserom checksum...)
+ifeq ($(COMPARE),1)
 	$(V)sha1sum -c $(EXTRACT_DIR)/baserom_st_$(REGION).sha1
+endif
 	$(V)$(DL_TOOL) dsrom v0.6.1
 ifeq ("$(wildcard $(ARMIPS_DIR))", "")
 	$(error armips not found!)
@@ -212,7 +219,7 @@ endif
 
 libs:
 	$(call print_no_args,Generating game symbol library...)
-	$(V)$(PYTHON) tools/gen_libs.py -m libst -d $(STGZ_DECOMP_DIR) -b build
+	$(V)$(PYTHON) tools/gen_libs.py -m libst -d $(STGZ_DECOMP_DIR)
 	$(call print_no_args,Success!)
 
 overlay: $(BIN)
@@ -240,7 +247,7 @@ venv:
 
 ## process auto-generated thumb definitions (necessary to avoid crashes when calling thumb functions) ##
 
-$(BUILD_DIR)/thumb-$(REGION).o: build/thumb-$(REGION).s
+$(BUILD_DIR)/src/thumb/thumb-$(REGION).o: src/thumb/thumb-$(REGION).s
 	$(V)$(CC) $(CFLAGS) -fverbose-asm -Os -x assembler-with-cpp -fomit-frame-pointer -c "$<" -o "$@"
 
 ## process source files ##
@@ -255,15 +262,15 @@ $(BUILD_DIR)/src/%.o: src/%.c
 
 $(BUILD_DIR)/src/%.o: src/%.cpp
 	$(call print_two_args,Compiling:,$<,$@)
-	$(V)$(CC) $(CPP_FLAGS) -c "$<" -o "$@"
+	$(V)$(CXX) $(CPP_FLAGS) -c "$<" -o "$@"
 
 $(HOOKS_BUILD_DIR)/src/%.o: hooks/src/%.c
 	$(call print_two_args,Compiling hooks:,$<,$@)
 	$(V)$(CC) $(CFLAGS) -DOVERLAY_0_SLOT_ADDR=$(OVERLAY_0_SLOT_ADDR) -c "$<" -o "$@"
 
 $(HOOKS_BUILD_DIR)/src/%.o: hooks/src/%.cpp
 	$(call print_two_args,Compiling hooks:,$<,$@)
-	$(V)$(CC) $(CPP_FLAGS) -c "$<" -o "$@"
+	$(V)$(CXX) $(CPP_FLAGS) -c "$<" -o "$@"
 
 ## process build artifacts ##
 

hooks/src/game.cpp

@@ -1,17 +1,17 @@
 #include <System/OverlayManager.hpp>
 #include <System/Random.hpp>
-#include <Unknown/UnkStruct_02049a2c.hpp>
+#include <Game/Game.hpp>
 #include <Unknown/UnkStruct_02049b74.hpp>
 #include <Unknown/UnkStruct_02049bd4.hpp>
 #include <Unknown/UnkStruct_0204a110.hpp>
 #include <Unknown/UnkStruct_0204e64c.hpp>
 #include <Unknown/UnkStruct_027e0208.hpp>
 #include <regs.h>
 
-extern "C" void GZ_Main(int param1);
+extern "C" void GZ_Main();
 
-class StartUpMain : public UnkStruct_02049a2c {
-    void Run(unk32 param1);
+class StartUpMain : public Game {
+    void Run();
 };
 
 extern "C" void func_020196fc();
@@ -34,8 +34,8 @@ struct SomeSaveFileStruct {
 };
 
 // shorter version of the main loop specifically for boot time, no idea if this affects things later though...
-void StartUpMain::Run(unk32 param1) {
-    this->func_ov018_020c48a4(param1);
+void StartUpMain::Run() {
+    this->func_ov018_020c48a4();
 
     do {
         // initialization of the next game mode
@@ -76,5 +76,5 @@ void StartUpMain::Run(unk32 param1) {
         func_020132c8();
     } while (gOverlayManager.mLoadedOverlays[OverlaySlot_4] == OverlayIndex_StartUp);
 
-    GZ_Main(param1);
+    GZ_Main();
 }

hooks/src/hooks.c

@@ -5,11 +5,9 @@
  * Make sure to make it as small as possible!
  */
 
-extern void _ZN18UnkStruct_02049a2c19func_ov018_020c48f8Ev(void* ptr);
+extern void _ZN4Game19func_ov018_020c48f8Ev(void* ptr);
 extern void FS_LoadOverlay(int param1, int overlayID);
 extern void GZ_Init();
-extern void main(int param1, int param2);
-extern void GZ_Main(int param1);
 
 #ifndef __INTELLISENSE__
 #ifndef GZ_OVL_ID
@@ -28,7 +26,7 @@ extern void GZ_Main(int param1);
 
 // init hook: replace the `func_ov018_020c48f8` call from `GameModeStartUp::vfunc_0C` so we can load and init the gz overlay
 void GZ_InitHook(void* ptr) {
-    _ZN18UnkStruct_02049a2c19func_ov018_020c48f8Ev(ptr);
+    _ZN4Game19func_ov018_020c48f8Ev(ptr);
 
     // make sure overlay 0 has completed loading
     while (nOverlay0 != 0) {}

include/gz_game.hpp

@@ -1,10 +1,10 @@
 #pragma once
 
-#include <Unknown/UnkStruct_02049a2c.hpp>
+#include <Game/Game.hpp>
 
-// IMPORTANT: this should match `UnkStruct_02049a2c` exactly!
-class CustomGame : public UnkStruct_02049a2c {
+// IMPORTANT: this should match `Game` exactly!
+class CustomGame : public Game {
 public:
-    void Run(unk32 param1);
+    void Run();
     void ExecutePause();
 };

include/gz_settings.hpp

@@ -2,7 +2,7 @@
 
 #include "gz.hpp"
 
-#include <Unknown/UnkStruct_02049a2c.hpp>
+#include <Game/Game.hpp>
 #include <System/OverlayManager.hpp>
 #include <types.h>