reonucam

.vscode/c_cpp_properties.json

@@ -25,7 +25,7 @@
                 "TARGET_N64=1",
                 "VERSION_US=1",
                 "F3DEX_GBI_2=1",
-                "F3DZEX_NON_GBI_2=1",
+                "F3DZEX_GBI_2=1",
                 "F3DEX_GBI_SHARED=1",
                 "NON_MATCHING=1",
                 "AVOID_UB=1"
@@ -33,7 +33,7 @@
             "compilerPath": "/usr/bin/mips-linux-gnu-gcc",
             "cStandard": "gnu17",
             "cppStandard": "gnu++14",
-            "intelliSenseMode": "linux-gcc-x86"
+            "intelliSenseMode": "linux-gcc-x64"
         }
     ],
     "version": 4

CODEOWNERS

@@ -4,7 +4,7 @@
 # These owners will be the default owners for everything in the repo.
 *       @Reonu
 *       @thecozies
-*       @gheskett
+*       @Mr-Wiseguy
 
 # Order is important. The last matching pattern has the most precedence.
 # So if a pull request only touches javascript files, only these owners

Makefile

@@ -108,7 +108,7 @@ else ifeq ($(GRUCODE),l3dex2) # Line3DEX2
 else ifeq ($(GRUCODE),f3dex2pl) # Fast3DEX2_PosLight
   DEFINES += F3DEX2PL_GBI=1 F3DEX_GBI_2=1 F3DEX_GBI_SHARED=1
 else ifeq ($(GRUCODE),f3dzex) # Fast3DZEX (2.08J / Animal Forest - Dōbutsu no Mori)
-  DEFINES += F3DZEX_NON_GBI_2=1 F3DEX_GBI_2=1 F3DEX_GBI_SHARED=1
+  DEFINES += F3DZEX_GBI_2=1 F3DEX_GBI_2=1 F3DEX_GBI_SHARED=1
 else ifeq ($(GRUCODE),super3d) # Super3D
   $(warning Super3D is experimental. Try at your own risk.)
   DEFINES += SUPER3D_GBI=1 F3D_NEW=1
@@ -135,14 +135,10 @@ LINK_LIBRARIES = $(foreach i,$(LIBRARIES),-l$(i))
 
 # Default non-gcc opt flags
 DEFAULT_OPT_FLAGS = -Ofast
-# Note: -fno-associative-math is used here to suppress warnings, ideally we would enable this as an optimization but
-# this conflicts with -ftrapping-math apparently.
-# TODO: Figure out how to allow -fassociative-math to be enabled
-SAFETY_OPT_FLAGS = -ftrapping-math -fno-associative-math
 
 # Main opt flags
 GCC_MAIN_OPT_FLAGS = \
-  $(DEFAULT_OPT_FLAGS) $(SAFETY_OPT_FLAGS) \
+  -Ofast \
   --param case-values-threshold=20 \
   --param max-completely-peeled-insns=10 \
   --param max-unrolled-insns=10 \
@@ -153,7 +149,7 @@ GCC_MAIN_OPT_FLAGS = \
 
 # Surface Collision
 GCC_COLLISION_OPT_FLAGS = \
-  $(DEFAULT_OPT_FLAGS) $(SAFETY_OPT_FLAGS) \
+  -Ofast \
   --param case-values-threshold=20 \
   --param max-completely-peeled-insns=100 \
   --param max-unrolled-insns=100 \
@@ -166,7 +162,7 @@ GCC_COLLISION_OPT_FLAGS = \
 
 # Math Util
 GCC_MATH_UTIL_OPT_FLAGS = \
-  $(DEFAULT_OPT_FLAGS) $(SAFETY_OPT_FLAGS) \
+  -Ofast \
   -fno-unroll-loops \
   -fno-peel-loops \
   --param case-values-threshold=20  \
