New Crash Screen

Makefile

@@ -85,8 +85,8 @@ else ifeq ($(VERSION),sh)
   DEFINES += VERSION_SH=1
 endif
 
-DEBUG_MAP_STACKTRACE_FLAG := -D DEBUG_MAP_STACKTRACE
 
+# TARGET -
 TARGET := sm64
 
 
@@ -374,7 +374,7 @@ ACTOR_DIR      := actors
 LEVEL_DIRS     := $(patsubst levels/%,%,$(dir $(wildcard levels/*/header.h)))
 
 # Directories containing source files
-SRC_DIRS += src src/boot src/game src/engine src/audio src/menu src/buffers actors levels bin data assets asm lib sound
+SRC_DIRS += src src/boot src/game src/engine src/audio src/menu src/buffers src/images src/crash_screen actors levels bin data assets asm lib sound
 LIBZ_SRC_DIRS := src/libz
 GODDARD_SRC_DIRS := src/goddard src/goddard/dynlists
 BIN_DIRS := bin bin/$(VERSION)
@@ -585,7 +585,8 @@ libultra: $(BUILD_DIR)/libultra.a
 
 # Extra object file dependencies
 $(BUILD_DIR)/asm/boot.o:              $(IPL3_RAW_FILES)
-$(BUILD_DIR)/src/game/crash_screen.o: $(CRASH_TEXTURE_C_FILES)
+$(BUILD_DIR)/src/crash_screen/crash_screen.o: $(CRASH_TEXTURE_C_FILES)
+$(BUILD_DIR)/src/images/crash_screen_crashed.o: $(CRASH_TEXTURE_2_C_FILES)
 $(BUILD_DIR)/src/game/version.o:      $(BUILD_DIR)/src/game/version_data.h
 $(BUILD_DIR)/lib/aspMain.o:           $(BUILD_DIR)/rsp/audio.bin
 $(SOUND_BIN_DIR)/sound_data.o:        $(SOUND_BIN_DIR)/sound_data.ctl $(SOUND_BIN_DIR)/sound_data.tbl $(SOUND_BIN_DIR)/sequences.bin $(SOUND_BIN_DIR)/bank_sets
@@ -834,7 +835,7 @@ $(BUILD_DIR)/rsp/%.bin $(BUILD_DIR)/rsp/%_data.bin: rsp/%.s
 # Run linker script through the C preprocessor
 $(BUILD_DIR)/$(LD_SCRIPT): $(LD_SCRIPT) $(BUILD_DIR)/goddard.txt
 	$(call print,Preprocessing linker script:,$<,$@)
-	$(V)$(CPP) $(CPPFLAGS) -DBUILD_DIR=$(BUILD_DIR) $(DEBUG_MAP_STACKTRACE_FLAG) -MMD -MP -MT $@ -MF [email protected] -o $@ $<
+	$(V)$(CPP) $(CPPFLAGS) -DBUILD_DIR=$(BUILD_DIR) -MMD -MP -MT $@ -MF [email protected] -o $@ $<
 
 # Link libgoddard
 $(BUILD_DIR)/libgoddard.a: $(GODDARD_O_FILES)
@@ -847,7 +848,7 @@ $(BUILD_DIR)/libz.a: $(LIBZ_O_FILES)
 	$(V)$(AR) rcs -o $@ $(LIBZ_O_FILES)
 
 # SS2: Goddard rules to get size
-$(BUILD_DIR)/sm64_prelim.ld: sm64.ld $(O_FILES) $(YAY0_OBJ_FILES) $(SEG_FILES) $(BUILD_DIR)/libgoddard.a $(BUILD_DIR)/libz.a
+$(BUILD_DIR)/sm64_prelim.ld: $(LD_SCRIPT) $(O_FILES) $(YAY0_OBJ_FILES) $(SEG_FILES) $(BUILD_DIR)/libgoddard.a $(BUILD_DIR)/libz.a
 	$(call print,Preprocessing preliminary linker script:,$<,$@)
 	$(V)$(CPP) $(CPPFLAGS) -DPRELIMINARY=1 -DBUILD_DIR=$(BUILD_DIR) -MMD -MP -MT $@ -MF [email protected] -o $@ $<
 

Makefile.split

@@ -260,11 +260,14 @@ $(BUILD_DIR)/bin/%_skybox.elf: SEGMENT_ADDRESS := 0x0A000000
 # --------------------------------------
 
 # intro and ipl3 textures are not compressed
-INTRO_RAW_FILES              := $(wildcard $(TEXTURE_DIR)/intro_raw/*.png)
+INTRO_RAW_FILES             := $(wildcard $(TEXTURE_DIR)/intro_raw/*.png)
 $(BUILD_DIR)/src/goddard/renderer.o: $(addprefix $(BUILD_DIR)/,$(patsubst %.png,%.inc.c,$(INTRO_RAW_FILES)))
 
 IPL3_TEXTURE_FILES          := $(wildcard $(TEXTURE_DIR)/ipl3_raw/*.png)
 IPL3_RAW_FILES              := $(addprefix $(BUILD_DIR)/,$(patsubst %.png,%,$(IPL3_TEXTURE_FILES)))
 
-CRASH_TEXTURE_FILES         := $(wildcard $(TEXTURE_DIR)/crash_custom/*.png)
+CRASH_TEXTURE_FILES         := $(wildcard $(TEXTURE_DIR)/crash_screen/*.png)
 CRASH_TEXTURE_C_FILES       := $(addprefix $(BUILD_DIR)/,$(patsubst %.png,%.inc.c,$(CRASH_TEXTURE_FILES)))
+
+CRASH_TEXTURE_2_FILES       := $(wildcard $(TEXTURE_DIR)/crash_custom/*.png)
+CRASH_TEXTURE_2_C_FILES     := $(addprefix $(BUILD_DIR)/,$(patsubst %.png,%.inc.c,$(CRASH_TEXTURE_2_FILES)))

README.md

@@ -21,7 +21,7 @@ This is a fork of the ultrasm64 repo by CrashOveride which includes the followin
 - **Fazana**: PuppyLib, ucode swapping, audio load time optimisations (with Arctic), general hacker qol improvements, visual debug
 - **Reonu**: Starting the project/repo, widescreen, reonucam, various defines for hacker QoL
 - **JoshDuMan**: Decomp guy, general assistance
-- **Arceveti**: Silhouette, shadow optimisation, better hanging, breath meter
+- **Arceveti**: New crash screen, silhouette, shadow optimisation, better hanging, breath meter
 - **axollyon**: Console testing, bugfixes, idea-guying, and had a hand in silhouettes
 - **Wiseguy**:  World scale reimplementation, silhouette, graph node optimisations, instant input patch, cake screen fix, segmented code support, and various optimizations/fixes
 - **Kaze**: Graph node optimisations, automatic optimal collision distance

include/config.h

@@ -5,6 +5,11 @@
  * A catch-all file for configuring various bugfixes and other settings in SM64
  */
 
+
+// HackerSM64 version number. DO NOT CHANGE THIS UNLESS YOU ARE A HACKERSM64 DEVELOPER.
+#define HACKERSM64_VERSION "2.1.0 beta"
+
+
 #include "config/config_audio.h"
 #include "config/config_benchmark.h"
 #include "config/config_camera.h"

include/config/config_debug.h

@@ -8,7 +8,7 @@
 // #define DEBUG_ALL
 
 // Disables all debug options (except PUPPYPRINT).
-#define DISABLE_ALL
+// #define DISABLE_ALL
 
 // Enables a comprehensive standalone profiler. Automatically enabled by PUPPYPRINT_DEBUG.
 // If not using PUPPYPRINT_DEBUG, press L to toggle the profiler.
@@ -55,3 +55,19 @@
 
 // Forces a crash when the game starts. Useful for debugging the crash screen.
 // #define DEBUG_FORCE_CRASH_ON_BOOT
+
+// Forces a crash when the player presses L in-game.
+#define DEBUG_FORCE_CRASH_ON_L
+
+// Enables the DEBUG_ASSERT macro.
+#define ENABLE_DEBUG_ASSERTS
+
+// Includes function map data in the ROM.
+#define INCLUDE_DEBUG_MAP
+
+// Includes an image which displays when the crash screen crashes.
+// Uses 38.4 KB of rom space.
+#define CRASH_SCREEN_CRASH_SCREEN
+
+// Plays a Mario "WAAAOOOW" sound effect when the game crashes.
+// #define FUNNY_CRASH_SOUND

include/config/config_rom.h

@@ -12,11 +12,16 @@
 // Currently not recommended, as it may cause random crashes.
 // #define ENABLE_RUMBLE (1 || VERSION_SH)
 
-// Screen Size Defines.
-#define SCREEN_WIDTH  320
-#define SCREEN_HEIGHT 240
-
 // Height of the black borders at the top and bottom of the screen for NTSC Versions. You can set it to different values for console and emulator.
 // There is generally no reason to have a value other than 0 for emulator. As for console, it provides a (small) performance boost.
 #define BORDER_HEIGHT_CONSOLE  0
 #define BORDER_HEIGHT_EMULATOR 0
+
+// Screen Size Defines.
+#define SCREEN_WIDTH  320
+#define SCREEN_HEIGHT 240
+
+// Don't change these.
+#define SCREEN_CENTER_X (SCREEN_WIDTH  / 2)
+#define SCREEN_CENTER_Y (SCREEN_HEIGHT / 2)
+#define SCREEN_SIZE (SCREEN_WIDTH * SCREEN_HEIGHT)

include/config/config_safeguards.h

@@ -75,6 +75,7 @@
 
 #ifdef DISABLE_ALL
     #undef DEBUG_ALL
+    #undef USE_PROFILER
     #undef TEST_LEVEL
     #undef DEBUG_LEVEL_SELECT
     #undef ENABLE_DEBUG_FREE_MOVE
@@ -86,7 +87,11 @@
     #undef UNLOCK_ALL
     #undef COMPLETE_SAVE_FILE
     #undef DEBUG_FORCE_CRASH_ON_BOOT
-    #undef USE_PROFILER
+    #undef DEBUG_FORCE_CRASH_ON_L
+    #undef ENABLE_DEBUG_ASSERTS
+    #undef INCLUDE_DEBUG_MAP
+    #undef CRASH_SCREEN_CRASH_SCREEN
+    #undef FUNNY_CRASH_SOUND
 #endif // DISABLE_ALL
 
 #ifdef DEBUG_ALL

include/macros.h

@@ -25,52 +25,60 @@
 #define UNUSED
 #endif
 
+// Avoid undefined behaviour for non-returning functions
 #ifdef __GNUC__
-#define FALL_THROUGH __attribute__((fallthrough))
+#define NORETURN __attribute__((noreturn))
 #else
-#define FALL_THROUGH
+#define NORETURN
 #endif
 
-// Avoid undefined behaviour for non-returning functions
+// Always inline a function
 #ifdef __GNUC__
-#define NORETURN __attribute__((noreturn))
+#define ALWAYS_INLINE inline __attribute__((always_inline))
 #else
-#define NORETURN
+#define ALWAYS_INLINE inline
 #endif
 
-// Static assertions
+// Fall through a switch case
 #ifdef __GNUC__
-#define STATIC_ASSERT(cond, msg) _Static_assert(cond, msg)
+#define FALL_THROUGH __attribute__((fallthrough))
 #else
-#define STATIC_ASSERT(cond, msg) typedef char GLUE2(static_assertion_failed, __LINE__)[(cond) ? 1 : -1]
+#define FALL_THROUGH
 #endif
 
-// Align to 8-byte boundary for DMA requirements
+// Align to 8-byte boundary (for DMA requirements)
 #ifdef __GNUC__
 #define ALIGNED8 __attribute__((aligned(8)))
 #else
 #define ALIGNED8
 #endif
 
-// Align to 16-byte boundary for audio lib requirements
+// Align to 16-byte boundary (for audio lib requirements)
 #ifdef __GNUC__
 #define ALIGNED16 __attribute__((aligned(16)))
 #else
 #define ALIGNED16
 #endif
 
-// Align to 16-byte boundary for audio lib requirements
+// Align to 32-byte boundary
+#ifdef __GNUC__
+#define ALIGNED32 __attribute__((aligned(32)))
+#else
+#define ALIGNED32
+#endif
+
+// Align to 64-byte boundary
 #ifdef __GNUC__
 #define ALIGNED64 __attribute__((aligned(64)))
 #else
 #define ALIGNED64
 #endif
 
-// Align to 16-byte boundary for audio lib requirements
+// Static assertions
 #ifdef __GNUC__
-#define ALWAYS_INLINE inline __attribute__((always_inline))
+#define STATIC_ASSERT(cond, msg) _Static_assert(cond, msg)
 #else
-#define ALWAYS_INLINE inline
+#define STATIC_ASSERT(cond, msg) typedef char GLUE2(static_assertion_failed, __LINE__)[(cond) ? 1 : -1]
 #endif
 
 #ifndef NO_SEGMENTED_MEMORY

include/segments.h

@@ -41,6 +41,4 @@
 #define SEG_POOL_START   _framebuffersSegmentBssEnd // 0x0165000 in size
 #define POOL_SIZE        RAM_END - SEG_POOL_START
 
-#define MAP_PARSER_ADDRESS 0x80345678
-
 #endif // SEGMENTS_H

include/sm64.h

@@ -15,11 +15,21 @@
 #include "macros.h"
 #include "segments.h"
 
-// Crash handler enhancement
-#ifdef CRASH_SCREEN_INCLUDED
-#define DEBUG_ASSERT(exp) do { if (!(exp)) _n64_assert(__FILE__, __LINE__, #exp, 1); } while (0)
+extern char *__n64Assert_Filename;
+extern u32   __n64Assert_LineNum;
+extern char *__n64Assert_Message;
+extern void __n64Assert(char *fileName, u32 lineNum, char *message);
+
+#define ASSERT(cond, message) do {\
+    if (!(cond)) { \
+        __n64Assert(__FILE__, __LINE__, (message)); \
+    } \
+} while (0);
+
+#ifdef ENABLE_DEBUG_ASSERTS
+#define DEBUG_ASSERT(cond, message) ASSERT(cond, message)
 #else
-#define DEBUG_ASSERT(exp)
+#define DEBUG_ASSERT(cond, message)
 #endif
 
 // Pointer casting is technically UB, and avoiding it gets rid of endian issues as well as a nice side effect.

include/types.h

@@ -21,9 +21,6 @@
     }                               \
 }
 
