Merge pull request #757 from HackerN64/master

Merge HackerSM64 2.1.3 release into 2.2.0

Dockerfile

@@ -1,17 +1,18 @@
-FROM ubuntu:18.04 as build
+FROM ubuntu:22.04 as build
 
 RUN apt-get update && \
     apt-get install -y \
         binutils-mips-linux-gnu \
-        bsdmainutils \
+        bsdextrautils \
         build-essential \
+        gcc-mips-linux-gnu \
         libcapstone-dev \
         pkgconf \
         python3
 
-RUN mkdir /sm64
-WORKDIR /sm64
-ENV PATH="/sm64/tools:${PATH}"
+RUN mkdir /hackersm64
+WORKDIR /hackersm64
+ENV PATH="/hackersm64/tools:${PATH}"
 
-CMD echo 'usage: docker run --rm --mount type=bind,source="$(pwd)",destination=/sm64 sm64 make VERSION=us -j4\n' \
-         'see https://github.com/n64decomp/sm64/blob/master/README.md for advanced usage'
+CMD echo 'Usage: docker run --rm -v ${PWD}:/hackersm64 hackersm64 make VERSION=us -j4\n' \
+         'See https://github.com/HackerN64/HackerSM64/blob/master/README.md for more information'

VERSION.txt

@@ -1 +1 @@
-v2.1.2
+v2.1.3

bin/segment2.c

@@ -2374,8 +2374,8 @@ static const Vtx vertex_ia8_char[] = {
 #else
     {{{     0,      0,      0}, 0, {     0,    256}, {0xff, 0xff, 0xff, 0xff}}},
     {{{     8,      0,      0}, 0, {     0,      0}, {0xff, 0xff, 0xff, 0xff}}},
-    {{{     8,     16,      0}, 0, {   480,      0}, {0xff, 0xff, 0xff, 0xff}}},
-    {{{     0,     16,      0}, 0, {   480,    256}, {0xff, 0xff, 0xff, 0xff}}},
+    {{{     8,     16,      0}, 0, {   512,      0}, {0xff, 0xff, 0xff, 0xff}}},
+    {{{     0,     16,      0}, 0, {   512,    256}, {0xff, 0xff, 0xff, 0xff}}},
 #endif
 };
 
