Adding ECTS splat configuration, corrected+simplified splitting of compressed texture section

Author: mkst

Makefile

@@ -8,14 +8,17 @@ GAME_DIR   = $(BASENAME)
 BIN_DIR    = bin
 BIN_FILES  = $(wildcard $(BIN_DIR)/*.bin)
 
+EXTRACT_DIR = extracted
+
 RZIP_DIRS  = $(wildcard rzip/assets*)
 RZIP_FILES = $(wildcard rzip/assets*/assets*.bin)
 
 O_FILES    = $(foreach file,$(BIN_FILES) $(RZIP_FILES),$(BUILD_DIR)/$(file:.bin=.o))
 
-ifeq ($(VERSION),ects)
-$(error The ECTS ROM is not yet supported)
-endif
+
+# ifeq ($(VERSION),ects)
+# $(error The ECTS ROM is not yet supported)
+# endif
 
 CROSS   = mips-linux-gnu-
 CPP     = cpp
@@ -47,6 +50,8 @@ check: .baserom.$(VERSION).ok
 
 extract: check $(GAME_DIR)/$(BASENAME).$(VERSION).bin
 
+decompress: $(EXTRACT_DIR)/00000000.bin
+
 verify: $(TARGET).z64
 	@echo "$$(cat $(BASENAME).$(VERSION).sha1)  $<" | sha1sum --check
 
@@ -71,6 +76,11 @@ $(TARGET).z64: $(TARGET).bin
 $(GAME_DIR)/$(BASENAME).$(VERSION).bin: bin/game.$(VERSION).bin
 	cat bin/header.$(VERSION).bin bin/boot.$(VERSION).bin bin/init.$(VERSION).bin bin/game.$(VERSION).bin bin/debugger.$(VERSION).bin > $@
 
+# game code is not compressed in ECTS ROM
+ifeq ($(VERSION),ects)
+bin/game.$(VERSION).bin: $(BASENAME).$(VERSION).yaml
+	$(PYTHON) tools/n64splat/split.py baserom.$(VERSION).z64 $< .
+else
 bin/game.$(VERSION).bin: bin/game/rzip/data/0000.bin
 	cat bin/game/rzip/code/0*.bin bin/game/rzip/data/0000.bin > $@
 
@@ -79,11 +89,16 @@ bin/game/rzip/data/0000.bin: bin/game.$(VERSION).rzip.bin
 
 bin/game.$(VERSION).rzip.bin: $(BASENAME).$(VERSION).yaml
 	$(PYTHON) tools/n64splat/split.py baserom.$(VERSION).z64 $< .
+endif
 
 .baserom.$(VERSION).ok: baserom.$(VERSION).z64
 	@echo "$$(cat $(BASENAME).$(VERSION).sha1)  $<" | sha1sum --check
 	@touch $@
 
+$(EXTRACT_DIR)/00000000.bin:
+	@mkdir -p $(EXTRACT_DIR)
+	$(PYTHON) tools/extract_compressed.py compressed.$(VERSION).yaml bin/compressed.bin $(EXTRACT_DIR)
+
 # settings
 .PHONY: all clean default
 SHELL = /bin/bash -e -o pipefail

README.md

@@ -108,7 +108,7 @@ Overview of US ROM shown below:
 [ rzip ]  0018 8328 > 0019 C7D8 ; game .data (compressed)
 [ code ]  0019 EA88 > 001A 2190 ; debugger .text
 [ data ]  001A 2190 > 001A 37E0 ; debugger .data
-[ rzip ]  001A 37E0 > 00AB 1950 ; compressed assets + unknown
+[ rzip ]  001A 37E0 > 00AB 1950 ; compressed section (textures?)
 [ offs ]  00AB 1950 > 00AB 1A40 ; table of asset offsets
 [ rzip ]  00AB 1A40 > 03F8 B800 ; assets 00 thru assets 1C
 [ ffff ]  03F8 B800 > 0400 0000 ; 0xff padding

config/README.md

@@ -11,23 +11,9 @@ Use the `extract_compressed.py` script to decompress these compressed files.
 The arguments are the config file, the file to be decompressed, and the output directory to extract to, e.g.:
 
 ```sh
-python3 tools/extract_compressed.py config/compressed06.us.yaml bin/compressed06.bin tmp/
+mkdir -p tmp
+python3 tools/extract_compressed.py config/compressed.us.yaml bin/compressed.bin tmp/
 ```
-
-You can also iterate over all 6 compressed sections with something like this:
-
-```sh
-# create output folders
-for d in 00 01 02 03 04 05 06; do mkdir -p textures/${d}; done
-# dump textures
-for d in 00 01 02 03 04 05 06; \
-do \
-    echo "extracting compressed${d}"; \
-    python3 tools/extract_compressed.py config/compressed${d}.us.yaml \
-      bin/compressed${d}.bin textures/${d}; \
-done
-```
-
 **NOTE:** Change `us` to `eu` if you are working with the `eu` ROM.
 
 ### Compression
@@ -42,3 +28,5 @@ python3 tools/compress_dir.py tmp tmp2 --no-padding
 # combine compressed files into single blob
 cat tmp2/*.gz > compressed.bin
 ```
+
+In the ROM there is `0x0` padding added to the end of the compressed section to align to a 16 byte boundary.