@@ -178,7 +174,7 @@ GCC_MATH_UTIL_OPT_FLAGS = \
 
 # Rendering graph node
 GCC_GRAPH_NODE_OPT_FLAGS = \
-  $(DEFAULT_OPT_FLAGS) $(SAFETY_OPT_FLAGS) \
+  -Ofast \
   --param case-values-threshold=20 \
   --param max-completely-peeled-insns=100 \
   --param max-unrolled-insns=100 \
@@ -327,25 +323,11 @@ ifeq ($(filter clean distclean print-%,$(MAKECMDGOALS)),)
   ifeq ($(NOEXTRACT),0)
     DUMMY != $(PYTHON) extract_assets.py $(VERSION) >&2 || echo FAIL
     ifeq ($(DUMMY),FAIL)
-      $(error Failed to extract assets from US ROM)
+      $(error Failed to extract assets)
     endif
-    ifneq (,$(wildcard baserom.jp.z64))
-      DUMMY != $(PYTHON) extract_assets.py jp >&2 || echo FAIL
-      ifeq ($(DUMMY),FAIL)
-        $(error Failed to extract assets from JP ROM)
-      endif
-    endif
-    ifneq (,$(wildcard baserom.eu.z64))
-      DUMMY != $(PYTHON) extract_assets.py eu >&2 || echo FAIL
-      ifeq ($(DUMMY),FAIL)
-        $(error Failed to extract assets from EU ROM)
-      endif
-    endif
-    ifneq (,$(wildcard baserom.sh.z64))
-      DUMMY != $(PYTHON) extract_assets.py sh >&2 || echo FAIL
-      ifeq ($(DUMMY),FAIL)
-        $(error Failed to extract assets from SH ROM)
-      endif
+    DUMMY != $(PYTHON) extract_assets.py jp >&2 || echo FAIL
+    ifeq ($(DUMMY),FAIL)
+      $(error Failed to extract assets)
     endif
   endif
 
@@ -634,8 +616,7 @@ $(BUILD_DIR)/src/usb/usb.o: CFLAGS += -Wno-unused-variable -Wno-sign-compare -Wn
 $(BUILD_DIR)/src/usb/debug.o: OPT_FLAGS := -O0
 $(BUILD_DIR)/src/usb/debug.o: CFLAGS += -Wno-unused-parameter -Wno-maybe-uninitialized
 # File specific opt flags
