Version 1.5.0

.github/pull_request_template.md

@@ -3,6 +3,14 @@
 ## Description
 <!--- Describe your changes in detail -->
 
+## Images
+<!-- Please provide with relevant GIFs or images to make it easier for reviewers to accept your PR quicker.-->
+<!-- If it doesn't apply, feel free to remove this section. -->
+
+## Issue(s) that this PR fixes
+<!-- Format: "Fixes #2345, fixes #4523, fixes #2222." -->
+<!-- If it doesn't apply, feel free to remove this section. -->
+
 ## **Discord contact info**
-<!--- formatted as name#numbers, e.g. PikalaxALT#5823 -->
-<!--- Contributors must join https://discord.gg/d5dubZ3 -->
+<!--- formatted as name#numbers, e.g. Lunos#4026 -->
+<!--- Contributors must join https://discord.gg/6CzjAG6GZk -->

.github/workflows/build.yml

@@ -50,6 +50,8 @@ jobs:
         run: make -j${nproc} -O all
 
       - name: Test
+        env:
+          TEST: 1
         run: |
           make -j${nproc} -O pokeemerald-test.elf
           make -j${nproc} check

Makefile

@@ -41,11 +41,16 @@ GAME_CODE   := BPEE
 MAKER_CODE  := 01
 REVISION    := 0
 MODERN      ?= 0
+TEST        ?= 0
 
 ifeq (modern,$(MAKECMDGOALS))
   MODERN := 1
 endif
 
+ifeq (check,$(MAKECMDGOALS))
+  TEST := 1
+endif
+
 # use arm-none-eabi-cpp for macOS
 # as macOS's default compiler is clang
 # and clang's preprocessor will warn on \u
@@ -79,6 +84,7 @@ ELF = $(ROM:.gba=.elf)
 MAP = $(ROM:.gba=.map)
 SYM = $(ROM:.gba=.sym)
 
+TEST_OBJ_DIR_NAME := build/test
 TESTELF = $(ROM:.gba=-test.elf)
 HEADLESSELF = $(ROM:.gba=-test-headless.elf)
 
@@ -119,7 +125,15 @@ LIBPATH := -L "$(dir $(shell $(PATH_MODERNCC) -mthumb -print-file-name=libgcc.a)
 LIB := $(LIBPATH) -lc -lnosys -lgcc -L../../libagbsyscall -lagbsyscall
 endif
 
-CPPFLAGS := -iquote include -iquote $(GFLIB_SUBDIR) -Wno-trigraphs -DMODERN=$(MODERN)
+ifeq ($(TESTELF),$(MAKECMDGOALS))
+  TEST := 1
+endif
+
+ifeq ($(TEST),1)
+OBJ_DIR := $(TEST_OBJ_DIR_NAME)
+endif
+
+CPPFLAGS := -iquote include -iquote $(GFLIB_SUBDIR) -Wno-trigraphs -DMODERN=$(MODERN) -DTESTING=$(TEST)
 ifneq ($(MODERN),1)
 CPPFLAGS += -I tools/agbcc/include -I tools/agbcc -nostdinc -undef
 endif
@@ -142,6 +156,7 @@ ROMTESTHYDRA := tools/mgba-rom-test-hydra/mgba-rom-test-hydra$(EXE)
 
 PERL := perl
 
+# Inclusive list. If you don't want a tool to be built, don't add it here.
 TOOLDIRS := tools/aif2pcm tools/bin2c tools/gbafix tools/gbagfx tools/jsonproc tools/mapjson tools/mid2agb tools/preproc tools/ramscrgen tools/rsfont tools/scaninc
 CHECKTOOLDIRS = tools/patchelf tools/mgba-rom-test-hydra
 TOOLBASE = $(TOOLDIRS:tools/%=%)
