Merge remote-tracking branch 'upstream/main' into decomp_merge

.github/workflows/build.yml

@@ -12,13 +12,13 @@ jobs:
       matrix:
         include:
           - name: "Debug, No F3DEX3"
-            args: RELEASE=0 CPP_DEFINES=-DENABLE_F3DEX3=0
+            args: DEBUG_FEATURES=1 CPP_DEFINES=-DENABLE_F3DEX3=0
           - name: "Debug, F3DEX3"
-            args: RELEASE=0 CPP_DEFINES=-DENABLE_F3DEX3=1
+            args: DEBUG_FEATURES=1 CPP_DEFINES=-DENABLE_F3DEX3=1
           - name: "Release, No F3DEX3"
-            args: RELEASE=1 CPP_DEFINES=-DENABLE_F3DEX3=0
+            args: DEBUG_FEATURES=0 CPP_DEFINES=-DENABLE_F3DEX3=0
           - name: "Release, F3DEX3"
-            args: RELEASE=1 CPP_DEFINES=-DENABLE_F3DEX3=1
+            args: DEBUG_FEATURES=0 CPP_DEFINES=-DENABLE_F3DEX3=1
     defaults:
       run:
         shell: bash

.gitignore

@@ -4,7 +4,9 @@ __pycache__/
 .DS_Store
 
 # IDE files
-.vscode/
+.vscode/*.*
+.vscode/**/.*
+!.vscode/c_cpp_properties.json
 .vs/
 .idea/
 .cache/
@@ -23,8 +25,8 @@ docs/doxygen/
 *.iso
 *.bin
 *.blend1