-$(BUILD_DIR)/src/audio/heap.o:          OPT_FLAGS := -Os -fno-jump-tables
-$(BUILD_DIR)/src/audio/synthesis.o:     OPT_FLAGS := -Os -fno-jump-tables
+$(BUILD_DIR)/src/audio/*.o:                   OPT_FLAGS := -Os -fno-jump-tables
 
 $(BUILD_DIR)/src/engine/surface_collision.o:  OPT_FLAGS := $(COLLISION_OPT_FLAGS)
 $(BUILD_DIR)/src/engine/math_util.o:          OPT_FLAGS := $(MATH_UTIL_OPT_FLAGS)
@@ -693,11 +674,9 @@ $(BUILD_DIR)/%.ci4.inc.c: %.ci4.png
 $(BUILD_DIR)/%.elf: $(BUILD_DIR)/%.o
 	$(call print,Linking ELF file:,$<,$@)
 	$(V)$(LD) -e 0 -Ttext=$(SEGMENT_ADDRESS) -Map $@.map -o $@ $<
-# Override for leveldata.elf, which otherwise matches the above pattern.
-# Has to be a static pattern rule for make-4.4 and above to trigger the second
-# expansion.
+# Override for leveldata.elf, which otherwise matches the above pattern
 .SECONDEXPANSION:
-$(LEVEL_ELF_FILES): $(BUILD_DIR)/levels/%/leveldata.elf: $(BUILD_DIR)/levels/%/leveldata.o $(BUILD_DIR)/bin/$$(TEXTURE_BIN).elf
+$(BUILD_DIR)/levels/%/leveldata.elf: $(BUILD_DIR)/levels/%/leveldata.o $(BUILD_DIR)/bin/$$(TEXTURE_BIN).elf
 	$(call print,Linking ELF file:,$<,$@)
 	$(V)$(LD) -e 0 -Ttext=$(SEGMENT_ADDRESS) -Map $@.map --just-symbols=$(BUILD_DIR)/bin/$(TEXTURE_BIN).elf -o $@ $<
 
@@ -876,16 +855,8 @@ $(ELF): $(BUILD_DIR)/sm64_prelim.elf $(BUILD_DIR)/asm/debug/map.o $(O_FILES) $(Y
 	$(V)$(LD) --gc-sections -L $(BUILD_DIR) -T undefined_syms.txt -T $(BUILD_DIR)/$(LD_SCRIPT) -T goddard.txt -Map $(BUILD_DIR)/sm64.$(VERSION).map --no-check-sections $(addprefix -R ,$(SEG_FILES)) -o $@ $(O_FILES) -L$(LIBS_DIR) -l$(ULTRALIB) -Llib $(LINK_LIBRARIES) -u sprintf -u osMapTLB -Llib/gcclib/$(LIBGCCDIR) -lgcc -lrtc
 
 # Build ROM
-ifeq (n,$(findstring n,$(firstword -$(MAKEFLAGS))))
-# run with -n / --dry-run
-$(ROM):
-	@$(PRINT) "$(BLUE)DRY RUNS ARE DISABLED$(NO_COL)\n"
-else
-# not running with -n / --dry-run
 $(ROM): $(ELF)
 	$(call print,Building ROM:,$<,$@)
-endif
-
 ifeq      ($(CONSOLE),n64)
 	$(V)$(OBJCOPY) --pad-to=0x101000 --gap-fill=0xFF $< $@ -O binary
 else ifeq ($(CONSOLE),bb)

Makefile.split

@@ -39,8 +39,6 @@ ACTOR_GROUPS := \
 
 LEVEL_FILES := $(addsuffix leveldata,$(LEVEL_DIRS))
 
-LEVEL_ELF_FILES := $(foreach level_dir,$(LEVEL_DIRS),$(BUILD_DIR)/levels/$(level_dir)leveldata.elf)
-
 SEG_FILES := \
     $(SEGMENTS:%=$(BUILD_DIR)/bin/%.elf) \
     $(ACTOR_GROUPS:%=$(BUILD_DIR)/actors/%.elf) \

README.md

@@ -14,7 +14,7 @@ This is a fork of the ultrasm64 repo by CrashOveride which includes the followin
 - **ArcticJaguar725**: Most audio configuration and layout changes, colored ia4 text, floombas, various bugfixes, and more
 - **CowQuack**: Adjustable skybox sizes, area-specific skybox function
 - **thecozies**: Water surface types, general maintenance, and time
-- **MrComit**: General use object defines, JUMP_KICK_FIX
+- **MrComit**: General use object defines, JUMP_KICK_FIX, LEDGE_GRABS_CHECK_SLOPE_ANGLE
 - **aglab2**: Bugfixes (particularly puppycam), refactor stuff
 - **someone2639**: math.s and crash screen disam, stack trace, map packing, shiftable segments 2, S2DEX engine
 - **Arthurtilly**: Platform Displacement 2
@@ -29,12 +29,11 @@ This is a fork of the ultrasm64 repo by CrashOveride which includes the followin
 - **CrashOveride**: creating the [ultrasm64](https://github.com/CrashOveride95/ultrasm64) repo
 - **falcobuster**: Original coordinate overflow fix (world scale), ASM version of extended bounds
 - **anonymous_moose**: porting falco's extended bounds to decomp
-- **tuxlovesyou**: `LOAD_MIO0_TEXTURE` macro and moral support
 
 Thanks to Frame#5375 and AloXado320 for also helping with silhouette stuff
 
 **Lighting Engine by Wiseguy**
-- Lighting Engine is available on a separate branch ([base/lighting-engine](https://github.com/Reonu/HackerSM64/tree/base/lighting-engine)). Instructions on how to use it are in the readme of that branch.
+- Lighting Engine is available on a separate branch ([base/lighting-engine-wip](https://github.com/Reonu/HackerSM64/tree/base/lighting-engine-wip)). Instructions on how to use it are in the readme of that branch.
 - Alternatively, the main repo has `Puppylights` available, which is a more lightweight, but limited lighting library intended to be used to modify existing light properties. You can look at `puppylights.c` to find out how to use it.
 
 **Puppycam**
@@ -61,6 +60,7 @@ Thanks to Frame#5375 and AloXado320 for also helping with silhouette stuff
 - Toggle to disable fall damage and the fall damage sound *
 - Nonstop stars *
 - Removed course-specific camera processing *
+- You can increase the number of frames that you have to perform a firsty *
 - Ability to set Mario's movement speed when hanging from a ceiling *
 - Tighter hanging controls (Mario will face the direction of the analog stick directly while hanging from a ceiling) *
 - reonucam3: custom camera by Reonu. This is included as a .patch file in the enhancements folder, you need to apply it if you want this camera.

VERSION.txt

@@ -1 +1 @@
-v2.0.9
+v2.0.1

actors/flyguy/model.inc.c

@@ -10,7 +10,7 @@ ALIGNED8 static const Texture flyguy_seg8_texture_0800E088[] = {
 
 // 0x0800F088
 ALIGNED8 static const Texture flyguy_seg8_texture_0800F088[] = {
-#include "actors/flyguy/flyguy_face.custom.rgba16.inc.c"
+#include "actors/flyguy/flyguy_face.rgba16.inc.c"
 };
 
 // 0x0800F888

actors/warp_pipe/model.inc.c

@@ -96,7 +96,7 @@ static const Vtx warp_pipe_seg3_vertex_03007DC0[] = {
 
 // 0x03007E40
 ALIGNED8 static const Texture warp_pipe_seg3_texture_03007E40[] = {
-#include "actors/warp_pipe/warp_pipe_side.custom.rgba16.inc.c"
+#include "actors/warp_pipe/warp_pipe_side.rgba16.inc.c"
 };
 
 // 0x03008E40 - 0x03008F98

data/behavior_data.c

@@ -791,7 +791,6 @@ const BehaviorScript bhvWfBreakableWallLeft[] = {
     // WF breakable walls - common:
     OR_INT(oFlags, (OBJ_FLAG_ACTIVE_FROM_AFAR | OBJ_FLAG_COMPUTE_DIST_TO_MARIO | OBJ_FLAG_SET_FACE_YAW_TO_MOVE_YAW | OBJ_FLAG_UPDATE_GFX_POS_AND_ANGLE)),
     SET_HITBOX(/*Radius*/ 300, /*Height*/ 400),
