Applid Clang format on the branch

.github/workflows/clang-format-suggest.yml

@@ -3,6 +3,8 @@ on: [pull_request]
 jobs:
   formatting-check:
     runs-on: ubuntu-24.04
+    permissions:
+      pull-requests: write
     steps:
       - uses: actions/checkout@v4
       - name: Install Dependance

.github/workflows/clang-pr.yml

@@ -1,5 +1,8 @@
 name: clang-format PR
-on: [push]
+on:
+  push:
+    branches:
+      - master
 jobs:
   formatting-check:
     runs-on: ubuntu-24.04
@@ -15,6 +18,6 @@ jobs:
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v7
         with:
-          commit-message: clang format
-          title: Applid Clang format on the branch
+          commit-message: Clang Format
+          title: Clang Format
           branch: clang-format

Makefile

@@ -32,31 +32,40 @@ $(eval $(call validate-option,COMPILER,ido gcc))
 # Run make clean first
 DEBUG ?= 0
 
+# Avoid undefined behavior. Enables shiftability when making changes
+AVOID_UB ?= 0
+
 # Compile with GCC
 GCC ?= 0
 
 # VERSION - selects the version of the game to build
-#   us - builds the 1997 North American version
-#   eu - builds the 1997 1.1 PAL version
+#  us     - builds the 1997 North American version
+#  eu.v10 - builds the 1997 1.0 PAL version
+#  eu.v11 - builds the 1997 1.1 PAL version
 VERSION ?= us
-$(eval $(call validate-option,VERSION,us eu-1.0 eu-final))
+$(eval $(call validate-option,VERSION,us eu.v10 eu.v11))
 
 ifeq      ($(VERSION),us)
   DEFINES += VERSION_US=1
   GRUCODE   ?= f3dex_old
-else ifeq ($(VERSION),eu-1.0)
-  DEFINES += VERSION_EU=1 VERSION_EU_1_0=1
+else ifeq ($(VERSION),eu.v10)
+  DEFINES += VERSION_EU=1 VERSION_EU_V10=1
   GRUCODE   ?= f3dex_old
-else ifeq ($(VERSION),eu-final)
-  DEFINES += VERSION_EU=1 VERSION_EU_1_1=1
+else ifeq ($(VERSION),eu.v11)
+  DEFINES += VERSION_EU=1 VERSION_EU_V11=1
   GRUCODE   ?= f3dex_old
 endif
 
 ifeq ($(DEBUG),1)
   DEFINES += DEBUG=1
+  DEFINES += AVOID_UB=1
   COMPARE ?= 0
 endif
 
+ifeq ($(AVOID_UB),1)
+  DEFINES += AVOID_UB=1
+endif
+
 TARGET := mk64.$(VERSION)
 
 BASEROM := baserom.$(VERSION).z64
@@ -244,7 +253,7 @@ include $(MAKEFILE_SPLIT)
 # These are files that need to be encoded into EUC-JP in order for the ROM to match
 # We filter them out from the regular C_FILES since we don't need nor want the
 # UTF-8 versions getting compiled
