2020-08-23 17:43:26 +00:00
MAKEFLAGS += --no-builtin-rules
2020-03-17 04:31:30 +00:00
2022-04-30 23:03:22 +00:00
# Ensure the build fails if a piped command fails
SHELL = /bin/bash
.SHELLFLAGS = -o pipefail -c
2020-07-19 19:42:05 +00:00
# Build options can either be changed by modifying the makefile, or by building with 'make SETTING=value'
# If COMPARE is 1, check the output md5sum after building
2023-12-16 21:45:02 +00:00
COMPARE := 1
2020-07-19 19:42:05 +00:00
# If NON_MATCHING is 1, define the NON_MATCHING C flag when building
2023-12-16 21:45:02 +00:00
NON_MATCHING := 0
2020-08-22 23:06:52 +00:00
# If ORIG_COMPILER is 1, compile with QEMU_IRIX and the original compiler
2023-12-16 21:45:02 +00:00
ORIG_COMPILER := 0
2022-02-19 21:50:56 +00:00
# If COMPILER is "gcc", compile with GCC instead of IDO.
2023-12-16 21:45:02 +00:00
COMPILER := ido
2024-04-20 04:12:26 +00:00
# Target game version. Currently the following versions are supported:
# gc-eu-mq GameCube Europe/PAL Master Quest
2024-01-05 22:27:19 +00:00
# gc-eu-mq-dbg GameCube Europe/PAL Master Quest Debug (default)
2024-01-28 17:09:03 +00:00
# The following versions are work-in-progress and not yet matching:
2024-04-15 17:36:29 +00:00
# gc-eu GameCube Europe/PAL
2024-01-05 22:27:19 +00:00
VERSION := gc-eu-mq-dbg
2024-01-24 18:00:10 +00:00
# Number of threads to extract and compress with
N_THREADS := $( shell nproc)
2024-02-01 20:08:45 +00:00
# Check code syntax with host compiler
RUN_CC_CHECK := 1
2022-02-19 21:50:56 +00:00
CFLAGS ?=
CPPFLAGS ?=
2024-06-20 22:26:01 +00:00
CPP_DEFINES ?=
2022-02-19 21:50:56 +00:00
# ORIG_COMPILER cannot be combined with a non-IDO compiler. Check for this case and error out if found.
i f n e q ( $( COMPILER ) , i d o )
ifeq ( $( ORIG_COMPILER) ,1)
$( error ORIG_COMPILER can only be used with the IDO compiler. Please check your Makefile variables and try again)
endif
e n d i f
i f e q ( $( COMPILER ) , g c c )
2024-06-20 22:26:01 +00:00
CPP_DEFINES += -DCOMPILER_GCC
2022-02-19 21:50:56 +00:00
NON_MATCHING := 1
e n d i f
2020-07-19 19:42:05 +00:00
2022-01-19 23:57:39 +00:00
# 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
2023-12-16 21:45:02 +00:00
MIPS_BINUTILS_PREFIX := mips-linux-gnu-
2022-01-19 23:57:39 +00:00
2020-07-19 19:42:05 +00:00
i f e q ( $( NON_MATCHING ) , 1 )
2024-06-20 22:26:01 +00:00
CPP_DEFINES += -DNON_MATCHING -DAVOID_UB
2020-07-19 19:42:05 +00:00
COMPARE := 0
e n d i f
2024-01-05 22:27:19 +00:00
# Version-specific settings
2024-04-15 17:36:29 +00:00
i f e q ( $( VERSION ) , g c - e u )
2024-01-29 15:36:41 +00:00
DEBUG := 0
2024-04-15 17:36:29 +00:00
COMPARE := 0
e l s e i f e q ( $( VERSION ) , g c - e u - m q )
DEBUG := 0
2024-06-20 22:26:01 +00:00
CPP_DEFINES += -DOOT_MQ
2024-01-28 17:09:03 +00:00
e l s e i f e q ( $( VERSION ) , g c - e u - m q - d b g )
2024-01-29 15:36:41 +00:00
DEBUG := 1
2024-06-20 22:26:01 +00:00
CPP_DEFINES += -DOOT_MQ
2024-01-05 22:27:19 +00:00
e l s e
$( error Unsupported version $ ( VERSION ) )
e n d i f
2020-03-17 04:31:30 +00:00
PROJECT_DIR := $( dir $( realpath $( firstword $( MAKEFILE_LIST) ) ) )
2024-01-05 22:27:19 +00:00
BUILD_DIR := build/$( VERSION)
2024-01-28 17:09:03 +00:00
EXPECTED_DIR := expected/$( BUILD_DIR)
2024-02-05 03:59:09 +00:00
BASEROM_DIR := baseroms/$( VERSION)
2024-03-02 03:09:57 +00:00
EXTRACTED_DIR := extracted/$( VERSION)
2024-01-25 00:39:13 +00:00
VENV := .venv
2020-03-17 04:31:30 +00:00
2020-09-21 07:00:28 +00:00
MAKE = make
2024-03-29 15:03:28 +00:00
CPPFLAGS += -P -xc -fno-dollars-in-identifiers
2020-09-21 07:00:28 +00:00
2024-01-29 17:20:54 +00:00
i f e q ( $( DEBUG ) , 1 )
2024-06-20 22:26:01 +00:00
CPP_DEFINES += -DOOT_DEBUG= 1
2024-01-29 17:20:54 +00:00
OPTFLAGS := -O2
e l s e
2024-06-20 22:26:01 +00:00
CPP_DEFINES += -DNDEBUG -DOOT_DEBUG= 0
2024-01-29 17:20:54 +00:00
OPTFLAGS := -O2 -g3
e n d i f
2020-09-21 07:00:28 +00:00
i f e q ( $( OS ) , W i n d o w s _ N T )
2021-01-20 19:46:25 +00:00
DETECTED_OS = windows
2020-09-21 07:00:28 +00:00
e l s e
UNAME_S := $( shell uname -s)
ifeq ( $( UNAME_S) ,Linux)
DETECTED_OS = linux
endif
ifeq ( $( UNAME_S) ,Darwin)
DETECTED_OS = macos
MAKE = gmake
endif
e n d i f
2020-03-17 04:31:30 +00:00
#### Tools ####
2022-01-19 23:57:39 +00:00
i f n e q ( $( shell type $ ( MIPS_BINUTILS_PREFIX ) ld >/dev /null 2>/dev /null ; echo $ $ ?) , 0 )
2023-03-20 15:07:18 +00:00
$( error Unable to find $( MIPS_BINUTILS_PREFIX) ld. Please install or build MIPS binutils, commonly mips-linux-gnu. ( or set MIPS_BINUTILS_PREFIX if your MIPS binutils install uses another prefix) )
2020-03-17 04:31:30 +00:00
e n d i f
2022-02-19 21:50:56 +00:00
# Detect compiler and set variables appropriately.
i f e q ( $( COMPILER ) , g c c )
CC := $( MIPS_BINUTILS_PREFIX) gcc
2024-01-05 22:27:19 +00:00
e l s e i f e q ( $( COMPILER ) , i d o )
2022-02-19 21:50:56 +00:00
CC := tools/ido_recomp/$( DETECTED_OS) /7.1/cc
CC_OLD := tools/ido_recomp/$( DETECTED_OS) /5.3/cc
e l s e
$( error Unsupported compiler . Please use either ido or gcc as the COMPILER variable .)
e n d i f
2020-08-22 23:06:52 +00:00
# if ORIG_COMPILER is 1, check that either QEMU_IRIX is set or qemu-irix package installed
i f e q ( $( ORIG_COMPILER ) , 1 )
ifndef QEMU_IRIX
QEMU_IRIX := $( shell which qemu-irix)
ifeq ( , $( QEMU_IRIX) )
$( error Please install qemu-irix package or set QEMU_IRIX env var to the full qemu-irix binary path)
endif
2020-03-17 04:31:30 +00:00
endif
2020-08-22 23:06:52 +00:00
CC = $( QEMU_IRIX) -L tools/ido7.1_compiler tools/ido7.1_compiler/usr/bin/cc
CC_OLD = $( QEMU_IRIX) -L tools/ido5.3_compiler tools/ido5.3_compiler/usr/bin/cc
2020-03-17 04:31:30 +00:00
e n d i f
2024-01-09 17:49:12 +00:00
AS := $( MIPS_BINUTILS_PREFIX) as
LD := $( MIPS_BINUTILS_PREFIX) ld
OBJCOPY := $( MIPS_BINUTILS_PREFIX) objcopy
OBJDUMP := $( MIPS_BINUTILS_PREFIX) objdump
2024-01-24 18:00:10 +00:00
NM := $( MIPS_BINUTILS_PREFIX) nm
2024-01-09 17:49:12 +00:00
2024-06-19 04:00:23 +00:00
N64_EMULATOR ?=
2020-03-17 04:31:30 +00:00
2024-03-02 03:09:57 +00:00
INC := -Iinclude -Iinclude/libc -Isrc -I$( BUILD_DIR) -I. -I$( EXTRACTED_DIR)
2021-09-18 12:07:51 +00:00
2020-03-23 22:15:45 +00:00
# Check code syntax with host compiler
2022-06-16 00:15:44 +00:00
CHECK_WARNINGS := -Wall -Wextra -Wno-format-security -Wno-unknown-pragmas -Wno-unused-parameter -Wno-unused-variable -Wno-missing-braces
2020-03-17 04:31:30 +00:00
2024-03-29 15:03:28 +00:00
# The `cpp` command behaves differently on macOS (it behaves as if
# `-traditional-cpp` was passed) so we use `gcc -E` instead.
CPP := gcc -E
2020-03-17 04:31:30 +00:00
MKLDSCRIPT := tools/mkldscript
2021-11-30 23:29:09 +00:00
MKDMADATA := tools/mkdmadata
2020-03-17 04:31:30 +00:00
ELF2ROM := tools/elf2rom
2021-01-02 04:24:29 +00:00
ZAPD := tools/ZAPD/ZAPD.out
2022-02-06 19:40:26 +00:00
FADO := tools/fado/fado.elf
2024-01-25 00:39:13 +00:00
PYTHON ?= $( VENV) /bin/python3
2020-03-17 04:31:30 +00:00
2024-01-05 22:27:19 +00:00
# Command to replace path variables in the spec file. We can't use the C
# preprocessor for this because it won't substitute inside string literals.
SPEC_REPLACE_VARS := sed -e 's|$$(BUILD_DIR)|$(BUILD_DIR)|g'
2024-06-20 22:26:01 +00:00
CFLAGS += $( CPP_DEFINES)
CPPFLAGS += $( CPP_DEFINES)
2022-02-19 21:50:56 +00:00
i f e q ( $( COMPILER ) , g c c )
OPTFLAGS := -Os -ffast-math -fno-unsafe-math-optimizations
e n d i f
2022-05-01 22:14:44 +00:00
ASFLAGS := -march= vr4300 -32 -no-pad-sections -Iinclude
2020-03-17 04:31:30 +00:00
2022-02-19 21:50:56 +00:00
i f e q ( $( COMPILER ) , g c c )
2024-02-29 20:11:54 +00:00
CFLAGS += -G 0 -nostdinc $( INC) -march= vr4300 -mfix4300 -mabi= 32 -mno-abicalls -mdivide-breaks -fno-PIC -fno-common -ffreestanding -fbuiltin -fno-builtin-sinf -fno-builtin-cosf $( CHECK_WARNINGS) -funsigned-char
2022-02-19 21:50:56 +00:00
MIPS_VERSION := -mips3
2023-02-26 16:26:07 +00:00
e l s e
2024-01-12 15:38:13 +00:00
# Suppress warnings for wrong number of macro arguments (to fake variadic
# macros) and Microsoft extensions such as anonymous structs (which the
# compiler does support but warns for their usage).
CFLAGS += -G 0 -non_shared -fullwarn -verbose -Xcpluscomm $( INC) -Wab,-r4300_mul -woff 516,609,649,838,712
2022-02-19 21:50:56 +00:00
MIPS_VERSION := -mips2
e n d i f
2020-03-17 04:31:30 +00:00
2022-02-19 21:50:56 +00:00
i f e q ( $( COMPILER ) , i d o )
2022-04-30 23:03:22 +00:00
# Have CC_CHECK pretend to be a MIPS compiler
MIPS_BUILTIN_DEFS := -D_MIPS_ISA_MIPS2= 2 -D_MIPS_ISA= _MIPS_ISA_MIPS2 -D_ABIO32= 1 -D_MIPS_SIM= _ABIO32 -D_MIPS_SZINT= 32 -D_MIPS_SZLONG= 32 -D_MIPS_SZPTR= 32
2024-06-20 22:26:01 +00:00
CC_CHECK = gcc -fno-builtin -fsyntax-only -funsigned-char -std= gnu90 -D_LANGUAGE_C $( CPP_DEFINES) $( MIPS_BUILTIN_DEFS) $( INC) $( CHECK_WARNINGS)
2022-02-19 21:50:56 +00:00
ifeq ( $( shell getconf LONG_BIT) , 32)
# Work around memory allocation bug in QEMU
export QEMU_GUEST_BASE := 1
else
# Ensure that gcc (warning check) treats the code as 32-bit
CC_CHECK += -m32
endif
2020-03-17 04:31:30 +00:00
e l s e
2024-02-01 20:08:45 +00:00
RUN_CC_CHECK := 0
2020-03-17 04:31:30 +00:00
e n d i f
2022-05-20 06:27:54 +00:00
OBJDUMP_FLAGS := -d -r -z -Mreg-names= 32
2020-03-17 04:31:30 +00:00
#### Files ####
# ROM image
2024-02-02 21:34:20 +00:00
ROM := $( BUILD_DIR) /oot-$( VERSION) .z64
ROMC := $( ROM:.z64= -compressed.z64)
ELF := $( ROM:.z64= .elf)
MAP := $( ROM:.z64= .map)
LDSCRIPT := $( ROM:.z64= .ld)
2020-03-17 04:31:30 +00:00
# description of ROM segments
SPEC := spec
2022-02-19 21:50:56 +00:00
i f e q ( $( COMPILER ) , i d o )
SRC_DIRS := $( shell find src -type d -not -path src/gcc_fix)
e l s e
2020-05-01 01:49:35 +00:00
SRC_DIRS := $( shell find src -type d)
2022-02-19 21:50:56 +00:00
e n d i f
z_message_PAL, message_data_static and surrounding doc (#996)
* Initial progress on z_message_PAL, very messy
* Fix merge
* Some more progress
* Fix merge
* More z_message_PAL
* Small progress
* More small progress
* message_data_static files OK
* Prepare z_message_tables
* Matched another function, small updates
* Attempt to use asm-processor static-symbols branch
* Refactor text id declarations
* Begin large text codes parser function
* Fix merge
* Refactor done
* Build OK, add color and highscore names
* Remove encoded text headers and automatically encode during build
* Fix kanfont
* Various cleanups
* DISP macros
* Another match aside data
* Further progress
* Small improvements
* Deduplicate magic values for text control codes, small improvements
* Tiny progress
* Minor cleanups
* Clean up z_message_PAL comment
* Progress on large functions
* Further progress on large functions
* Changes to mkldscript to link .data in the .rodata section
* data OK
* Few improvements
* Use gDPLoadTextureBlock macros where appropriate
* rm z_message_tables, progress on large functions
* 2 more matches
* Improvements
* Small progress
* More progress on big function
* progress
* match func_80107980
* match Message_Update
* match func_8010BED8
* done
* Progress on remaining large functions
* Small progress on largest function
* Another match, extract text and move to assets, improve text build system
* Small nonmatchings improvements
* docs wip
* Largest function maybe equivalent
* Fix merge
* Document do_action values, largest function is almost instruction-matching
* Rename NAVI do_action to NONE, as that appears to be how that value is used in practice
* Fix merge
* one match
* Last function is instruction-matching
* Fix
* Improvements thanks to engineer124
* Stack matched thanks to petrie911, now just a/v/low t regalloc issues, some cleanup
* More variables labeled, use text state enum everywhere
* More labels and names
* Fix
* Actor_IsTalking -> Actor_TalkRequested
* Match func_8010C39C and remove unused asm
* More docs
* Mostly ocarina related docs
* All msgModes named
* Fix assetclean
* Cleanup
* Extraction fixes and headers
* Suggestions
* Review suggestions
* Change text extraction again, only extract if the headers do not already exist
* Fix
* Use ast for charmap, fix assetclean for real this time
* Review suggestions
* BGM ids and ran formatter
* Review comments
* rename include_readonly to include_data_with_rodata
* Remove leading 0s in number directives
* Review suggestions for message_data_static
* textbox pos enum comments, rename several enum names from Message to TextBox
Co-authored-by: Thar0 <maximilianc64@gmail.com>
Co-authored-by: Zelllll <56516451+Zelllll@users.noreply.github.com>
Co-authored-by: petrie911 <pmontag@DESKTOP-LG8A167.localdomain>
Co-authored-by: Roman971 <romanlasnier@hotmail.com>
2021-11-23 01:20:30 +00:00
ASSET_BIN_DIRS := $( shell find assets/* -type d -not -path "assets/xml*" -not -path "assets/text" )
2020-12-26 11:39:52 +00:00
ASSET_FILES_XML := $( foreach dir,$( ASSET_BIN_DIRS) ,$( wildcard $( dir) /*.xml) )
ASSET_FILES_BIN := $( foreach dir,$( ASSET_BIN_DIRS) ,$( wildcard $( dir) /*.bin) )
ASSET_FILES_OUT := $( foreach f,$( ASSET_FILES_XML:.xml= .c) ,$f ) \
2024-01-05 22:27:19 +00:00
$( foreach f,$( ASSET_FILES_BIN:.bin= .bin.inc.c) ,$( BUILD_DIR) /$f ) \
$( foreach f,$( wildcard assets/text/*.c) ,$( BUILD_DIR) /$( f:.c= .o) )
2020-12-26 11:39:52 +00:00
2022-06-03 20:33:18 +00:00
UNDECOMPILED_DATA_DIRS := $( shell find data -type d)
2024-03-05 00:06:26 +00:00
BASEROM_BIN_FILES := $( wildcard $( EXTRACTED_DIR) /baserom/*)
2024-01-28 17:09:03 +00:00
2020-05-01 01:49:35 +00:00
# source files
2022-10-04 10:36:25 +00:00
C_FILES := $( filter-out %.inc.c,$( foreach dir,$( SRC_DIRS) $( ASSET_BIN_DIRS) ,$( wildcard $( dir) /*.c) ) )
2022-06-03 20:33:18 +00:00
S_FILES := $( foreach dir,$( SRC_DIRS) $( UNDECOMPILED_DATA_DIRS) ,$( wildcard $( dir) /*.s) )
2024-01-05 22:27:19 +00:00
O_FILES := $( foreach f,$( S_FILES:.s= .o) ,$( BUILD_DIR) /$f ) \
$( foreach f,$( C_FILES:.c= .o) ,$( BUILD_DIR) /$f ) \
2024-01-24 18:00:10 +00:00
$( foreach f,$( BASEROM_BIN_FILES) ,$( BUILD_DIR) /baserom/$( notdir $f ) .o)
2020-12-26 11:39:52 +00:00
2024-01-05 22:27:19 +00:00
OVL_RELOC_FILES := $( shell $( CPP) $( CPPFLAGS) $( SPEC) | $( SPEC_REPLACE_VARS) | grep -o '[^"]*_reloc.o' )
2022-02-06 19:40:26 +00:00
2021-05-02 20:21:27 +00:00
# Automatic dependency files
2022-02-06 19:40:26 +00:00
# (Only asm_processor dependencies and reloc dependencies are handled for now)
DEP_FILES := $( O_FILES:.o= .asmproc.d) $( OVL_RELOC_FILES:.o= .d)
2021-05-02 20:21:27 +00:00
2021-05-15 18:14:51 +00:00
TEXTURE_FILES_PNG := $( foreach dir,$( ASSET_BIN_DIRS) ,$( wildcard $( dir) /*.png) )
2021-04-02 22:07:29 +00:00
TEXTURE_FILES_JPG := $( foreach dir,$( ASSET_BIN_DIRS) ,$( wildcard $( dir) /*.jpg) )
2024-01-05 22:27:19 +00:00
TEXTURE_FILES_OUT := $( foreach f,$( TEXTURE_FILES_PNG:.png= .inc.c) ,$( BUILD_DIR) /$f ) \
$( foreach f,$( TEXTURE_FILES_JPG:.jpg= .jpg.inc.c) ,$( BUILD_DIR) /$f ) \
2020-03-17 04:31:30 +00:00
# create build directories
2024-03-02 03:09:57 +00:00
$( shell mkdir -p $ ( BUILD_DIR ) /baserom $ ( EXTRACTED_DIR ) /text $ ( BUILD_DIR ) /assets /text $ ( foreach dir ,$ ( SRC_DIRS ) $ ( UNDECOMPILED_DATA_DIRS ) $ ( ASSET_BIN_DIRS ) ,$ ( BUILD_DIR ) /$ ( dir ) ) )
2020-03-17 04:31:30 +00:00
2022-02-19 21:50:56 +00:00
i f e q ( $( COMPILER ) , i d o )
2024-01-29 15:36:41 +00:00
$(BUILD_DIR)/src/boot/stackcheck.o : OPTFLAGS := -O 2
$(BUILD_DIR)/src/code/__osMalloc.o : OPTFLAGS := -O 2
$(BUILD_DIR)/src/code/code_800FC620.o : OPTFLAGS := -O 2
2024-06-19 04:00:23 +00:00
$(BUILD_DIR)/src/code/fp_math.o : OPTFLAGS := -O 2
2024-02-27 03:21:25 +00:00
$(BUILD_DIR)/src/code/rand.o : OPTFLAGS := -O 2
2024-01-29 15:36:41 +00:00
$(BUILD_DIR)/src/code/gfxprint.o : OPTFLAGS := -O 2
$(BUILD_DIR)/src/code/jpegutils.o : OPTFLAGS := -O 2
$(BUILD_DIR)/src/code/jpegdecoder.o : OPTFLAGS := -O 2
2024-01-31 00:30:27 +00:00
$(BUILD_DIR)/src/code/load.o : OPTFLAGS := -O 2
2024-01-29 15:36:41 +00:00
$(BUILD_DIR)/src/code/loadfragment2.o : OPTFLAGS := -O 2
$(BUILD_DIR)/src/code/logutils.o : OPTFLAGS := -O 2
$(BUILD_DIR)/src/code/mtxuty-cvt.o : OPTFLAGS := -O 2
$(BUILD_DIR)/src/code/padsetup.o : OPTFLAGS := -O 2
$(BUILD_DIR)/src/code/padutils.o : OPTFLAGS := -O 2
$(BUILD_DIR)/src/code/printutils.o : OPTFLAGS := -O 2
$(BUILD_DIR)/src/code/relocation.o : OPTFLAGS := -O 2
$(BUILD_DIR)/src/code/sleep.o : OPTFLAGS := -O 2
$(BUILD_DIR)/src/code/system_malloc.o : OPTFLAGS := -O 2
2024-01-05 22:27:19 +00:00
$(BUILD_DIR)/src/code/fault.o : CFLAGS += -trapuv
$(BUILD_DIR)/src/code/fault.o : OPTFLAGS := -O 2 -g 3
$(BUILD_DIR)/src/code/fault_drawer.o : CFLAGS += -trapuv
$(BUILD_DIR)/src/code/fault_drawer.o : OPTFLAGS := -O 2 -g 3
$(BUILD_DIR)/src/code/ucode_disas.o : OPTFLAGS := -O 2 -g 3
2024-01-29 15:36:41 +00:00
i f e q ( $( DEBUG ) , 1 )
2024-01-05 22:27:19 +00:00
$(BUILD_DIR)/src/code/fmodf.o : OPTFLAGS := -g
$(BUILD_DIR)/src/code/__osMemset.o : OPTFLAGS := -g
$(BUILD_DIR)/src/code/__osMemmove.o : OPTFLAGS := -g
2024-01-29 15:36:41 +00:00
e l s e
$(BUILD_DIR)/src/code/fmodf.o : OPTFLAGS := -O 2
$(BUILD_DIR)/src/code/__osMemset.o : OPTFLAGS := -O 2
$(BUILD_DIR)/src/code/__osMemmove.o : OPTFLAGS := -O 2
e n d i f
2020-05-01 01:49:35 +00:00
2024-01-05 22:27:19 +00:00
$(BUILD_DIR)/src/audio/%.o : OPTFLAGS := -O 2
2023-07-06 21:55:10 +00:00
# Use signed chars instead of unsigned for this audio file (needed to match AudioDebug_ScrPrt)
2024-01-05 22:27:19 +00:00
$(BUILD_DIR)/src/audio/general.o : CFLAGS += -signed
2022-07-30 00:35:09 +00:00
# Put string literals in .data for some audio files (needed to match these files with literals)
2024-01-05 22:27:19 +00:00
$(BUILD_DIR)/src/audio/sfx.o : CFLAGS += -use_readwrite_const
$(BUILD_DIR)/src/audio/sequence.o : CFLAGS += -use_readwrite_const
2024-01-29 15:36:41 +00:00
i f e q ( $( DEBUG ) , 1 )
2024-01-05 22:27:19 +00:00
$(BUILD_DIR)/src/libultra/libc/absf.o : OPTFLAGS := -O 2 -g 3
$(BUILD_DIR)/src/libultra/libc/sqrt.o : OPTFLAGS := -O 2 -g 3
2024-01-29 15:36:41 +00:00
e l s e
$(BUILD_DIR)/src/libultra/libc/absf.o : OPTFLAGS := -O 2
$(BUILD_DIR)/src/libultra/libc/sqrt.o : OPTFLAGS := -O 2
e n d i f
2024-01-05 22:27:19 +00:00
$(BUILD_DIR)/src/libultra/libc/ll.o : OPTFLAGS := -O 1
$(BUILD_DIR)/src/libultra/libc/ll.o : MIPS_VERSION := -mips 3 -32
$(BUILD_DIR)/src/libultra/libc/llcvt.o : OPTFLAGS := -O 1
$(BUILD_DIR)/src/libultra/libc/llcvt.o : MIPS_VERSION := -mips 3 -32
$(BUILD_DIR)/src/libultra/os/%.o : OPTFLAGS := -O 1
$(BUILD_DIR)/src/libultra/io/%.o : OPTFLAGS := -O 2
$(BUILD_DIR)/src/libultra/libc/%.o : OPTFLAGS := -O 2
$(BUILD_DIR)/src/libultra/rmon/%.o : OPTFLAGS := -O 2
$(BUILD_DIR)/src/libultra/gu/%.o : OPTFLAGS := -O 2
$(BUILD_DIR)/assets/misc/z_select_static/%.o : CFLAGS += -DF 3DEX_GBI
$(BUILD_DIR)/src/libultra/gu/%.o : CC := $( CC_OLD )
$(BUILD_DIR)/src/libultra/io/%.o : CC := $( CC_OLD )
$(BUILD_DIR)/src/libultra/libc/%.o : CC := $( CC_OLD )
$(BUILD_DIR)/src/libultra/os/%.o : CC := $( CC_OLD )
$(BUILD_DIR)/src/libultra/rmon/%.o : CC := $( CC_OLD )
$(BUILD_DIR)/src/code/jpegutils.o : CC := $( CC_OLD )
$(BUILD_DIR)/src/code/jpegdecoder.o : CC := $( CC_OLD )
2024-03-01 21:12:22 +00:00
# For using asm_processor on some files:
#$(BUILD_DIR)/.../%.o: CC := $(PYTHON) tools/asm_processor/build.py $(CC) -- $(AS) $(ASFLAGS) --
2024-04-14 21:51:32 +00:00
i f e q ( $( PERMUTER ) , ) # permuter + preprocess.py misbehaves, permuter doesn't care about rodata diffs or bss ordering so just don't use it in that case
# Handle encoding (UTF-8 -> EUC-JP) and custom pragmas
$(BUILD_DIR)/src/%.o : CC := $( PYTHON ) tools /preprocess .py $( CC )
2024-03-01 21:12:22 +00:00
e n d i f
2024-01-05 22:27:19 +00:00
2022-02-19 21:50:56 +00:00
e l s e
2024-02-29 20:11:54 +00:00
# Note that if adding additional assets directories for modding reasons these flags must also be used there
$(BUILD_DIR)/assets/%.o : CFLAGS += -fno -zero -initialized -in -bss -fno -toplevel -reorder
$(BUILD_DIR)/src/%.o : CFLAGS += -fexec -charset =euc -jp
2024-01-05 22:27:19 +00:00
$(BUILD_DIR)/src/libultra/libc/ll.o : OPTFLAGS := -Ofast
2024-02-29 20:11:54 +00:00
$(BUILD_DIR)/src/overlays/%.o : CFLAGS += -fno -merge -constants -mno -explicit -relocs -mno -split -addresses
2022-02-19 21:50:56 +00:00
e n d i f
2020-04-16 18:08:23 +00:00
2020-03-17 04:31:30 +00:00
#### Main Targets ###
2024-01-25 00:39:13 +00:00
all : rom compress
2024-01-24 18:00:10 +00:00
rom : $( ROM )
i f n e q ( $( COMPARE ) , 0 )
2020-03-17 04:31:30 +00:00
@md5sum $( ROM)
2024-02-05 03:59:09 +00:00
@md5sum -c $( BASEROM_DIR) /checksum.md5
2024-01-24 18:00:10 +00:00
e n d i f
2024-01-24 23:02:53 +00:00
compress : $( ROMC )
2024-01-24 18:00:10 +00:00
i f n e q ( $( COMPARE ) , 0 )
@md5sum $( ROMC)
2024-02-05 03:59:09 +00:00
@md5sum -c $( BASEROM_DIR) /checksum-compressed.md5
2020-07-19 19:42:05 +00:00
e n d i f
2020-03-17 04:31:30 +00:00
clean :
2024-02-02 21:34:20 +00:00
$( RM) -r $( BUILD_DIR)
2020-03-17 04:31:30 +00:00
2021-05-17 17:50:19 +00:00
assetclean :
2021-03-14 16:07:46 +00:00
$( RM) -r $( ASSET_BIN_DIRS)
2024-03-02 03:09:57 +00:00
$( RM) -r $( EXTRACTED_DIR)
2024-01-05 22:27:19 +00:00
$( RM) -r $( BUILD_DIR) /assets
2021-05-26 23:40:48 +00:00
$( RM) -r .extracted-assets.json
2021-05-17 17:50:19 +00:00
2024-03-04 17:26:04 +00:00
distclean : assetclean
$( RM) -r extracted/
$( RM) -r build/
2021-03-14 16:07:46 +00:00
$( MAKE) -C tools distclean
2024-01-25 00:39:13 +00:00
venv :
2024-01-28 00:40:29 +00:00
# Create the virtual environment if it doesn't exist.
# Delete the virtual environment directory if creation fails.
test -d $( VENV) || python3 -m venv $( VENV) || { rm -rf $( VENV) ; false; }
2024-01-25 00:39:13 +00:00
$( PYTHON) -m pip install -U pip
$( PYTHON) -m pip install -U -r requirements.txt
setup : venv
2021-05-03 17:37:54 +00:00
$( MAKE) -C tools
2024-01-24 18:00:10 +00:00
$( PYTHON) tools/decompress_baserom.py $( VERSION)
2024-06-21 02:26:32 +00:00
$( PYTHON) tools/extract_baserom.py $( BASEROM_DIR) /baserom-decompressed.z64 --oot-version $( VERSION) -o $( EXTRACTED_DIR) /baserom
2024-03-02 21:05:15 +00:00
$( PYTHON) tools/msgdis.py --oot-version $( VERSION) --text-out $( EXTRACTED_DIR) /text/message_data.h --staff-text-out $( EXTRACTED_DIR) /text/message_data_staff.h
2024-02-05 03:59:09 +00:00
# TODO: for now, we only extract assets from the Debug ROM
2024-01-28 17:09:03 +00:00
i f e q ( $( VERSION ) , g c - e u - m q - d b g )
2024-01-24 18:00:10 +00:00
$( PYTHON) extract_assets.py -j$( N_THREADS)
2024-01-28 17:09:03 +00:00
e n d i f
2024-02-13 01:20:25 +00:00
disasm :
$( RM) -r $( EXPECTED_DIR)
VERSION = $( VERSION) DISASM_BASEROM = $( BASEROM_DIR) /baserom-decompressed.z64 DISASM_DIR = $( EXPECTED_DIR) PYTHON = $( PYTHON) AS_CMD = '$(AS) $(ASFLAGS)' LD = $( LD) ./tools/disasm/do_disasm.sh
2020-03-17 04:31:30 +00:00
2023-08-28 22:48:52 +00:00
run : $( ROM )
2024-01-09 17:49:12 +00:00
i f e q ( $( N 64_EMULATOR ) , )
$( error Emulator path not set. Set N64_EMULATOR in the Makefile or define it as an environment variable)
2023-08-28 22:48:52 +00:00
e n d i f
2024-01-09 17:49:12 +00:00
$( N64_EMULATOR) $<
2020-12-22 00:14:25 +00:00
2022-02-06 19:40:26 +00:00
2024-01-28 17:09:03 +00:00
.PHONY : all rom compress clean assetclean distclean venv setup disasm run
2024-01-24 18:00:10 +00:00
.DEFAULT_GOAL := rom
2020-12-22 00:14:25 +00:00
2020-03-17 04:31:30 +00:00
#### Various Recipes ####
2022-02-06 19:40:26 +00:00
$(ROM) : $( ELF )
$( ELF2ROM) -cic 6105 $< $@
2024-01-24 18:00:10 +00:00
$(ROMC) : $( ROM ) $( ELF ) $( BUILD_DIR ) /compress_ranges .txt
2024-02-05 03:59:09 +00:00
$( PYTHON) tools/compress.py --in $( ROM) --out $@ --dmadata-start ` ./tools/dmadata_start.sh $( NM) $( ELF) ` --compress ` cat $( BUILD_DIR) /compress_ranges.txt` --threads $( N_THREADS)
2024-01-24 18:00:10 +00:00
$( PYTHON) -m ipl3checksum sum --cic 6105 --update $@
2024-02-02 21:34:20 +00:00
$(ELF) : $( TEXTURE_FILES_OUT ) $( ASSET_FILES_OUT ) $( O_FILES ) $( OVL_RELOC_FILES ) $( LDSCRIPT ) $( BUILD_DIR ) /undefined_syms .txt
$( LD) -T $( LDSCRIPT) -T $( BUILD_DIR) /undefined_syms.txt --no-check-sections --accept-unknown-input-arch --emit-relocs -Map $( MAP) -o $@
2022-02-06 19:40:26 +00:00
2023-02-26 16:26:07 +00:00
## Order-only prerequisites
2022-02-06 19:40:26 +00:00
# These ensure e.g. the O_FILES are built before the OVL_RELOC_FILES.
# The intermediate phony targets avoid quadratically-many dependencies between the targets and prerequisites.
o_files : $( O_FILES )
$(OVL_RELOC_FILES) : | o_files
asset_files : $( TEXTURE_FILES_OUT ) $( ASSET_FILES_OUT )
$(O_FILES) : | asset_files
.PHONY : o_files asset_files
2024-01-05 22:27:19 +00:00
$(BUILD_DIR)/$(SPEC) : $( SPEC )
$( CPP) $( CPPFLAGS) $< | $( SPEC_REPLACE_VARS) > $@
2022-02-06 19:40:26 +00:00
2024-02-02 21:34:20 +00:00
$(LDSCRIPT) : $( BUILD_DIR ) /$( SPEC )
2022-02-06 19:40:26 +00:00
$( MKLDSCRIPT) $< $@
2024-01-05 22:27:19 +00:00
$(BUILD_DIR)/undefined_syms.txt : undefined_syms .txt
2022-02-06 19:40:26 +00:00
$( CPP) $( CPPFLAGS) $< > $@
2024-03-05 00:06:26 +00:00
$(BUILD_DIR)/baserom/%.o : $( EXTRACTED_DIR ) /baserom /%
2020-03-17 04:31:30 +00:00
$( OBJCOPY) -I binary -O elf32-big $< $@
2024-01-05 22:27:19 +00:00
$(BUILD_DIR)/data/%.o : data /%.s
2022-02-06 19:40:26 +00:00
$( AS) $( ASFLAGS) $< -o $@
2020-03-17 04:31:30 +00:00
2024-03-02 03:09:57 +00:00
$(BUILD_DIR)/assets/text/%.enc.h : assets /text /%.h $( EXTRACTED_DIR ) /text /%.h assets /text /charmap .txt
$( CPP) $( CPPFLAGS) -I$( EXTRACTED_DIR) $< | $( PYTHON) tools/msgenc.py - --output $@ --charmap assets/text/charmap.txt
z_message_PAL, message_data_static and surrounding doc (#996)
* Initial progress on z_message_PAL, very messy
* Fix merge
* Some more progress
* Fix merge
* More z_message_PAL
* Small progress
* More small progress
* message_data_static files OK
* Prepare z_message_tables
* Matched another function, small updates
* Attempt to use asm-processor static-symbols branch
* Refactor text id declarations
* Begin large text codes parser function
* Fix merge
* Refactor done
* Build OK, add color and highscore names
* Remove encoded text headers and automatically encode during build
* Fix kanfont
* Various cleanups
* DISP macros
* Another match aside data
* Further progress
* Small improvements
* Deduplicate magic values for text control codes, small improvements
* Tiny progress
* Minor cleanups
* Clean up z_message_PAL comment
* Progress on large functions
* Further progress on large functions
* Changes to mkldscript to link .data in the .rodata section
* data OK
* Few improvements
* Use gDPLoadTextureBlock macros where appropriate
* rm z_message_tables, progress on large functions
* 2 more matches
* Improvements
* Small progress
* More progress on big function
* progress
* match func_80107980
* match Message_Update
* match func_8010BED8
* done
* Progress on remaining large functions
* Small progress on largest function
* Another match, extract text and move to assets, improve text build system
* Small nonmatchings improvements
* docs wip
* Largest function maybe equivalent
* Fix merge
* Document do_action values, largest function is almost instruction-matching
* Rename NAVI do_action to NONE, as that appears to be how that value is used in practice
* Fix merge
* one match
* Last function is instruction-matching
* Fix
* Improvements thanks to engineer124
* Stack matched thanks to petrie911, now just a/v/low t regalloc issues, some cleanup
* More variables labeled, use text state enum everywhere
* More labels and names
* Fix
* Actor_IsTalking -> Actor_TalkRequested
* Match func_8010C39C and remove unused asm
* More docs
* Mostly ocarina related docs
* All msgModes named
* Fix assetclean
* Cleanup
* Extraction fixes and headers
* Suggestions
* Review suggestions
* Change text extraction again, only extract if the headers do not already exist
* Fix
* Use ast for charmap, fix assetclean for real this time
* Review suggestions
* BGM ids and ran formatter
* Review comments
* rename include_readonly to include_data_with_rodata
* Remove leading 0s in number directives
* Review suggestions for message_data_static
* textbox pos enum comments, rename several enum names from Message to TextBox
Co-authored-by: Thar0 <maximilianc64@gmail.com>
Co-authored-by: Zelllll <56516451+Zelllll@users.noreply.github.com>
Co-authored-by: petrie911 <pmontag@DESKTOP-LG8A167.localdomain>
Co-authored-by: Roman971 <romanlasnier@hotmail.com>
2021-11-23 01:20:30 +00:00
2023-10-20 17:14:52 +00:00
# Dependencies for files including message data headers
# TODO remove when full header dependencies are used.
2024-01-05 22:27:19 +00:00
$(BUILD_DIR)/assets/text/fra_message_data_static.o : $( BUILD_DIR ) /assets /text /message_data .enc .h
$(BUILD_DIR)/assets/text/ger_message_data_static.o : $( BUILD_DIR ) /assets /text /message_data .enc .h
$(BUILD_DIR)/assets/text/nes_message_data_static.o : $( BUILD_DIR ) /assets /text /message_data .enc .h
$(BUILD_DIR)/assets/text/staff_message_data_static.o : $( BUILD_DIR ) /assets /text /message_data_staff .enc .h
$(BUILD_DIR)/src/code/z_message_PAL.o : $( BUILD_DIR ) /assets /text /message_data .enc .h $( BUILD_DIR ) /assets /text /message_data_staff .enc .h
z_message_PAL, message_data_static and surrounding doc (#996)
* Initial progress on z_message_PAL, very messy
* Fix merge
* Some more progress
* Fix merge
* More z_message_PAL
* Small progress
* More small progress
* message_data_static files OK
* Prepare z_message_tables
* Matched another function, small updates
* Attempt to use asm-processor static-symbols branch
* Refactor text id declarations
* Begin large text codes parser function
* Fix merge
* Refactor done
* Build OK, add color and highscore names
* Remove encoded text headers and automatically encode during build
* Fix kanfont
* Various cleanups
* DISP macros
* Another match aside data
* Further progress
* Small improvements
* Deduplicate magic values for text control codes, small improvements
* Tiny progress
* Minor cleanups
* Clean up z_message_PAL comment
* Progress on large functions
* Further progress on large functions
* Changes to mkldscript to link .data in the .rodata section
* data OK
* Few improvements
* Use gDPLoadTextureBlock macros where appropriate
* rm z_message_tables, progress on large functions
* 2 more matches
* Improvements
* Small progress
* More progress on big function
* progress
* match func_80107980
* match Message_Update
* match func_8010BED8
* done
* Progress on remaining large functions
* Small progress on largest function
* Another match, extract text and move to assets, improve text build system
* Small nonmatchings improvements
* docs wip
* Largest function maybe equivalent
* Fix merge
* Document do_action values, largest function is almost instruction-matching
* Rename NAVI do_action to NONE, as that appears to be how that value is used in practice
* Fix merge
* one match
* Last function is instruction-matching
* Fix
* Improvements thanks to engineer124
* Stack matched thanks to petrie911, now just a/v/low t regalloc issues, some cleanup
* More variables labeled, use text state enum everywhere
* More labels and names
* Fix
* Actor_IsTalking -> Actor_TalkRequested
* Match func_8010C39C and remove unused asm
* More docs
* Mostly ocarina related docs
* All msgModes named
* Fix assetclean
* Cleanup
* Extraction fixes and headers
* Suggestions
* Review suggestions
* Change text extraction again, only extract if the headers do not already exist
* Fix
* Use ast for charmap, fix assetclean for real this time
* Review suggestions
* BGM ids and ran formatter
* Review comments
* rename include_readonly to include_data_with_rodata
* Remove leading 0s in number directives
* Review suggestions for message_data_static
* textbox pos enum comments, rename several enum names from Message to TextBox
Co-authored-by: Thar0 <maximilianc64@gmail.com>
Co-authored-by: Zelllll <56516451+Zelllll@users.noreply.github.com>
Co-authored-by: petrie911 <pmontag@DESKTOP-LG8A167.localdomain>
Co-authored-by: Roman971 <romanlasnier@hotmail.com>
2021-11-23 01:20:30 +00:00
2024-01-05 22:27:19 +00:00
$(BUILD_DIR)/assets/%.o : assets /%.c
2021-05-02 20:21:27 +00:00
$( CC) -c $( CFLAGS) $( MIPS_VERSION) $( OPTFLAGS) -o $@ $<
2020-03-17 04:31:30 +00:00
$( OBJCOPY) -O binary $@ $@ .bin
2024-01-05 22:27:19 +00:00
$(BUILD_DIR)/src/%.o : src /%.s
2022-06-03 20:33:18 +00:00
$( CPP) $( CPPFLAGS) -Iinclude $< | $( AS) $( ASFLAGS) -o $@
2024-01-24 18:00:10 +00:00
$(BUILD_DIR)/dmadata_table_spec.h $(BUILD_DIR)/compress_ranges.txt : $( BUILD_DIR ) /$( SPEC )
$( MKDMADATA) $< $( BUILD_DIR) /dmadata_table_spec.h $( BUILD_DIR) /compress_ranges.txt
2021-11-30 23:29:09 +00:00
2023-10-20 17:14:52 +00:00
# Dependencies for files that may include the dmadata header automatically generated from the spec file
2024-01-05 22:27:19 +00:00
$(BUILD_DIR)/src/boot/z_std_dma.o : $( BUILD_DIR ) /dmadata_table_spec .h
$(BUILD_DIR)/src/dmadata/dmadata.o : $( BUILD_DIR ) /dmadata_table_spec .h
2021-11-30 23:29:09 +00:00
2023-10-20 17:14:52 +00:00
# Dependencies for files including from include/tables/
# TODO remove when full header dependencies are used.
2024-01-05 22:27:19 +00:00
$(BUILD_DIR)/src/code/graph.o : include /tables /gamestate_table .h
$(BUILD_DIR)/src/code/object_table.o : include /tables /object_table .h
$(BUILD_DIR)/src/code/z_actor.o : include /tables /actor_table .h # so uses of ACTOR_ID_MAX update when the table length changes
$(BUILD_DIR)/src/code/z_actor_dlftbls.o : include /tables /actor_table .h
$(BUILD_DIR)/src/code/z_effect_soft_sprite_dlftbls.o : include /tables /effect_ss_table .h
$(BUILD_DIR)/src/code/z_game_dlftbls.o : include /tables /gamestate_table .h
$(BUILD_DIR)/src/code/z_scene_table.o : include /tables /scene_table .h include /tables /entrance_table .h
$(BUILD_DIR)/src/%.o : src /%.c
2024-02-01 20:08:45 +00:00
i f n e q ( $( RUN_CC_CHECK ) , 0 )
2021-05-02 20:21:27 +00:00
$( CC_CHECK) $<
2024-02-01 20:08:45 +00:00
e n d i f
2022-05-20 06:27:54 +00:00
$( CC) -c $( CFLAGS) $( MIPS_VERSION) $( OPTFLAGS) -o $@ $<
@$( OBJDUMP) $( OBJDUMP_FLAGS) $@ > $( @:.o= .s)
2020-03-17 04:31:30 +00:00
2024-01-05 22:27:19 +00:00
$(BUILD_DIR)/src/libultra/libc/ll.o : src /libultra /libc /ll .c
2024-02-01 20:08:45 +00:00
i f n e q ( $( RUN_CC_CHECK ) , 0 )
2021-05-02 20:21:27 +00:00
$( CC_CHECK) $<
2024-02-01 20:08:45 +00:00
e n d i f
2022-05-20 06:27:54 +00:00
$( CC) -c $( CFLAGS) $( MIPS_VERSION) $( OPTFLAGS) -o $@ $<
2024-01-24 18:00:10 +00:00
$( PYTHON) tools/set_o32abi_bit.py $@
2022-05-20 06:27:54 +00:00
@$( OBJDUMP) $( OBJDUMP_FLAGS) $@ > $( @:.o= .s)
2021-01-31 18:27:50 +00:00
2024-01-05 22:27:19 +00:00
$(BUILD_DIR)/src/libultra/libc/llcvt.o : src /libultra /libc /llcvt .c
2024-02-01 20:08:45 +00:00
i f n e q ( $( RUN_CC_CHECK ) , 0 )
2021-05-02 20:21:27 +00:00
$( CC_CHECK) $<
2024-02-01 20:08:45 +00:00
e n d i f
2022-05-20 06:27:54 +00:00
$( CC) -c $( CFLAGS) $( MIPS_VERSION) $( OPTFLAGS) -o $@ $<
2024-01-24 18:00:10 +00:00
$( PYTHON) tools/set_o32abi_bit.py $@
2022-05-20 06:27:54 +00:00
@$( OBJDUMP) $( OBJDUMP_FLAGS) $@ > $( @:.o= .s)
2020-05-27 07:48:07 +00:00
2024-01-05 22:27:19 +00:00
$(BUILD_DIR)/src/overlays/%_reloc.o : $( BUILD_DIR ) /$( SPEC )
2022-02-06 19:40:26 +00:00
$( FADO) $$ ( tools/reloc_prereq $< $( notdir $* ) ) -n $( notdir $* ) -o $( @:.o= .s) -M $( @:.o= .d)
$( AS) $( ASFLAGS) $( @:.o= .s) -o $@
2024-01-05 22:27:19 +00:00
$(BUILD_DIR)/%.inc.c : %.png
2021-05-15 18:14:51 +00:00
$( ZAPD) btex -eh -tt $( subst .,,$( suffix $* ) ) -i $< -o $@
2020-03-17 04:31:30 +00:00
2024-01-05 22:27:19 +00:00
$(BUILD_DIR)/assets/%.bin.inc.c : assets /%.bin
2021-05-15 18:14:51 +00:00
$( ZAPD) bblb -eh -i $< -o $@
2021-04-02 22:07:29 +00:00
2024-01-05 22:27:19 +00:00
$(BUILD_DIR)/assets/%.jpg.inc.c : assets /%.jpg
2021-05-15 18:14:51 +00:00
$( ZAPD) bren -eh -i $< -o $@
2021-05-02 20:21:27 +00:00
- i n c l u d e $( DEP_FILES )
2024-01-24 18:00:10 +00:00
# Print target for debugging
print-% : ; $( info $ * is a $ ( flavor $ *) variable set to [$ ( $ *) ]) @true