-    SET_FLOAT(oDrawingDistance, 4500),
     SET_INT(oIntangibleTimer, 0),
     BEGIN_LOOP(),
         CALL_NATIVE(bhv_wf_breakable_wall_loop),

include/config/config_audio.h

@@ -4,12 +4,12 @@
  * AUDIO SETTINGS *
  ******************/
 
-// Fixes the castle music sometimes triggering after getting a dialog.
+// Fixes the castle music sometimes triggering after getting a dialog
 #define CASTLE_MUSIC_FIX
 
-// Increases the audio heap size to allow for more concurrent notes to be played and for more custom sequences/banks to be imported (not supported for SH).
+// Increase audio heap size to allow for more concurrent notes to be played and for more custom sequences/banks to be imported (not supported for SH)
 #define EXPAND_AUDIO_HEAP
 
-// Uses a much better implementation of reverb over vanilla's fake echo reverb. Great for caves or eerie levels, as well as just a better audio experience in general.
+// Use a much better implementation of reverb over vanilla's fake echo reverb. Great for caves or eerie levels, as well as just a better audio experience in general.
 // Reverb parameters can be configured in audio/synthesis.c to meet desired aesthetic/performance needs. Currently US/JP only. Hurts emulator and console performance.
-// #define BETTER_REVERB
+//#define BETTER_REVERB

