Updating to latest n64splat

Author: mkst

.bash_aliases

@@ -0,0 +1,6 @@
+# bash aliases for ease of use, copy/append to ~/.bash_aliases
+
+alias m2c='python3 tools/mips_to_c/mips_to_c.py '
+alias di='python3 tools/decomp-permuter/import.py '
+alias dp='python3 tools/decomp-permuter/permuter.py --best-only -j3 '
+alias ad='python3 tools/asm-differ/diff.py -mwo3 '

.github/workflows/docker.yaml

@@ -0,0 +1,34 @@
+name: Create and push Docker build image
+on:
+  push:
+    branches: [ master ]
+jobs:
+  push_to_dockerhub:
+    name: Publish Docker build image to Docker Hub + Github Registry
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v2
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Log in to GitHub Docker Registry
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GHCR_PAT }}
+      - name: Build and push to Docker Hub
+        uses: docker/build-push-action@v2
+        with:
+          push: true
+          tags: markstreet/conker:latest
+      - name: Build and push to Github registry
+        uses: docker/build-push-action@v2
+        with:
+          push: true
+          tags: ghcr.io/${{ github.repository_owner }}/conker:latest

.gitignore

@@ -2,6 +2,7 @@
 
 __pycache__/
 asm/
+assets/
 bin/
 build/
 expected/
@@ -35,4 +36,3 @@ conker/ctx.c
 
 tools/decomp-permuter
 tools/gfxdis
-tools/mips_to_c

.gitmodules

@@ -7,3 +7,6 @@
 [submodule "tools/asm-processor"]
 	path = tools/asm-processor
 	url = https://github.com/simonlindholm/asm-processor.git
+[submodule "tools/mips_to_c"]
+	path = tools/mips_to_c
+	url = git@github.com:matt-kempster/mips_to_c.git

Dockerfile

@@ -2,22 +2,15 @@ FROM ubuntu:20.04 as build
 
 ENV DEBIAN_FRONTEND=noninteractive
 
-RUN apt-get update && \
-    apt-get install -y \
-      binutils-mips-linux-gnu \
-      build-essential \
-      less \
-      libglib2.0 \
-      python3 \
-      python3-pip \
-      unzip \
-      wget
+COPY /packages.txt /
 
-RUN python3 -m pip install \
-      capstone pyyaml pycparser \
-      colorama ansiwrap watchdog python-Levenshtein cxxfilt \
-      python-ranges \
-      pypng
+RUN apt-get update && apt-get install -y $(cat /packages.txt)
+
+COPY requirements.txt /
+
+RUN python3 -m pip install -r /requirements.txt --no-cache-dir
+
+COPY .bash_aliases /root/.bash_aliases
 
 RUN mkdir /conker
 WORKDIR /conker

Makefile

@@ -5,7 +5,7 @@ BUILD_DIR  = build
 TARGET     = $(BUILD_DIR)/$(BASENAME).$(VERSION)
 GAME_DIR   = $(BASENAME)
 
-BIN_DIR    = bin
+BIN_DIR    = assets
 
 ifeq ($(VERSION),ects)
 BIN_FILES  = $(wildcard $(BIN_DIR)/*.bin)
@@ -16,11 +16,10 @@ endif
 
 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))
+RZIP_DIRS  = $(wildcard $(BIN_DIR)/rzip/assets*)
+RZIP_FILES = $(wildcard $(BIN_DIR)/rzip/assets*/assets*.bin)
 
+O_FILES    = $(foreach file,$(BIN_FILES) $(RZIP_FILES),$(BUILD_DIR)/$(file:.bin=.bin.o))
 
 CROSS   = mips-linux-gnu-
 CPP     = cpp
@@ -50,7 +49,7 @@ clean:
 	rm -rf build
 
 really-clean: clean
-	rm -rf bin
+	rm -rf assets
 	rm -rf rzip
 	make -C $(GAME_DIR) really-clean
 
@@ -71,7 +70,7 @@ $(BUILD_DIR)/$(LD_SCRIPT): $(LD_SCRIPT)
 $(TARGET).elf: $(O_FILES) $(BUILD_DIR)/$(LD_SCRIPT)
 	@$(LD) $(LDFLAGS) -o $@
 