@@ -2394,11 +2394,11 @@ const Gfx dl_ia_text_begin[] = {
 
 // 0x020073E8 - 0x02007418
 const Gfx dl_ia_text_tex_settings[] = {
-    gsDPSetTile(G_IM_FMT_IA, G_IM_SIZ_16b, 0, 0, G_TX_LOADTILE, 0, (G_TX_WRAP | G_TX_MIRROR), 3, G_TX_NOLOD, (G_TX_WRAP | G_TX_MIRROR), 4, G_TX_NOLOD),
+    gsDPSetTile(G_IM_FMT_IA, G_IM_SIZ_16b, 0, 0, G_TX_LOADTILE, 0, G_TX_WRAP | G_TX_NOMIRROR, 3, G_TX_NOLOD, G_TX_WRAP | G_TX_NOMIRROR, 4, G_TX_NOLOD),
     gsDPLoadSync(),
-    gsDPLoadBlock(G_TX_LOADTILE, 0, 0, ((((16 * 8) + G_IM_SIZ_4b_INCR) >> G_IM_SIZ_4b_SHIFT) - 1), CALC_DXT(16, G_IM_SIZ_4b_BYTES)),
-    gsDPSetTile(G_IM_FMT_IA, G_IM_SIZ_4b, 1, 0, G_TX_RENDERTILE, 0, (G_TX_WRAP | G_TX_MIRROR), 3, G_TX_NOLOD, (G_TX_WRAP | G_TX_MIRROR), 4, G_TX_NOLOD),
-    gsDPSetTileSize(0, 0, 0, ((16 - 1) << G_TEXTURE_IMAGE_FRAC), ((8 - 1) << G_TEXTURE_IMAGE_FRAC)),
+    gsDPLoadBlock(G_TX_LOADTILE, 0, 0, ((16 * 8 + G_IM_SIZ_4b_INCR) >> G_IM_SIZ_4b_SHIFT) - 1, CALC_DXT(16, G_IM_SIZ_4b_BYTES)),
+    gsDPSetTile(G_IM_FMT_IA, G_IM_SIZ_4b, 1, 0, G_TX_RENDERTILE, 0, G_TX_WRAP | G_TX_NOMIRROR, 3, G_TX_NOLOD, G_TX_WRAP | G_TX_NOMIRROR, 4, G_TX_NOLOD),
+    gsDPSetTileSize(0, 0, 0, (16 - 1) << G_TEXTURE_IMAGE_FRAC, (8 - 1) << G_TEXTURE_IMAGE_FRAC),
     gsSPVertex(vertex_ia8_char, 4, 0),
     gsSP2Triangles( 0,  1,  2, 0x0, 0,  2,  3, 0x0),
     gsSPEndDisplayList(),

bin/title_screen_bg.c

@@ -143,7 +143,8 @@ const Gfx title_screen_bg_dl_face_easter_egg_end[] = {
 };
 #endif
 
-#if defined(VERSION_SH)
+// Not part of segment2, but define still covers same use case
+#if (defined(COMPLETE_EN_US_SEGMENT2) && ENABLE_RUMBLE)
 ALIGNED8 static const Texture title_texture_rumble_pak[] = {
 #include "textures/title_screen_bg/title_screen_bg.06648.rgba16.inc.c"
 };

include/config/config_debug.h

@@ -14,6 +14,10 @@
  */
 // #define DISABLE_ALL
 
+
+///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+
 /**
  * Enables a comprehensive standalone profiler. Automatically enabled by PUPPYPRINT_DEBUG.
  * If not using PUPPYPRINT_DEBUG, press L + D-Pad Up to toggle the profiler.
@@ -85,3 +89,8 @@
  * Forces a crash when the game starts. Useful for debugging the crash screen.
  */
 // #define DEBUG_FORCE_CRASH_ON_BOOT
+
+/**
+ * Intentionally crash the game whenever a runtime assertion fails (also invoked by the DEBUG define in the Makefile).
+ */
+#define DEBUG_ASSERTIONS

include/config/config_game.h

@@ -71,7 +71,7 @@
 // #define DIALOG_INDICATOR
 
 /**
- * Include the English characters that were missing from US segment2
+ * Include the English characters that were missing from US segment2 and the rumble pak texture if using rumble.
  * J, Q, V, X, Z, ¨, !, !!, ?, &, %, ., and the beta key.
  * [MAKE SURE TO INCLUDE EU AND JP/SH BASEROMS IN THE REPO TO OBTAIN THE ASSETS]
  * If this is disabled, backup assets will be used.

include/config/config_graphics.h

@@ -141,9 +141,10 @@
 #define DEFAULT_CULLING_RADIUS 300
 
 /**
- * Eases the textured screen transitions to make them look smoother.
+ * Eases the textured screen transitions to make them look smoother. 
+ * Extends the full radius for mario, bowser and the star transitions.
  */
-#define EASE_IN_OUT_TRANSITIONS
+// #define POLISHED_TRANSITIONS
 
 /**
  * Uses frustratio of 2 instead of 1.

include/config/config_safeguards.h

@@ -55,21 +55,26 @@
 
 #ifdef DISABLE_ALL
     #undef DEBUG_ALL
+    #undef USE_PROFILER
     #undef TEST_LEVEL
     #undef DEBUG_LEVEL_SELECT
     #undef ENABLE_DEBUG_FREE_MOVE
-    #undef VANILLA_DEBUG
-    #undef VANILLA_STYLE_CUSTOM_DEBUG
     #undef PUPPYPRINT_DEBUG
     #undef PUPPYPRINT_DEBUG_CYCLES
+    #undef VANILLA_STYLE_CUSTOM_DEBUG
     #undef VISUAL_DEBUG
     #undef UNLOCK_ALL
     #undef COMPLETE_SAVE_FILE
+    #undef UNLOCK_FPS
+    #undef VANILLA_DEBUG
     #undef DEBUG_FORCE_CRASH_ON_BOOT
-    #undef USE_PROFILER
+    #undef DEBUG_ASSERTIONS
 #endif // DISABLE_ALL
 
 #ifdef DEBUG_ALL
+    #undef USE_PROFILER
+    #define USE_PROFILER
+
     #undef DEBUG_LEVEL_SELECT
     #define DEBUG_LEVEL_SELECT
 
@@ -90,6 +95,9 @@
 
     #undef COMPLETE_SAVE_FILE
     #define COMPLETE_SAVE_FILE
+
+    #undef DEBUG_ASSERTIONS
+    #define DEBUG_ASSERTIONS
 #endif // DEBUG_ALL
 
 #ifdef PUPPYPRINT_DEBUG
@@ -104,6 +112,11 @@
     #define UNLOCK_ALL
 #endif // COMPLETE_SAVE_FILE
 
+#ifdef DEBUG
+    #undef DEBUG_ASSERTIONS
+    #define DEBUG_ASSERTIONS
+#endif // DEBUG
+
 
 /*****************
  * config_camera.h

include/geo_commands.h

@@ -58,6 +58,8 @@ enum GeoLayoutCommands {
     /*0x1E*/ GEO_CMD_NOP_1E,
     /*0x1F*/ GEO_CMD_NOP_1F,
     /*0x20*/ GEO_CMD_NODE_CULLING_RADIUS,
+
+    GEO_CMD_COUNT,
 };
 
 // geo layout macros

levels/intro/geo.c

@@ -75,7 +75,7 @@ const GeoLayout intro_geo_mario_head_regular[] = {
          GEO_CLOSE_NODE(),
       GEO_CLOSE_NODE(),
 #endif
-#ifdef ENABLE_RUMBLE
+#if (defined(COMPLETE_EN_US_SEGMENT2) && ENABLE_RUMBLE)
       GEO_ZBUFFER(0),
       GEO_OPEN_NODE(),
          GEO_ASM(INTRO_CONTEXT_NORMAL, geo_intro_rumble_pak_graphic),
@@ -111,7 +111,7 @@ const GeoLayout intro_geo_mario_head_dizzy[] = {
          GEO_CLOSE_NODE(),
       GEO_CLOSE_NODE(),
 #endif
-#ifdef ENABLE_RUMBLE
+#if (defined(COMPLETE_EN_US_SEGMENT2) && ENABLE_RUMBLE)
       GEO_ZBUFFER(0),
       GEO_OPEN_NODE(),
          GEO_ASM(INTRO_CONTEXT_GAME_OVER, geo_intro_rumble_pak_graphic),

src/audio/synthesis.c

@@ -444,9 +444,18 @@ u64 *synthesis_do_one_audio_update(s16 *aiBuf, u32 bufLen, u64 *cmd, s32 updateI
             aResample(cmd++, gSynthesisReverb.resampleFlags, (u16) gSynthesisReverb.resampleRate, VIRTUAL_TO_PHYSICAL2(gSynthesisReverb.resampleStateLeft));
             aSetBuffer(cmd++, 0, t4 + DMEM_ADDR_WET_RIGHT_CH, DMEM_ADDR_RIGHT_CH, bufLen);
             aResample(cmd++, gSynthesisReverb.resampleFlags, (u16) gSynthesisReverb.resampleRate, VIRTUAL_TO_PHYSICAL2(gSynthesisReverb.resampleStateRight));
+#ifdef BETTER_REVERB
+            // NOTE: Technically using an if/else here means using BETTER_REVERB vanilla presets with downsampling won't match 1-to-1 in volume with BETTER_REVERB being disabled.
+            // This chunk is actually preferable to what vanilla uses, but was mainly ifdef'd here as a means of documenting BETTER_REVERB changes for other non-HackerSM64 repos.
+            // Please use this chunk over the latter if matching BETTER_REVERB behavior ever becomes a future priority.
             aDMEMMove(cmd++, DMEM_ADDR_LEFT_CH, DMEM_ADDR_WET_LEFT_CH, DEFAULT_LEN_2CH);
             aSetBuffer(cmd++, 0, 0, 0, DEFAULT_LEN_2CH);
             aMix(cmd++, 0, /*gain*/ 0x8000 + gSynthesisReverb.reverbGain, /*in*/ DMEM_ADDR_WET_LEFT_CH, /*out*/ DMEM_ADDR_WET_LEFT_CH);
+#else
+            aSetBuffer(cmd++, 0, 0, 0, DEFAULT_LEN_2CH);
+            aMix(cmd++, 0, /*gain*/ 0x8000 + gSynthesisReverb.reverbGain, /*in*/ DMEM_ADDR_LEFT_CH, /*out*/ DMEM_ADDR_LEFT_CH);
+            aDMEMMove(cmd++, DMEM_ADDR_LEFT_CH, DMEM_ADDR_WET_LEFT_CH, DEFAULT_LEN_2CH);
+#endif
         }
 
         AUDIO_PROFILER_SWITCH(PROFILER_TIME_SUB_AUDIO_SYNTHESIS_ENVELOPE_REVERB, PROFILER_TIME_SUB_AUDIO_SYNTHESIS_PROCESSING);

src/engine/geo_layout.c

@@ -5,6 +5,7 @@
 #include "math_util.h"
 #include "game/memory.h"
 #include "graph_node.h"
+#include "game/debug.h"
 
 typedef void (*GeoLayoutCommandProc)(void);
 
@@ -771,6 +772,7 @@ struct GraphNode *process_geo_layout(struct AllocOnlyPool *pool, void *segptr) {
     gGeoLayoutStack[1] = 0;
 
     while (gGeoLayoutCommand != NULL) {
+        assert((gGeoLayoutCommand[0x00] < GEO_CMD_COUNT), "Invalid or unloaded geo layout detected.");
         GeoLayoutJumpTable[gGeoLayoutCommand[0x00]]();
     }
 

src/engine/level_script.c

@@ -9,6 +9,7 @@
 #include "buffers/framebuffers.h"
 #include "buffers/zbuffer.h"
 #include "game/area.h"
+#include "game/debug.h"
 #include "game/game_init.h"
 #include "game/mario.h"
 #include "game/memory.h"
@@ -430,6 +431,7 @@ static void level_cmd_load_model_from_dl(void) {
     s16 layer = CMD_GET(u16, 0x8);
     void *dl_ptr = CMD_GET(void *, 4);
 
+    assert(model < MODEL_ID_COUNT, "Tried to load an invalid model ID.");
     if (model < MODEL_ID_COUNT) {
         gLoadedGraphNodes[model] =
             (struct GraphNode *) init_graph_node_display_list(sLevelPool, 0, layer, dl_ptr);
@@ -442,6 +444,7 @@ static void level_cmd_load_model_from_geo(void) {
     ModelID16 model = CMD_GET(ModelID16, 2);
     void *geo = CMD_GET(void *, 4);
 
+    assert(model < MODEL_ID_COUNT, "Tried to load an invalid model ID.");
     if (model < MODEL_ID_COUNT) {
         gLoadedGraphNodes[model] = process_geo_layout(sLevelPool, geo);
     }
@@ -455,6 +458,7 @@ static void level_cmd_23(void) {
     void *dl  = CMD_GET(void *, 4);
     s32 scale = CMD_GET(s32, 8);
 
+    assert(model < MODEL_ID_COUNT, "Tried to load an invalid model ID.");
     if (model < MODEL_ID_COUNT) {
         // GraphNodeScale has a GraphNode at the top. This
         // is being stored to the array, so cast the pointer.

src/game/area.c

@@ -331,11 +331,13 @@ void play_transition(s16 transType, s16 time, Color red, Color green, Color blue
         red = gWarpTransRed, green = gWarpTransGreen, blue = gWarpTransBlue;
     }
 
-    if (transType < WARP_TRANSITION_TYPE_STAR) { // if transition is WARP_TRANSITION_TYPE_COLOR
+    if (transType & WARP_TRANSITION_TYPE_COLOR) {
         gWarpTransition.data.red = red;
         gWarpTransition.data.green = green;
         gWarpTransition.data.blue = blue;
     } else { // if transition is textured
+        set_and_reset_transition_fade_timer(0); // Reset transition timers by passing in 0 for time
+
         gWarpTransition.data.red = red;
         gWarpTransition.data.green = green;
         gWarpTransition.data.blue = blue;
@@ -353,8 +355,7 @@ void play_transition(s16 transType, s16 time, Color red, Color green, Color blue
 
         s16 fullRadius = GFX_DIMENSIONS_FULL_RADIUS;
 
-        // HackerSM64: this fixes the pop-in with texture transition, comment out this switch
-        // statement if you want to restore the original full radius.
+#ifdef POLISHED_TRANSITIONS
         switch (transType){
             case WARP_TRANSITION_TYPE_BOWSER:
             case WARP_TRANSITION_FADE_INTO_BOWSER:
@@ -369,6 +370,7 @@ void play_transition(s16 transType, s16 time, Color red, Color green, Color blue
                 fullRadius *= 1.5f;
             break;
         }
+#endif
 
         if (transType & WARP_TRANSITION_FADE_INTO) { // Is the image fading in?
             gWarpTransition.data.startTexRadius = fullRadius;

src/game/behaviors/boo.inc.c

@@ -278,6 +278,7 @@ static s32 boo_update_during_death(void) {
 
         if (o->oTimer > 30 || o->oMoveFlags & OBJ_MOVE_HIT_WALL) {
             spawn_mist_particles();
+            boo_stop();
             o->oBooDeathStatus = BOO_DEATH_STATUS_DEAD;
 
             if (o->oBooParentBigBoo != NULL) {

src/game/crash_screen.c

@@ -133,6 +133,7 @@ void crash_screen_print(s32 x, s32 y, const char *fmt, ...) {
     char *ptr;
     u32 glyph;
     s32 size;
+    s32 xOffset = x;
     char buf[0x108];
     bzero(&buf, sizeof(buf));
 
@@ -147,12 +148,15 @@ void crash_screen_print(s32 x, s32 y, const char *fmt, ...) {
         while (*ptr) {
             glyph = gCrashScreenCharToGlyph[*ptr & 0x7f];
 
-            if (glyph != 0xff) {
-                crash_screen_draw_glyph(x, y, glyph);
+            if (*ptr == '\n') {
+                xOffset = x;
+                y += 10;
+            } else if (glyph != 0xff) {
+                crash_screen_draw_glyph(xOffset, y, glyph);
             }
 
             ptr++;
-            x += 6;
+            xOffset += 6;
         }
     }
 

src/game/debug.h

@@ -62,7 +62,7 @@ extern void __n64Assert(char *fileName, u32 lineNum, char *message);
 /**
  * Will cause a crash if cond is not true, and DEBUG is defined (allows for quick removal of littered asserts)
  */
-#ifdef DEBUG
+#ifdef DEBUG_ASSERTIONS
 #define assert(cond, message) do {\
     if ((cond) == FALSE) { \
         error(message); \

src/game/ingame_menu.c

@@ -581,11 +581,11 @@ void handle_menu_scrolling(s8 scrollDirection, s8 *currentIndex, s8 minIndex, s8
     u8 index = 0;
 
     if (scrollDirection == MENU_SCROLL_VERTICAL) {
-        if ((gPlayer1Controller->rawStickY >  60) || (gPlayer1Controller->buttonDown & (U_CBUTTONS | U_JPAD))) index++;
-        if ((gPlayer1Controller->rawStickY < -60) || (gPlayer1Controller->buttonDown & (D_CBUTTONS | D_JPAD))) index += 2;
+        if (gPlayer1Controller->rawStickY >  60) index++;
+        if (gPlayer1Controller->rawStickY < -60) index += 2;
     } else if (scrollDirection == MENU_SCROLL_HORIZONTAL) {
-        if ((gPlayer1Controller->rawStickX >  60) || (gPlayer1Controller->buttonDown & (R_CBUTTONS | R_JPAD))) index += 2;
-        if ((gPlayer1Controller->rawStickX < -60) || (gPlayer1Controller->buttonDown & (L_CBUTTONS | L_JPAD))) index++;
+        if (gPlayer1Controller->rawStickX >  60) index += 2;
+        if (gPlayer1Controller->rawStickX < -60) index++;
     }
 
     if (((index ^ gMenuHoldKeyIndex) & index) == 2) {
@@ -1932,7 +1932,7 @@ s32 render_pause_courses_and_castle(void) {
             render_pause_castle_menu_box(160, 143);
             render_pause_castle_main_strings(104, 60);
 
-            if (gPlayer1Controller->buttonPressed & (A_BUTTON | START_BUTTON | Z_TRIG)) {
+            if (gPlayer1Controller->buttonPressed & (A_BUTTON | START_BUTTON)) {
                 level_set_transition(0, NULL);
                 play_sound(SOUND_MENU_PAUSE_CLOSE, gGlobalSoundSource);
                 gMenuMode = MENU_MODE_NONE;

src/game/level_update.c

@@ -381,10 +381,8 @@ void init_mario_after_warp(void) {
     sDelayedWarpOp = WARP_OP_NONE;
 
     switch (marioSpawnType) {
-        case MARIO_SPAWN_PIPE:
-            play_transition(WARP_TRANSITION_FADE_FROM_STAR, 0x10, 0x00, 0x00, 0x00);
-            break;
         case MARIO_SPAWN_DOOR_WARP:
+        case MARIO_SPAWN_SPIN_AIRBORNE_CIRCLE:
             play_transition(WARP_TRANSITION_FADE_FROM_CIRCLE, 0x10, 0x00, 0x00, 0x00);
             break;
         case MARIO_SPAWN_TELEPORT:
@@ -393,9 +391,6 @@ void init_mario_after_warp(void) {
         case MARIO_SPAWN_SPIN_AIRBORNE:
             play_transition(WARP_TRANSITION_FADE_FROM_COLOR, 0x1A, 0xFF, 0xFF, 0xFF);
             break;
-        case MARIO_SPAWN_SPIN_AIRBORNE_CIRCLE:
-            play_transition(WARP_TRANSITION_FADE_FROM_CIRCLE, 0x10, 0x00, 0x00, 0x00);
-            break;
         case MARIO_SPAWN_FADE_FROM_BLACK:
             play_transition(WARP_TRANSITION_FADE_FROM_COLOR, 0x10, 0x00, 0x00, 0x00);
             break;

src/game/rendering_graph_node.c

@@ -220,7 +220,7 @@ static struct RenderPhase sRenderPhases[] = {
     },
 
     [RENDER_PHASE_ZEX_AFTER_SILHOUETTE]    = {
-        .startLayer = LAYER_OCCLUDE_SILHOUETTE_FIRST,
+        .startLayer = LAYER_NON_ZB_FIRST,
         .endLayer   = LAYER_LAST,
     },
 #else