include/config/config_benchmark.h

@@ -3,11 +3,11 @@
 /**********************
  * BENCHMARK SETTINGS *
  **********************/
-
 /**
- * Enabling this will enable a set of defines in order to run a benchmark on the game.
- * Currently this just starts the credits, and enables PUPPYPRINT_DEBUG.
+ * Enabling this will enable a set of defines in order to run a benchmark on the game
+ * Currently this just starts the credits, and enables puppyprint debug
 */
+
 // #define ENABLE_CREDITS_BENCHMARK
 
 #ifdef ENABLE_CREDITS_BENCHMARK

include/config/config_camera.h

@@ -4,37 +4,41 @@
  * CAMERA SETTINGS *
  *******************/
 
-// Forces the camera mode to your choice (except when swimming or flying).
+// Force the camera mode to your choice (except when swimming or flying)
 // It does this by setting the area's camera->defMode to this mode, and also
-// changes hardcoded modes to use c->defMode.
-//      Note: removes door cutscenes due to the way they're designed to work with specific modes.
-//      Search for FORCED_CAMERA_MODE in camera.c for more information.
+// changes hardcoded modes to use c->defMode
+//      Note: removes door cutscenes due to the way they're designed to work with specific modes
+//      Search for FORCED_CAMERA_MODE in camera.c for more information
 #define FORCED_CAMERA_MODE        CAMERA_MODE_8_DIRECTIONS
 
-// Changes hardcoded camera mode reverting to instead use the area's default mode (defMode).
-// If you're using a FORCED_CAMERA_MODE, this must be on for it to work.
+// Changes hardcoded camera mode reverting to instead use the area's default mode (defMode)
+// If you're using a FORCED_CAMERA_MODE, this must be on for it to work
 #define USE_COURSE_DEFAULT_MODE
 
 /***** Movement specific camera modes: *****/
-// Camera mode when Mario is < 400 units away from the water surface (default is CAMERA_MODE_WATER_SURFACE).
+// Camera mode when Mario is < 400 units away from the water surface (default is CAMERA_MODE_WATER_SURFACE)
 #define WATER_SURFACE_CAMERA_MODE CAMERA_MODE_WATER_SURFACE
-// Camera mode when Mario is > 800 units away from the water surface (default is CAMERA_MODE_BEHIND_MARIO).
+// Camera mode when Mario is > 800 units away from the water surface (default is CAMERA_MODE_BEHIND_MARIO)
 #define DEEP_WATER_CAMERA_MODE    CAMERA_MODE_BEHIND_MARIO
-// Camera mode when Mario is flying (default is CAMERA_MODE_BEHIND_MARIO).
+// Camera mode when Mario is flying (default is CAMERA_MODE_BEHIND_MARIO)
 #define FLYING_CAMERA_MODE        CAMERA_MODE_BEHIND_MARIO
 /*******************************************/
 
-// Makes the camera approach Mario's height much more quickly.
+// Makes the camera approach Mario's height much more quickly
 #define FAST_VERTICAL_CAMERA_MOVEMENT
 
-// Enables "parallel lakitu camera" or "aglab cam" which lets you move the camera smoothly with the D-pad.
+// Enables "parallel lakitu camera" or "aglab cam" which lets you move the camera smoothly with the dpad
 #define PARALLEL_LAKITU_CAM
 
 // Enables Puppy Camera 2, a rewritten camera that can be freely configured and modified.
 // #define PUPPYCAM
 