-$(BUILD_DIR)/%.o: %.bin
+$(BUILD_DIR)/%.bin.o: %.bin
 	$(LD) -r -b binary -o $@ $<
 
 $(TARGET).bin: $(TARGET).elf
@@ -81,22 +80,22 @@ $(TARGET).z64: $(TARGET).bin
 	@cp $< $@
 
 # combine
-$(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_DIR)/$(BASENAME).$(VERSION).bin: $(BIN_DIR)/game.$(VERSION).bin
+	cat $(BIN_DIR)/header.$(VERSION).bin $(BIN_DIR)/boot.$(VERSION).bin $(BIN_DIR)/init.$(VERSION).bin $(BIN_DIR)/game.$(VERSION).bin $(BIN_DIR)/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 $< .
+$(BIN_DIR)/game.$(VERSION).bin: $(BASENAME).$(VERSION).yaml
+	$(PYTHON) tools/n64splat/split.py $<
 else
-bin/game.$(VERSION).bin: bin/game/rzip/data/0000.bin
-	cat bin/game/rzip/code/0*.bin bin/game/rzip/data/0000.bin > $@
+$(BIN_DIR)/game.$(VERSION).bin: $(BIN_DIR)/game/rzip/data/0000.bin
+	cat $(BIN_DIR)/game/rzip/code/0*.bin $(BIN_DIR)/game/rzip/data/0000.bin > $@
 
-bin/game/rzip/data/0000.bin: bin/game.$(VERSION).rzip.bin
-	$(PYTHON) tools/n64splat/split.py $< game.$(VERSION).rzip.yaml bin/game --modes bin rzip
+$(BIN_DIR)/game/rzip/data/0000.bin: $(BIN_DIR)/game.$(VERSION).rzip.bin
+	$(PYTHON) tools/n64splat/split.py game.$(VERSION).rzip.yaml --modes bin rzip
 
-bin/game.$(VERSION).rzip.bin: $(BASENAME).$(VERSION).yaml
-	$(PYTHON) tools/n64splat/split.py baserom.$(VERSION).z64 $< .
+$(BIN_DIR)/game.$(VERSION).rzip.bin: $(BASENAME).$(VERSION).yaml
+	$(PYTHON) tools/n64splat/split.py $<
 endif
 
 .baserom.$(VERSION).ok: baserom.$(VERSION).z64
@@ -105,7 +104,7 @@ endif
 
 $(EXTRACT_DIR)/00000000.bin:
 	@mkdir -p $(EXTRACT_DIR)
-	$(PYTHON) tools/extract_compressed.py config/compressed.$(VERSION).yaml bin/compressed.bin $(EXTRACT_DIR)
+	$(PYTHON) tools/extract_compressed.py config/compressed.$(VERSION).yaml $(BIN_DIR)/compressed.bin $(EXTRACT_DIR)
 
 # settings
 .PHONY: all clean default

conker.debug.yaml

@@ -1,7 +1,9 @@
-basename: conker
 options:
+  basename: conker
+  target_path: baserom.debug.z64
+  base_path: .
   compiler: IDO
-  extensions: "custom/n64splat"
+  extensions_path: tools/splat_ext
 segments:
   - name:  header.debug
     type:  bin

conker.ects.yaml

@@ -1,7 +1,9 @@
-basename: conker
 options:
+  basename: conker
+  target_path: baserom.ects.z64
+  base_path: .
   compiler: IDO
-  extensions: "custom/n64splat"
+  extensions_path: tools/splat_ext
 segments:
   - name:  header.ects
     type:  bin

conker.eu.yaml

@@ -1,7 +1,10 @@
-basename: conker
 options:
+  basename: conker
+  target_path: baserom.eu.z64
+  base_path: .
   compiler: IDO
-  extensions: "custom/n64splat"
+  extensions_path: tools/splat_ext
+  sha1: ee7bc6656fd1e1d9ffb3d19add759f28b88df710
 segments:
   - name:  header.eu
     type:  bin

conker.us.yaml

@@ -1,7 +1,10 @@
-basename: conker
 options:
+  basename: conker
+  target_path: baserom.us.z64
+  base_path: .
   compiler: IDO
-  extensions: "custom/n64splat"
+  extensions_path: tools/splat_ext
+  sha1: 4cbadd3c4e0729dec46af64ad018050eada4f47a
 segments:
   - name:  header.us
     type:  bin