-EUC_JP_FILES := src/ending/credits.c src/code_80005FD0.c src/code_80091750.c
+EUC_JP_FILES := src/ending/credits.c src/cpu_vehicles_camera_path.c src/menu_items.c
 C_FILES := $(filter-out %.inc.c,$(filter-out $(EUC_JP_FILES),$(foreach dir,$(SRC_DIRS),$(wildcard $(dir)/*.c))))
 S_FILES := $(foreach dir,$(ASM_DIRS),$(wildcard $(dir)/*.s))
 # Include source files in courses/course_name/files.c but exclude .inc.c files.
@@ -349,7 +358,7 @@ CC_CHECK ?= gcc
 CC_CHECK_CFLAGS := -fsyntax-only -fsigned-char $(CC_CFLAGS) $(TARGET_CFLAGS) -std=gnu90 -Wall -Wempty-body -Wextra -Wno-format-security -Wno-main -DNON_MATCHING -DAVOID_UB $(DEF_INC_CFLAGS)
 
 # C compiler options
-HIDE_WARNINGS := -woff 838,649
+HIDE_WARNINGS := -woff 838,649,807
 CFLAGS = -G 0 $(OPT_FLAGS) $(TARGET_CFLAGS) $(MIPSISET) $(DEF_INC_CFLAGS)
 ifeq ($(COMPILER),gcc)
   CFLAGS += -mno-shared -march=vr4300 -mfix4300 -mabi=32 -mhard-float -mdivide-breaks -fno-stack-protector -fno-common -fno-zero-initialized-in-bss -fno-PIC -mno-abicalls -fno-strict-aliasing -fno-inline-functions -ffreestanding -fwrapv -Wall -Wextra

README.md

@@ -1,44 +1,32 @@
 # Mario Kart 64   
-This work-in-progress decompilation of Mario Kart 64 pursues historical and educational elements within the game found via taking it apart and putting it back together. Inspiration to do so not only emanates from the game's hardware and technology but also its immensely positive effects on the cultures and families of nearly every nationality.
+This decompilation of Mario Kart 64 pursues historical and educational elements within the game found via taking it apart and putting it back together. Inspiration to do so not only emanates from the game's hardware and technology but also its immensely positive effects on the cultures and families of nearly every nationality.
 
 This repository does not contain assets. Compiling requires asset extraction from a prior copy of the game.
 
 It supports and builds the following versions:
 
-| ROM Output        | Revision| SHA-1 Checksum                           |
-|-------------------|---------|------------------------------------------|
-| mk64.us.z64       | USA     | 579c48e211ae952530ffc8738709f078d5dd215e |
-| mk64.eu-1.0.z64   | EUR 1.0 | a729039453210b84f17019dda3f248d5888f7690 |
-| mk64.eu-final.z64 | EUR 1.1 | f6b5f519dd57ea59e9f013cc64816e9d273b2329 |
-
-[![Linux Compile](https://github.com/n64decomp/mk64/actions/workflows/linux-compile.yml/badge.svg)](https://github.com/n64decomp/mk64/actions/workflows/linux-compile.yml)
+| ROM Output      | Revision| SHA-1 Checksum                           |
+|-----------------|---------|------------------------------------------|
+| mk64.us.z64     | USA     | 579c48e211ae952530ffc8738709f078d5dd215e |
+| mk64.eu.v10.z64 | EUR 1.0 | a729039453210b84f17019dda3f248d5888f7690 |
+| mk64.eu.v11.z64 | EUR 1.1 | f6b5f519dd57ea59e9f013cc64816e9d273b2329 |
 
 ## Progress
 
-Total progress consists of all code segments together.
-
-Game code progress consists of `main`, `ending` and `racing`.
+[![Linux Compile](https://github.com/n64decomp/mk64/actions/workflows/linux-compile.yml/badge.svg)](https://github.com/n64decomp/mk64/actions/workflows/linux-compile.yml)
 
 ![Build Status](https://n64decomp.github.io/mk64/total_progress.svg)
-![Build Status](https://n64decomp.github.io/mk64/game_progress.svg)
-
-![Build Status](https://n64decomp.github.io/mk64/asm_funcs.svg)
-![Build Status](https://n64decomp.github.io/mk64/m2c_funcs.svg)
-![Build Status](https://n64decomp.github.io/mk64/nonmatching_funcs.svg)
-
-- ![Build Status](https://n64decomp.github.io/mk64/seg_main_progress.svg)
-- ![Build Status](https://n64decomp.github.io/mk64/seg_ending_progress.svg)
-- ![Build Status](https://n64decomp.github.io/mk64/seg_racing_progress.svg)
-- ![Build Status](https://n64decomp.github.io/mk64/audio_progress.svg)
-- ![Build Status](https://n64decomp.github.io/mk64/libultra_progress.svg)
 
 ## Quick Start
 
 ```
 git submodule update --init --recursive
+OR
+git clone https://github.com/n64decomp/mk64 --recurse-submodules
 ```
 Extract assets
 ```
+make -C tools -j
 make assets -j
 make -j
 ```
@@ -50,7 +38,8 @@ See also, the comprehensive API and documentation which includes an overview of
 
 ## Current State
 
-The code-base may change significanty overtime as naming and documentation continues. The code-base is shiftable.
+The code-base may change significanty overtime as naming and documentation continues.
+Adjustments to the game require compiling with AVOID_UB=1 to enable shiftability. Use DEBUG=1 to enable the games debug mode.
 
 Some menu textures are compressed using a format called tkmk00. A byte-matching compressor/decompressor does not yet exist.