+// Enables Reonucam, a custom camera that aims to be a more feature-rich "aglabcam" that also uses less buttons.
+// An explanation the features can be seen here: https://www.youtube.com/watch?v=TQNkznX9Z3k (please note that the analog feature shown at the end is no longer present)
+// #define REONUCAM
+
 // Note: Reonucam is available, but because we had no time to test it properly, it's included as a patch rather than being in the code by default.
-// Run this command to apply the patch if you want to use it:
+// Run this command to apply the patch if you want to use it: 
 // tools/apply_patch.sh enhancements/reonucam.patch
 // Consider it a beta, but it should work fine. Please report any bugs with it. Applying the patch will simply add a define here, so you can still turn it off even after patching.
 
@@ -42,13 +46,32 @@
 /***** Vanilla config options *****/
 /**********************************/
 
-// Included for ENABLE_VANILLA_LEVEL_SPECIFIC_CHECKS define.
+// Included for ENABLE_VANILLA_LEVEL_SPECIFIC_CHECKS define
 #include "config_game.h"
 
-// Allow course specific camera processing.
-// You will likely want this disabled in non-vanilla hacks.
+// Allow course specific camera processing
+// You will likely want this disabled in non-vanilla hacks
 // This is automatically enabled when ENABLE_VANILLA_LEVEL_SPECIFIC_CHECKS is enabled,
-// but feel free to override it if you really want to for some reason/
+// but feel free to override it if you really want to for some reason
 #ifdef ENABLE_VANILLA_LEVEL_SPECIFIC_CHECKS
     #define ENABLE_VANILLA_CAM_PROCESSING
 #endif
+
+// Reonucam overrides
+#ifdef REONUCAM
+    // Use course default mode
+    #ifndef USE_COURSE_DEFAULT_MODE
+    #define USE_COURSE_DEFAULT_MODE
+    #endif
+
+    // Force camera mode to 8 Dir
+    #ifdef FORCED_CAMERA_MODE
+    #undef FORCED_CAMERA_MODE
+    #endif
+    #define FORCED_CAMERA_MODE CAMERA_MODE_8_DIRECTIONS
+
+    // Disable vanilla cam processing
+    #ifdef ENABLE_VANILLA_CAM_PROCESSING
+    #undef ENABLE_VANILLA_CAM_PROCESSING
+    #endif
+#endif

include/config/config_collision.h

@@ -8,10 +8,10 @@
 // The defined number is the forward speed threshold before the change is active, since it's only noticeable at lower speeds.
 #define FAST_FLOOR_ALIGN 10
 
-// Automatically calculates the optimal collision distance for an object based on its vertices.
+// Automatically calculate the optimal collision distance for an object based on its vertices.
 #define AUTO_COLLISION_DISTANCE
 
-// Allows all surfaces types to have force, (doesn't require setting force, just allows it to be optional).
+// Allow all surfaces types to have force, (doesn't require setting force, just allows it to be optional).
 #define ALL_SURFACES_HAVE_FORCE
 
 // Number of walls that can push Mario at once. Vanilla is 4.

include/config/config_cutscenes.h

@@ -6,8 +6,8 @@
 
 // -- CUTSCENE SKIPS --
 
-// Skips the peach letter cutscene.
+// Skip peach letter cutscene
 #define PEACH_SKIP
 
-// Skips the title/splash screen (Super Mario 64 logo).
-// #define SKIP_TITLE_SCREEN
+// Uncomment this if you want to skip the title screen (Super Mario 64 logo)
+//#define SKIP_TITLE_SCREEN

include/config/config_debug.h

@@ -7,50 +7,46 @@
 // Enables most debug options, including PUPPYPRINT_DEBUG.
 // #define DEBUG_ALL
 
-// Disables all debug options (except PUPPYPRINT).
+// Disables all debug options (except PUPPYPRINT)
 #define DISABLE_ALL
 