@@ -167,7 +182,7 @@ infoshell = $(foreach line, $(shell $1 | sed "s/ /__SPACE__/g"), $(info $(subst
 # Disable dependency scanning for clean/tidy/tools
 # Use a separate minimal makefile for speed
 # Since we don't need to reload most of this makefile
-ifeq (,$(filter-out all rom compare modern check libagbsyscall syms,$(MAKECMDGOALS)))
+ifeq (,$(filter-out all rom compare modern check libagbsyscall syms $(TESTELF),$(MAKECMDGOALS)))
 $(call infoshell, $(MAKE) -f make_tools.mk)
 else
 NODEP ?= 1
@@ -177,9 +192,9 @@ endif
 ifeq (,$(MAKECMDGOALS))
   SCAN_DEPS ?= 1
 else
-  # clean, tidy, tools, check-tools, mostlyclean, clean-tools, clean-check-tools, $(TOOLDIRS), $(CHECKTOOLDIRS), tidymodern, tidynonmodern don't even build the ROM
+  # clean, tidy, tools, check-tools, mostlyclean, clean-tools, clean-check-tools, $(TOOLDIRS), $(CHECKTOOLDIRS), tidymodern, tidynonmodern, tidycheck don't even build the ROM
   # libagbsyscall does its own thing
-  ifeq (,$(filter-out clean tidy tools mostlyclean clean-tools $(TOOLDIRS) clean-check-tools $(CHECKTOOLDIRS) tidymodern tidynonmodern libagbsyscall,$(MAKECMDGOALS)))
+  ifeq (,$(filter-out clean tidy tools mostlyclean clean-tools $(TOOLDIRS) clean-check-tools $(CHECKTOOLDIRS) tidymodern tidynonmodern tidycheck libagbsyscall,$(MAKECMDGOALS)))
     SCAN_DEPS ?= 0
   else
     SCAN_DEPS ?= 1
@@ -256,7 +271,7 @@ clean-tools:
 clean-check-tools:
 	@$(foreach tooldir,$(CHECKTOOLDIRS),$(MAKE) clean -C $(tooldir);)
 
-mostlyclean: tidynonmodern tidymodern
+mostlyclean: tidynonmodern tidymodern tidycheck
 	rm -f $(SAMPLE_SUBDIR)/*.bin
 	rm -f $(CRY_SUBDIR)/*.bin
 	rm -f $(MID_SUBDIR)/*.s
@@ -267,7 +282,7 @@ mostlyclean: tidynonmodern tidymodern
 	rm -f $(AUTO_GEN_TARGETS)
 	@$(MAKE) clean -C libagbsyscall
 
-tidy: tidynonmodern tidymodern
+tidy: tidynonmodern tidymodern tidycheck
 
 tidynonmodern:
 	rm -f $(ROM_NAME) $(ELF_NAME) $(MAP_NAME)
@@ -277,6 +292,10 @@ tidymodern:
 	rm -f $(MODERN_ROM_NAME) $(MODERN_ELF_NAME) $(MODERN_MAP_NAME)
 	rm -rf $(MODERN_OBJ_DIR_NAME)
 
+tidycheck:
+	rm -f $(TESTELF) $(HEADLESSELF)
+	rm -rf $(TEST_OBJ_DIR_NAME)
+
 ifneq ($(MODERN),0)
 $(C_BUILDDIR)/berry_crush.o: override CFLAGS += -Wno-address-of-packed-member
 endif
@@ -464,7 +483,7 @@ LD_SCRIPT_TEST := ld_script_test.txt
 $(OBJ_DIR)/ld_script_test.ld: $(LD_SCRIPT_TEST) $(LD_SCRIPT_DEPS)
 	cd $(OBJ_DIR) && sed "s#tools/#../../tools/#g" ../../$(LD_SCRIPT_TEST) > ld_script_test.ld
 
-$(TESTELF): $(OBJ_DIR)/ld_script_test.ld $(OBJS) $(TEST_OBJS) libagbsyscall check-tools
+$(TESTELF): $(OBJ_DIR)/ld_script_test.ld $(OBJS) $(TEST_OBJS) libagbsyscall tools check-tools
 	@echo "cd $(OBJ_DIR) && $(LD) -T ld_script_test.ld -o ../../$@ <objects> <test-objects> <lib>"
 	@cd $(OBJ_DIR) && $(LD) $(TESTLDFLAGS) -T ld_script_test.ld -o ../../$@ $(OBJS_REL) $(TEST_OBJS_REL) $(LIB)
 	$(FIX) $@ -t"$(TITLE)" -c$(GAME_CODE) -m$(MAKER_CODE) -r$(REVISION) --silent
@@ -479,7 +498,7 @@ endif
 check: $(TESTELF)
 	@cp $< $(HEADLESSELF)
 	$(PATCHELF) $(HEADLESSELF) gTestRunnerHeadless '\x01' gTestRunnerSkipIsFail "$(TEST_SKIP_IS_FAIL)"
-	$(ROMTESTHYDRA) $(ROMTEST) $(HEADLESSELF)
+	$(ROMTESTHYDRA) $(ROMTEST) $(OBJCOPY) $(HEADLESSELF)
 
 libagbsyscall:
 	@$(MAKE) -C libagbsyscall TOOLCHAIN=$(TOOLCHAIN) MODERN=$(MODERN)

asm/macros/battle_anim_script.inc

@@ -270,7 +270,7 @@
 	.macro stopsound
 	.byte 0x2f
 	.endm
-	
+
 	@ same as createvisualtask except takes in battlerargindex, which is the battle anim arg index of the battler to loop through
 	.macro createvisualtaskontargets addr:req, priority:req, battlerargindex:req, argv:vararg
 	.byte 0x30
@@ -282,7 +282,7 @@
 	.2byte \argv
 .Lcreatetask_\@_2:
 	.endm
-	
+
 	@ same as createsprite except takes in battlerargindex, which is the battle anim arg index of the battler to loop through
 	.macro createspriteontargets template:req, anim_battler:req, subpriority_offset:req, battlerargindex:req, argv:vararg
 	.byte 0x31
@@ -298,7 +298,7 @@
 	.2byte \argv
 .Lsprite_\@_2:
 	.endm
-	
+
 	@ does not overwrite gBattleAnimArgs[battlerargindex], some sprite templates are too dependent on the value (e.g. heal block)
 	.macro createspriteontargets_onpos template:req, anim_battler:req, subpriority_offset:req, battlerargindex:req, argv:vararg
 	.byte 0x32
@@ -332,57 +332,3 @@
 	createvisualtask AnimTask_IsDoubleBattle, 0
 	jumprettrue \ptr
 	.endm
-
-@ keep CFRU macros cause I'm lazy. todo: update to createsprite and createvisualtask, respectively
-.macro launchtemplate launchtemplatePtr launchtemplatePriority launchtemplateArgsNo launchtemplatearg0 launchtemplatearg1 launchtemplatearg2 launchtemplatearg3 launchtemplatearg4 launchtemplatearg5 launchtemplatearg6 launchtemplatearg7 launchtemplatearg8
-	.byte 0x2
-	.word \launchtemplatePtr
-	.byte \launchtemplatePriority
-	.byte \launchtemplateArgsNo
-	.hword \launchtemplatearg0
-	.hword \launchtemplatearg1
-	.hword \launchtemplatearg2
-	.hword \launchtemplatearg3
-	.hword \launchtemplatearg4
-	.hword \launchtemplatearg5
-	.hword \launchtemplatearg6
-	.hword \launchtemplatearg7
-	.hword \launchtemplatearg8
-	.endm
-
-.macro launchtask launchtaskPtr launchtaskPriority launchtaskArgsNo launchtaskarg0 launchtaskarg1 launchtaskarg2 launchtaskarg3 launchtaskarg4 launchtaskarg5 launchtaskarg6 launchtaskarg7 launchtaskarg8
-	.byte 0x3
-	.word \launchtaskPtr
-	.byte \launchtaskPriority
-	.byte \launchtaskArgsNo
-	.hword \launchtaskarg0
-	.hword \launchtaskarg1
-	.hword \launchtaskarg2
-	.hword \launchtaskarg3
-	.hword \launchtaskarg4
-	.hword \launchtaskarg5
-	.hword \launchtaskarg6
-	.hword \launchtaskarg7
-	.hword \launchtaskarg8
-	.endm
-
-.macro setblends setblends_value
-	.byte 0xC
-	.hword \setblends_value
-	.endm
-
-.macro launchsoundtask launchsoundtaskPtr launchsoundtaskArgsNo launchsoundtaskarg0 launchsoundtaskarg1 launchsoundtaskarg2 launchsoundtaskarg3 launchsoundtaskarg4 launchsoundtaskarg5 launchsoundtaskarg6 launchsoundtaskarg7 launchsoundtaskarg8
-	.byte 0x1F
-	.word \launchsoundtaskPtr
-	.byte \launchsoundtaskArgsNo
-	.hword \launchsoundtaskarg0
-	.hword \launchsoundtaskarg1
-	.hword \launchsoundtaskarg2
-	.hword \launchsoundtaskarg3
-	.hword \launchsoundtaskarg4
-	.hword \launchsoundtaskarg5
-	.hword \launchsoundtaskarg6
-	.hword \launchsoundtaskarg7
-	.hword \launchsoundtaskarg8
-	.endm
-