-F3DEX3/*.code
-F3DEX3/*.data
+F3DEX3/*/*.code
+F3DEX3/*/*.data
 wadextract/
 isoextract/
 

.make_hackeroot.mk

@@ -1,49 +1,238 @@
-# Set prefix to mips binutils binaries (mips-linux-gnu-ld => 'mips-linux-gnu-') - Change at your own risk!
-# In nearly all cases, not having 'mips-linux-gnu-*' binaries on the PATH is indicative of missing dependencies
+#### Compiling ####
 
 # Returns the path to the command $(1) if exists. Otherwise returns an empty string.
 find-command = $(shell which $(1) 2>/dev/null)
 
+# Set prefix to mips binutils binaries (mips-linux-gnu-ld => 'mips-linux-gnu-') - Change at your own risk!
+# In nearly all cases, not having 'mips-linux-gnu-*' binaries on the PATH is indicative of missing dependencies
 ifneq ($(call find-command,mips-n64-ld),)
-  MIPS_BINUTILS_PREFIX := mips-n64-
+	MIPS_BINUTILS_PREFIX := mips-n64-
 else ifneq ($(call find-command,mips64-ld),)
-  MIPS_BINUTILS_PREFIX := mips64-
+	MIPS_BINUTILS_PREFIX := mips64-
 else ifneq ($(call find-command,mips-linux-gnu-ld),)
-  MIPS_BINUTILS_PREFIX := mips-linux-gnu-
+	MIPS_BINUTILS_PREFIX := mips-linux-gnu-
 else ifneq ($(call find-command,mips64-linux-gnu-ld),)
-  MIPS_BINUTILS_PREFIX := mips64-linux-gnu-
+	MIPS_BINUTILS_PREFIX := mips64-linux-gnu-
 else ifneq ($(call find-command,mips-ld),)
-  MIPS_BINUTILS_PREFIX := mips-
+	MIPS_BINUTILS_PREFIX := mips-
 else ifneq ($(call find-command,mips64-elf-ld),)
-  MIPS_BINUTILS_PREFIX := mips64-elf-
+	MIPS_BINUTILS_PREFIX := mips64-elf-
 else
-  $(error Unable to detect a suitable MIPS toolchain installed)
+	$(error Unable to detect a suitable MIPS toolchain installed)
 endif
 
 -include tools/print_rules.mk
 
-# Enable optimization flags to use GDB on Ares
-ARES_GDB := 1
-
-# Toggle release or debug mode. 1=Release, 0=Debug
-# Note: currently only used for HackerOoT
-RELEASE := 0
-
 # Valid compression algorithms are 'yaz', 'gzip', 'lzo' and 'aplib'
+# Default value: `yaz`
 COMPRESSION ?= yaz
 COMPRESSION_TYPE ?= $(shell echo $(COMPRESSION) | tr '[:lower:]' '[:upper:]')
 
 # Platform compatibility flags
+# Default value: (nothing)
 TARGET ?=
-
 ifeq ($(TARGET),wad)
-CFLAGS := -DCONSOLE_WIIVC -fno-reorder-blocks -fno-optimize-sibling-calls
-CPPFLAGS := -DCONSOLE_WIIVC
+CFLAGS := -fno-reorder-blocks -fno-optimize-sibling-calls
+CPP_DEFINES := -DCONSOLE_WIIVC
+REVISION := 0
+REVISION := 0
 else ifeq ($(TARGET),iso)
-CFLAGS := -DCONSOLE_GC -fno-reorder-blocks -fno-optimize-sibling-calls
-CPPFLAGS := -DCONSOLE_GC
+CFLAGS := -fno-reorder-blocks -fno-optimize-sibling-calls
+CPP_DEFINES := -DCONSOLE_GC
+else
+REVISION := 15
 endif
 
+# Set PACKAGE_NAME define for printing commit name
+ifeq ($(origin PACKAGE_NAME), undefined)
+  PACKAGE_NAME := "$(shell git log -1 --pretty=%s | tr -d '()`"\n' | tr -d "'" | sed 's/\"/\\\"/g')"
+  ifeq ($(PACKAGE_NAME),"")
+    PACKAGE_NAME := "Unknown name"
+  endif
+endif
+
+# Set PACKAGE_COMMIT_AUTHOR for printing commit author
+ifeq ($(origin PACKAGE_COMMIT_AUTHOR), undefined)
+  PACKAGE_COMMIT_AUTHOR := "$(shell git log -1 --pretty=format:'%an' | tr -d '\n' | sed 's/\"/\\\"/g')"
+  ifeq ($(PACKAGE_COMMIT_AUTHOR),"")
+    PACKAGE_COMMIT_AUTHOR := "Unknown author"
+  endif
+endif
+
+# Set PACKAGE_AUTHOR define for printing author's git name
+ifeq ($(origin PACKAGE_AUTHOR), undefined)
+  PACKAGE_AUTHOR := "$(shell git config --get user.name | tr -d '\n' | sed 's/\"/\\\"/g')"
+  ifeq ($(PACKAGE_AUTHOR),"")
+    PACKAGE_AUTHOR := "Unknown author"
+  endif
+endif
+
+# Set PACKAGE_VERSION define for printing commit hash
+ifeq ($(origin PACKAGE_VERSION), undefined)
+  PACKAGE_VERSION := "$(shell git log -1 --pretty=%h | tr -d '\n' | sed 's/\"/\\\"/g')"
+  ifeq ($(PACKAGE_VERSION),"")
+    PACKAGE_VERSION := "Unknown version"
+  endif
+endif
+
+# Define author and package version for every OoT version
+CPP_DEFINES += -DCOMPRESS_$(COMPRESSION_TYPE)=1 -DPACKAGE_VERSION='$(PACKAGE_VERSION)' -DPACKAGE_NAME='$(PACKAGE_NAME)' -DPACKAGE_COMMIT_AUTHOR='$(PACKAGE_COMMIT_AUTHOR)' -DPACKAGE_AUTHOR='$(PACKAGE_AUTHOR)'
+
+# F3DZEX2 offsets
+ifeq ($(VERSION),ntsc-1.0)
+# 0xB59ED0, 0x1390
+	UCODE_CODE_OFFSET := 11902672
+	UCODE_CODE_SIZE := 5008
+# 0xB8A520, 0x420
+	UCODE_DATA_OFFSET := 12100896
+	UCODE_DATA_SIZE := 1056
+else ifeq ($(VERSION),ntsc-1.1)
+# 0xB5A090, 0x1390
+	UCODE_CODE_OFFSET := 11903120
+	UCODE_CODE_SIZE := 5008
+# 0xB8A6E0, 0x420
+	UCODE_DATA_OFFSET := 12101344
+	UCODE_DATA_SIZE := 1056
+else ifeq ($(VERSION),ntsc-1.2)
+# 0xB59ED0, 0x1390
+	UCODE_CODE_OFFSET := 11902672
+	UCODE_CODE_SIZE := 5008
+# 0xB8A590, 0x420
+	UCODE_DATA_OFFSET := 12101008
+	UCODE_DATA_SIZE := 1056
+else ifeq ($(VERSION),gc-eu-mq-dbg)
+# 0xBCD0F0, 0x1630
+	UCODE_CODE_OFFSET := 12374256
+	UCODE_CODE_SIZE := 5680
+# 0xBCE720, 0x420
+	UCODE_DATA_OFFSET := 12379936
+	UCODE_DATA_SIZE := 1056
+else
+$(error Unsupported version for F3DEX3: $(VERSION))
+endif
+
+# F3DEX3 directory
+ifeq ($(PLATFORM),GC)
+F3DEX3_BASE_DIR := gc
+else
+F3DEX3_BASE_DIR := n64
+endif
+F3DEX3_DIR = F3DEX3/$(F3DEX3_BASE_DIR)
+
+#### Tools ####
+
+FLIPS      := tools/Flips/flips
+GZINJECT   := tools/gzinject/gzinject
+
+# Temporary measure to avoid issues on ISO builds (same for `CFLAGS_IDO`).
+# The real fix would be having the proper fixes in the N64 emulator itself
+# but this requires some time to figure it out.
+CC_IDO     := tools/ido_recomp/$(DETECTED_OS)/5.3/cc
+
+#### Files ####
+
+# Config file used for building ISOs.
+DMA_CONFIG_FILE := dma_config.txt
+
+# Baserom to use when creating BPS patches
+BASEROM_PATCH ?= baseroms/$(VERSION)/baserom.z64
+
+#### Build Rules ####
+
+# Build the codebase to inject in a WAD file (for Wii VC)
+# Steps:
+#		- check if there's the common-key.bin file
+#		- build and compress the rom
+#		- inject the binary in the wad file (and apply patches)
+#		- remove temporary folders
+wad:
+	$(call print_no_args,Patching WAD...)
+ifeq ("$(wildcard baseroms/$(VERSION)/common-key.bin)", "")
+	$(error Please provide the common-key.bin file.)
+endif
+	$(V)$(MAKE) compress TARGET=wad
+	$(V)$(GZINJECT) -a inject -r 1 -k baseroms/$(VERSION)/common-key.bin -w baseroms/$(VERSION)/basewad.wad -m $(ROMC) -o $(WAD) -t "HackerOoT" -i NHOE -p tools/gzinject/patches/NACE.gzi -p tools/gzinject/patches/gz_default_remap.gzi
+	$(V)$(RM) -r wadextract/
+	$(call print_no_args,Success!)
+
+# Build the codebase to inject in a ISO file (for GameCube)
+# Steps:
+#		- build and compress the rom
+#		- create the dma config file
+#		- extract the iso
+#		- copy the rom and dma config file to the extracted iso folder
+#		- remove any unnecessary files
+#		- apply the modifications on the emulator binary
+#		- pack the iso
+#		- remove temporary folders
+iso:
+	$(V)$(MAKE) compress TARGET=iso
+	$(call print_no_args,Patching ISO...)
+	$(V)$(PYTHON) tools/gc_utility.py -v $(VERSION) -c $(COMPRESSION)
+	$(V)$(GZINJECT) -a extract -s baseroms/$(VERSION)/baseiso.iso
+	$(V)cp $(BUILD_DIR)/$(DMA_CONFIG_FILE) isoextract/zlj_f.tgc/$(DMA_CONFIG_FILE)
+	$(V)cp $(ROMC) isoextract/zlj_f.tgc/zlj_f.n64
+	$(V)$(RM) -r isoextract/S_*.tgc/ isoextract/zlj_f.tgc/*.thp
+	$(V)$(FLIPS) --apply tools/gamecube.bps isoextract/zlj_f.tgc/main.dol isoextract/zlj_f.tgc/main.dol
+	$(V)$(GZINJECT) -a pack -s $(ISO)
+	$(V)$(RM) -r isoextract/
+	$(call print_no_args,Success!)
+
+# Create a BPS patch for the built rom
+# Steps:
+#		- run Flips and create the patch
+# TODO: add compressed rom support.
+patch:
+	$(call print_no_args,Creating BPS patch...)
+	$(V)$(FLIPS) --create --bps $(BASEROM_PATCH) $(ROM) $(BPS)
+	$(call print_no_args,Success!)
+
+# Create F3DEX3 bps patches
+# Steps:
+#		- run Flips and create the patches
+create_f3dex3_patches: F3DEX3/f3dzex2.code F3DEX3/f3dzex2.data
+	$(call print_no_args,Creating F3DEX3 patches...)
+	$(V)$(FLIPS) --create --bps $(F3DEX3_DIR)/f3dzex2.code $(F3DEX3_DIR)/F3DEX3_BrW.code $(F3DEX3_DIR)/F3DEX3_BrW.code.bps
+	$(V)$(FLIPS) --create --bps $(F3DEX3_DIR)/f3dzex2.data $(F3DEX3_DIR)/F3DEX3_BrW.data $(F3DEX3_DIR)/F3DEX3_BrW.data.bps
+	$(V)$(FLIPS) --create --bps $(F3DEX3_DIR)/f3dzex2.code $(F3DEX3_DIR)/F3DEX3_BrW_PA.code $(F3DEX3_DIR)/F3DEX3_BrW_PA.code.bps
+	$(V)$(FLIPS) --create --bps $(F3DEX3_DIR)/f3dzex2.data $(F3DEX3_DIR)/F3DEX3_BrW_PA.data $(F3DEX3_DIR)/F3DEX3_BrW_PA.data.bps
+	$(V)$(FLIPS) --create --bps $(F3DEX3_DIR)/f3dzex2.code $(F3DEX3_DIR)/F3DEX3_BrW_PB.code $(F3DEX3_DIR)/F3DEX3_BrW_PB.code.bps
+	$(V)$(FLIPS) --create --bps $(F3DEX3_DIR)/f3dzex2.data $(F3DEX3_DIR)/F3DEX3_BrW_PB.data $(F3DEX3_DIR)/F3DEX3_BrW_PB.data.bps
+	$(V)$(FLIPS) --create --bps $(F3DEX3_DIR)/f3dzex2.code $(F3DEX3_DIR)/F3DEX3_BrW_PC.code $(F3DEX3_DIR)/F3DEX3_BrW_PC.code.bps
+	$(V)$(FLIPS) --create --bps $(F3DEX3_DIR)/f3dzex2.data $(F3DEX3_DIR)/F3DEX3_BrW_PC.data $(F3DEX3_DIR)/F3DEX3_BrW_PC.data.bps
+	$(V)$(FLIPS) --create --bps $(F3DEX3_DIR)/f3dzex2.code $(F3DEX3_DIR)/F3DEX3_BrW_NOC.code $(F3DEX3_DIR)/F3DEX3_BrW_NOC.code.bps
+	$(V)$(FLIPS) --create --bps $(F3DEX3_DIR)/f3dzex2.data $(F3DEX3_DIR)/F3DEX3_BrW_NOC.data $(F3DEX3_DIR)/F3DEX3_BrW_NOC.data.bps
+	$(V)$(FLIPS) --create --bps $(F3DEX3_DIR)/f3dzex2.code $(F3DEX3_DIR)/F3DEX3_BrW_NOC_PA.code $(F3DEX3_DIR)/F3DEX3_BrW_NOC_PA.code.bps
+	$(V)$(FLIPS) --create --bps $(F3DEX3_DIR)/f3dzex2.data $(F3DEX3_DIR)/F3DEX3_BrW_NOC_PA.data $(F3DEX3_DIR)/F3DEX3_BrW_NOC_PA.data.bps
+	$(V)$(FLIPS) --create --bps $(F3DEX3_DIR)/f3dzex2.code $(F3DEX3_DIR)/F3DEX3_BrW_NOC_PB.code $(F3DEX3_DIR)/F3DEX3_BrW_NOC_PB.code.bps
+	$(V)$(FLIPS) --create --bps $(F3DEX3_DIR)/f3dzex2.data $(F3DEX3_DIR)/F3DEX3_BrW_NOC_PB.data $(F3DEX3_DIR)/F3DEX3_BrW_NOC_PB.data.bps
+	$(V)$(FLIPS) --create --bps $(F3DEX3_DIR)/f3dzex2.code $(F3DEX3_DIR)/F3DEX3_BrW_NOC_PC.code $(F3DEX3_DIR)/F3DEX3_BrW_NOC_PC.code.bps
+	$(V)$(FLIPS) --create --bps $(F3DEX3_DIR)/f3dzex2.data $(F3DEX3_DIR)/F3DEX3_BrW_NOC_PC.data $(F3DEX3_DIR)/F3DEX3_BrW_NOC_PC.data.bps
+	$(call print_no_args,Success!)
+
+# Build the rom and print its checksum (using md5)
+# Steps:
+#		- run `make clean`
+#		- build the rom
+#		- show the checksum
+verify:
+	$(V)$(MAKE) clean
+	$(V)$(MAKE) rom
+	@md5sum $(ROM)
+
+.PHONY: wad iso patch create_f3dex3_patches verify
+
+$(F3DEX3_DIR)/f3dzex2.code:
+	$(V)dd bs=1 if=$(BASEROM_DIR)/baserom-decompressed.z64 of=$@ skip=$(UCODE_CODE_OFFSET) count=$(UCODE_CODE_SIZE) status=none
+
+$(F3DEX3_DIR)/f3dzex2.data:
+	$(V)dd bs=1 if=$(BASEROM_DIR)/baserom-decompressed.z64 of=$@ skip=$(UCODE_DATA_OFFSET) count=$(UCODE_DATA_SIZE) status=none
+
+$(F3DEX3_DIR)/F3DEX3%.code: $(F3DEX3_DIR)/F3DEX3%.code.bps $(F3DEX3_DIR)/f3dzex2.code
+	$(V)$(FLIPS) --apply $(F3DEX3_DIR)/F3DEX3$*.code.bps $(F3DEX3_DIR)/f3dzex2.code $@
+	
+$(F3DEX3_DIR)/F3DEX3%.data: $(F3DEX3_DIR)/F3DEX3%.data.bps $(F3DEX3_DIR)/f3dzex2.data
+	$(V)$(FLIPS) --apply $(F3DEX3_DIR)/F3DEX3$*.data.bps $(F3DEX3_DIR)/f3dzex2.data $@
 ### SummerCart64 Settings ###
 
 # path to the deployer program

.vscode/c_cpp_properties.json

@@ -1,7 +1,7 @@
 {
     "configurations": [
         {
-            "name": "oot-ntsc-1.2",
+            "name": "hackeroot-ntsc-1.2",
             "compilerArgs": [
                 "-m32"
             ],
@@ -19,17 +19,14 @@
                 "OOT_REGION=REGION_JP",
                 "PLATFORM_N64=1",
                 "PLATFORM_GC=0",
-                "DEBUG_FEATURES=0",
+                "DEBUG_FEATURES=1",
                 "NDEBUG",
-                "F3DEX_GBI_2",
-                "ENABLE_HACKEROOT=1",
-                "RELEASE_ROM=0",
-                "COMPRESS_YAZ=1"
+                "F3DEX_GBI_2"
             ],
             "cStandard": "gnu89"
         },
         {
-            "name": "oot-gc-jp",
+            "name": "hackeroot-gc-jp",
             "compilerArgs": [
                 "-m32"
             ],
@@ -56,7 +53,7 @@
             "cStandard": "gnu89"
         },
         {
-            "name": "oot-gc-jp-mq",
+            "name": "hackeroot-gc-jp-mq",
             "compilerArgs": [
                 "-m32"
             ],
@@ -83,7 +80,7 @@
             "cStandard": "gnu89"
         },
         {
-            "name": "oot-gc-us",
+            "name": "hackeroot-gc-us",
             "compilerArgs": [
                 "-m32"
             ],
@@ -110,7 +107,7 @@
             "cStandard": "gnu89"
         },
         {
-            "name": "oot-gc-us-mq",
+            "name": "hackeroot-gc-us-mq",
             "compilerArgs": [
                 "-m32"
             ],
@@ -137,7 +134,7 @@
             "cStandard": "gnu89"
         },
         {
-            "name": "oot-gc-eu-mq-dbg",
+            "name": "hackeroot-gc-eu-mq-dbg",
             "compilerArgs": [
                 "-m32"
             ],
@@ -164,7 +161,7 @@
             "cStandard": "gnu89"
         },
         {
-            "name": "oot-gc-eu",
+            "name": "hackeroot-gc-eu",
             "compilerArgs": [
                 "-m32"
             ],
@@ -191,7 +188,7 @@
             "cStandard": "gnu89"
         },
         {
-            "name": "oot-gc-eu-mq",
+            "name": "hackeroot-gc-eu-mq",
             "compilerArgs": [
                 "-m32"
             ],
@@ -218,7 +215,7 @@
             "cStandard": "gnu89"
         },
         {
-            "name": "oot-gc-jp-ce",
+            "name": "hackeroot-gc-jp-ce",
             "compilerArgs": [
                 "-m32"
             ],
@@ -243,36 +240,6 @@
                 "GBI_DOWHILE"
             ],
             "cStandard": "gnu89"
-        },
-        {
-            "name": "hackeroot",
-            "compilerArgs": [
-                "-m32"
-            ],
-            "includePath": [
-                "include",
-                "include/libc",
-                "src",
-                "build/hackeroot-mq",
-                ".",
-                "extracted/hackeroot-mq"
-            ],
-            "defines": [
-                "_LANGUAGE_C",
-                "OOT_VERSION=OOT_GC_EU_MQ_DBG",
-                "OOT_REGION=REGION_EU",
-                "PLATFORM_N64=0",
-                "PLATFORM_GC=1",
-                "DEBUG_FEATURES=1",
-                "NDEBUG",
-                "F3DEX_GBI_2",
-                "F3DEX_GBI_PL",
-                "GBI_DOWHILE",
-                "ENABLE_HACKEROOT=1",
-                "RELEASE_ROM=0",
-                "COMPRESS_YAZ=1"
-            ],
-            "cStandard": "gnu89"
         }
     ],
     "version": 4

.vscode/settings.json

@@ -1,19 +0,0 @@
-{
-    "search.useIgnoreFiles": false,
-    "search.exclude": {
-        "**/.git": true,
-        ".venv/**": true,
-        "baseroms/**": true,
-        "build/**": true,
-        "expected/**": true,
-    },
-    "files.associations": {
-        "*.c": "c",
-        "*.h": "c",
-        "*.inc": "c",
-        "*.inc.c": "c",
-    },
-    "editor.rulers": [
-        120
-    ],
-}