-// Enables a comprehensive standalone profiler. Automatically enabled by PUPPYPRINT_DEBUG.
-// If not using PUPPYPRINT_DEBUG, press L to toggle the profiler.
-// #define USE_PROFILER
-
 // TEST LEVEL
 // Uncomment this define and set a test level in order to boot straight into said level.
 // This allows you to quickly test the level you're working on.
 // If you want the game to boot normally, just comment out the define again.
 // #define TEST_LEVEL LEVEL_BOB
 
-// Enables debug level select. Hold L while the game boots to turn it on.
+// Enable debug level select. Hold L while the game boots to turn it on.
 #define DEBUG_LEVEL_SELECT
 
-// Enables debug free move (D-pad up to enter, A to exit).
+// Enable debug free move (DPad up to enter, A to exit).
 #define ENABLE_DEBUG_FREE_MOVE
 
-// Enables a custom, enhanced performance profiler. (Enables PUPPYPRINT by default in config_safeguards).
+// Include a custom, enhanced performance profiler. (Enables PUPPYPRINT by default in config_safeguards).
 // #define PUPPYPRINT_DEBUG 1
 
-// Uses cycles instead of microseconds in Puppyprint debug output.
+// Use cycles instead of microseconds in Puppyprint debug output.
 // #define PUPPYPRINT_DEBUG_CYCLES
 
-// A vanilla style debug mode. It doesn't rely on a text engine, but it's much less powerful that PUPPYPRINT_DEBUG.
-// Press D-pad left to show the debug UI.
+// A vanilla style debug mode. It doesn't rely on a text engine, but it's much less powerful that PUPPYPRINT_DEBUG. 
+// Press DPAD left to show the debug UI.
 // #define VANILLA_STYLE_CUSTOM_DEBUG
 
-// Visual debug enables some collision visuals. Tapping Right on the D-pad will cycle between visual hitboxes, visual surfaces, both, and neither.
+// Visual debug enables some collision visuals. Tapping Right on the dpad will cycle between visual hitboxes, visual surfaces, both, and neither.
 // If puppyprint is enabled, then this can be cycled only while the screen is active.
 // #define VISUAL_DEBUG
 
-// Opens all courses and doors. Used for debugging purposes to unlock all content.
+// Open all courses and doors. Used for debugging purposes to unlock all content.
 #define UNLOCK_ALL
 
 // Same as above, but also reads all save file flags as complete.
 // This will not overwrite existing save file data unless you save over it.
 // #define COMPLETE_SAVE_FILE
 
-// Removes the limit on FPS.
+// Removes the limit on FPS
 // #define UNLOCK_FPS
 
-// Includes vanilla debug functionality.
+// Include vanilla debug functionality.
 // #define VANILLA_DEBUG
 
 // Forces a crash when the game starts. Useful for debugging the crash screen.

include/config/config_game.h

@@ -4,62 +4,65 @@
  * GAME SETTINGS *
  *****************/
 
-/**
+/** 
  * Enables some mechanics that change behavior depending on hardcoded level numbers.
- * You may also need to change sLevelsWithRooms in object_helpers.c.
- * TODO: separate this into separate defines, behavior params, or make these mechanics otherwise dynamic.
+ * You may also need to change sLevelsWithRooms in object_helpers.c
+ * TODO: separate this into separate defines, behavior params, or make these mechanics otherwise dynamic
 */
 // #define ENABLE_VANILLA_LEVEL_SPECIFIC_CHECKS
 
-// Disables lives and hides the lives counter.
+// Disable lives and hide the lives counter
 #define DISABLE_LIVES
 
-// Saves the number of lives to the save file (Does nothing if DISABLE_LIVES is enabled).
+// Save number of lives to the save file (Does nothing if DISABLE_LIVES is enabled)
 #define SAVE_NUM_LIVES
 
-// This is the number of lives Mario starts with after a game over or starting the game for the first time (must be lower than 127).
+// The number of lives Mario starts with after a game over or starting the game for the first time (must be lower than 127)
 #define DEFAULT_NUM_LIVES 4
 