-#define SCREEN_CENTER_X (SCREEN_WIDTH  / 2)
-#define SCREEN_CENTER_Y (SCREEN_HEIGHT / 2)
-
 struct Config {
     f32 audioFrequency;
 #ifdef WIDE

sm64.ld

@@ -146,11 +146,11 @@ SECTIONS
 #endif
 
 /* hardcoded symbols to satisfy preliminary link for map parser */
-#ifndef DEBUG_MAP_STACKTRACE
-      _mapDataSegmentRomStart = 0;
-      gMapEntries   = 0;
-      gMapEntrySize = 0;
-      gMapStrings   = 0;
+#if defined(INCLUDE_DEBUG_MAP) && defined(PRELIMINARY)
+   _mapDataSegmentRomStart = 0;
+   gMapEntries   = 0;
+   gMapEntrySize = 0;
+   gMapStrings   = 0;
 #endif
 
    BEGIN_SEG(main, .) SUBALIGN(16)
@@ -162,6 +162,7 @@ SECTIONS
 #endif
 
       BUILD_DIR/src/boot*.o(.text*);
+      BUILD_DIR/src/crash_screen*.o(.text*);
       BUILD_DIR/src/hvqm*.o(.text*);
       BUILD_DIR/src/usb*.o(.text*);
       BUILD_DIR/src/audio*.o(.text*);
@@ -188,6 +189,7 @@ SECTIONS
       /* data */
       BUILD_DIR/asm/n64_assert.o(.*data*);
       BUILD_DIR/src/boot*.o(.*data*);
+      BUILD_DIR/src/crash_screen*.o(.*data*);
       BUILD_DIR/src/audio*.o(.*data*);
 #ifdef S2DEX_TEXT_ENGINE
       lib/libs2d_engine.a:*(.*data*);
@@ -207,6 +209,7 @@ SECTIONS
 
       /* rodata */
       BUILD_DIR/src/boot*.o(.rodata*);
+      BUILD_DIR/src/crash_screen*.o(.rodata*);
       BUILD_DIR/src/usb*.o(.rodata*);
       BUILD_DIR/src/audio*.o(.rodata*);
 #ifdef S2DEX_TEXT_ENGINE
@@ -227,6 +230,7 @@ SECTIONS
    BEGIN_NOLOAD(main)
    {
       BUILD_DIR/src/boot*.o(.*bss*);
+      BUILD_DIR/src/crash_screen*.o(.*bss*);
       BUILD_DIR/src/hvqm*.o(.*bss*);
       BUILD_DIR/src/usb*.o(.*bss*);
       BUILD_DIR/src/audio*.o(.*bss*);
@@ -532,8 +536,17 @@ SECTIONS
 	END_SEG(capcom)
 #endif
 
-#ifdef DEBUG_MAP_STACKTRACE
-   BEGIN_SEG(mapData, (RAM_END - 0x00100000)) {
+#ifdef CRASH_SCREEN_CRASH_SCREEN
+   . = ALIGN(0x40);
+   BEGIN_SEG(crash_screen_crash_screen, __romPos)
+   {
+      KEEP(BUILD_DIR/src/images/crash_screen_crashed.o(.rodata*));
+   }
+   END_SEG(crash_screen_crash_screen)
+#endif
+
+#if defined(INCLUDE_DEBUG_MAP) && !defined(PRELIMINARY)
+   BEGIN_SEG(mapData, (RAM_END - RAM_1MB)) {
       KEEP(BUILD_DIR/asm/debug/map.o(.data*));
    }
    END_SEG(mapData)

src/boot/main.c

@@ -11,6 +11,7 @@
 #include "game/sound_init.h"
 #include "buffers/buffers.h"
 #include "segments.h"
+#include "crash_screen/crash_screen.h"
 #include "game/main.h"
 #include "game/rumble_init.h"
 #include "game/version.h"
@@ -318,8 +319,6 @@ void check_cache_emulation() {
     __osRestoreInt(saved);
 }
 
-extern void crash_screen_init(void);
-
 void thread3_main(UNUSED void *arg) {
     setup_mesg_queues();
     alloc_pool();

src/buffers/framebuffers.h

@@ -14,4 +14,6 @@ extern RGBA16 gFramebuffers[3][SCREEN_WIDTH * SCREEN_HEIGHT];
 #define gFramebuffer1 gFramebuffers[1]
 #define gFramebuffer2 gFramebuffers[2]
 
+#define FRAMEBUFFER_SIZE (SCREEN_SIZE * sizeof(RGBA16))
+
 #endif // FRAMEBUFFERS_H