-// This can be 0..127.
+// This can be 0..127
 #define MAX_NUM_LIVES   100
 
-// This can be 0..32767.
+// This can be 0..32767
 #define MAX_NUM_COINS   999
 
-// Air/breath meter is separate from health meter when underwater.
+// Air/Breath meter is separate from health meter when underwater
 // #define BREATH_METER
 
 // Number of coins to spawn the "100 coin" star. If you remove the define altogether, then there won't be a 100 coin star at all.
 #define X_COIN_STAR 100
 
-// Stars don't kick you out of the level (does not play nicely with vanilla).
+/*
+ * Stars don't kick you out of the level (does not play nicely with vanilla)
+ * In v2.0 there are numerous issues with this define that can be seen here https://github.com/Reonu/HackerSM64/issues/258
+ * Use at your own risk.
+*/
 // #define NON_STOP_STARS
 
-// Bowser keys always exit the level. Only has an effect if NON_STOP_STARS is enabled.
-// #define KEYS_EXIT_LEVEL
-
-// Uncomment this if you want global star IDs (useful for creating an open world hack ala MVC).
+// Uncomment this if you want global star IDs (useful for creating an open world hack ala MVC)
 // #define GLOBAL_STAR_IDS
 
-// Number of possible unique model ID's (keep it higher than 256).
+// Number of possible unique model ID's (keep it higher than 256)
 #define MODEL_ID_COUNT 256
 
 // Number of supported areas per level.
 #define AREA_COUNT 8
 
 // Makes signs and NPCs easier to talk to.
+// NOTE: Currently has issues with talking to Bowser post-fight,
+// https://github.com/Reonu/HackerSM64/issues/273
 // #define EASIER_DIALOG_TRIGGER
 
-// Shows an "A" when Mario is able to talk [requires EASIER_DIALOG_TRIGGER].
+// Show an "A" when Mario is able to talk [requires EASIER_DIALOG_TRIGGER]
 // #define DIALOG_INDICATOR
 
 // Include the English characters that were missing from US segment2
 // 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]
+// [MAKE SURE TO ALSO BUILD FROM JP/SH AND EU TO OBTAIN THE ASSETS]
 // If this is disabled, backup assets will be used.
 // #define COMPLETE_EN_US_SEGMENT2
 
-// Removes multi-language cake screen.
+/// Removes multi-language cake screen
 #define EU_CUSTOM_CAKE_FIX
 
 // Adds multiple languages to the game. Just a placeholder for the most part, because it only works with EU, and must be enabled with EU.
@@ -68,6 +71,5 @@
 // Prevents infinite death loops by always restoring Mario's health when he's warped to any kind of warp while dead.
 #define PREVENT_DEATH_LOOP
 
-// The level that the game starts with immediately after file select.
-// The levelscript needs to have a MARIO_POS command for this to work.
+// The level that the game starts in after file select. The levelscript needs to have a MARIO_POS command for this to work.
 #define START_LEVEL LEVEL_CASTLE_GROUNDS

include/config/config_goddard.h

@@ -4,11 +4,11 @@
  * GODDARD SETTINGS *
  ********************/
 
-// Enables Goddard (the Mario head).
+// Uncomment this if you want to keep the mario head and not skip it
 // #define KEEP_MARIO_HEAD
 
-// Enables the Goddard easter egg from Shindou (has no effect if KEEP_MARIO_HEAD is disabled).
+// Goddard easter egg from Shindou (has no effect if KEEP_MARIO_HEAD is disabled)
 #define GODDARD_EASTER_EGG
 
-// Disables the demo that plays when idle on the start screen (has no effect if KEEP_MARIO_HEAD is disabled).
+// Disables the demo that plays when idle on the start screen (has no effect if KEEP_MARIO_HEAD is disabled)
 #define DISABLE_DEMO