Merge pull request #30 from Diesel-Net/develop

Improve Builds

Author: tomdaley92

.github/workflows/build-reusable.yml

@@ -23,6 +23,7 @@ jobs:
       - name: Build macOS (x86_64 + arm64)
         run: |
           cd MacOS
+          make clean
           make
 
       - name: Upload macOS build artifact
@@ -43,7 +44,7 @@ jobs:
           path: external/sdl/build
           key: sdl-2.32.10-windows-2022-${{ runner.arch }}
 
-      - name: Configures build environment for AMD64
+      - name: Configures build environment for x86-64
         uses: ilammy/msvc-dev-cmd@v1
         with:
             arch: amd64
@@ -52,6 +53,7 @@ jobs:
         shell: cmd
         run: |
           cd Windows
+          nmake clean
           nmake
 
       - name: Upload Windows build artifact

.github/workflows/lint.yml

@@ -4,10 +4,10 @@ on:
   pull_request: {}
 
 jobs:
-  core-lint:
+  shared-lint:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Run Core no-OO linter
+      - name: Run no-OO linter
         run: |
-          bash tools/check_no_oo.sh Core
+          bash tools/check_no_oo.sh shared

.gitignore

@@ -7,6 +7,7 @@
 # Generated files
 shared/license.h
 shared/bootrom.h
+macos/src/Info.plist
 
 # External dependencies (downloaded at build time)
 external/sdl/

README.md

@@ -27,6 +27,26 @@ in C-style C++ using SDL2, ImGui, and OpenGL.
 - Command line support
 - No SCHIP support
 
+## Controls
+
+
+    controls        <-->        keybindings
+
+    1 2 3 C                     1 2 3 4
+    4 5 6 D                     q w e r
+    7 8 9 E                     a s d f
+    A 0 B F                     z x c v
+    increase speed              page up
+    decrease speed              page down
+    quit                        esc
+    toggle fullscreen           enter
+    toggle menu                 left alt
+    show fps                    right alt
+    soft reset                  f5
+    pause                       p
+    mute                        m
+
+
 ## Usage
 
     Kiwi8 [filename] [-FMLSV]
@@ -36,26 +56,6 @@ in C-style C++ using SDL2, ImGui, and OpenGL.
     -S      Disable shift quirk
     -V      Disable vertical wrapping
 
-## Controls
-```
-controls        <-->        keybindings
-
-1 2 3 C                     1 2 3 4
-4 5 6 D                     q w e r
-7 8 9 E                     a s d f
-A 0 B F                     z x c v
-increase speed              page up
-decrease speed              page down
-quit                        esc
-toggle fullscreen           enter
-toggle menu                 left alt
-show fps                    right alt
-soft reset                  f5
-pause                       p
-mute                        m
-
-```
-
 ## Building on Windows
 
 The following must be installed and added to your **PATH**:

macos/makefile

@@ -1,18 +1,19 @@
 APP_NAME = Kiwi8
 
-# Auto-detect version: use GITHUB_REF_NAME if set (CI), else git describe, else git branch
-ifeq ($(origin GITHUB_REF_NAME), environment)
-VERSION := $(GITHUB_REF_NAME)
-else
-VERSION := $(shell git describe --tags --exact-match 2>/dev/null || git rev-parse --abbrev-ref HEAD 2>/dev/null || echo "unknown")
+# Use GITHUB_REF_NAME from GitHub Actions, or default values for local builds
+VERSION ?= $(GITHUB_REF_NAME)
+ifeq ($(VERSION),)
+VERSION = unknown
 endif
 
-APP_NAME_VERSION = $(APP_NAME) $(VERSION)
-APP_EXE = $(APP_NAME)
+COMMIT_HASH := $(if $(GITHUB_SHA),$(GITHUB_SHA),unknown)
+
+APP_MANIFEST = src/Info.plist
 APP_BUNDLE = $(APP_NAME).app
+APP_EXE = $(APP_NAME)
 
 CC = clang++
-CFLAGS = -std=c++17 -Wall -mmacosx-version-min=11.0 -arch x86_64 -arch arm64 -MMD -MP -DAPPNAME_VERSION='"$(APP_NAME_VERSION)"'
+CFLAGS = -std=c++17 -Wall -mmacosx-version-min=11.0 -arch x86_64 -arch arm64 -MMD -MP -DAPP_NAME='"$(APP_NAME)"' -DVERSION='"$(VERSION)"' -DCOMMIT_HASH='"$(COMMIT_HASH)"'
 LFLAGS = -mmacosx-version-min=11.0
 INCS = -I../external/sdl/build/include/ -I../external/imgui/ -I../shared/
 LIBS = -L../external/sdl/build/lib/ -lSDL2-2.0.0 -framework Cocoa -framework OpenGL
@@ -60,6 +61,10 @@ $(LICENSE_HEADER): ../LICENSE
 $(BOOTROM_HEADER): $(BOOTROM_SOURCE)
 	python3 ../tools/generate_bootrom_header.py $(BOOTROM_SOURCE) $(BOOTROM_HEADER)
 
+# Generate Info.plist from template with version substitution
+$(APP_MANIFEST): $(APP_MANIFEST).in
+	sed -e 's/@APP_NAME@/$(APP_NAME)/g' -e 's/@VERSION@/$(VERSION)/g' -e 's/@COMMIT_HASH@/$(COMMIT_HASH)/g' $< > $@
+
 # Pattern rules for incremental compilation
 %.o: ../shared/%.cc $(LICENSE_HEADER) $(BOOTROM_HEADER)
 	$(CC) $(CFLAGS) $(INCS) -c $< -o $@
@@ -88,15 +93,15 @@ release/$(APP_BUNDLE)/Contents/MacOS/$(APP_EXE): $(SDL_LIB) $(OBJS)
 	$(CC) $(CFLAGS) $(LIBS) $(INCS) $(OBJS) -o $@ $(LFLAGS)
 
 # .app bundle
-release/$(APP_BUNDLE): release/$(APP_BUNDLE)/Contents/MacOS/$(APP_EXE) $(SDL_LIB) resources/Kiwi8.icns src/Info.plist
+release/$(APP_BUNDLE): release/$(APP_BUNDLE)/Contents/MacOS/$(APP_EXE) $(SDL_LIB) resources/Kiwi8.icns $(APP_MANIFEST)
 	mkdir -p release/$(APP_BUNDLE)/Contents/{Resources,Frameworks}
 
 	# Copying the frameworks into .app bundle
 	cp $(SDL_LIB) release/$(APP_BUNDLE)/Contents/Frameworks/libSDL2-2.0.0.dylib
 
 	# Moving other files into .app bundle
 	cp resources/Kiwi8.icns release/$(APP_BUNDLE)/Contents/Resources/Kiwi8.icns
-	cp src/Info.plist release/$(APP_BUNDLE)/Contents/Info.plist
+	cp $(APP_MANIFEST) release/$(APP_BUNDLE)/Contents/Info.plist
 
 	# Set the dylib's install name to be relative to the bundle
 	install_name_tool -id @executable_path/../Frameworks/libSDL2-2.0.0.dylib release/$(APP_BUNDLE)/Contents/Frameworks/libSDL2-2.0.0.dylib
@@ -119,6 +124,7 @@ clean:
 	$(RM) -r debug
 	$(RM) -r release
 	$(RM) $(LICENSE_HEADER) $(BOOTROM_HEADER)
+	$(RM) $(APP_MANIFEST)
 
 # Removes everything including SDL installation and build artifacts (full reset)
 distclean: clean

macos/src/Info.plist macos/src/Info.plist.inmacos/src/Info.plist renamed to macos/src/Info.plist.in

@@ -3,21 +3,27 @@
     <plist version="1.0">
     <dict>
         <key>CFBundleExecutable</key>
-        <string>Kiwi8</string>
+        <string>@APP_NAME@</string>
+        <key>CFBundleIdentifier</key>
+        <string>net.kiwi-labs.kiwi8</string>
         <key>CFBundleIconFile</key>
         <string>Kiwi8.icns</string>
         <key>CFBundleInfoDictionaryVersion</key>
         <string>1.0</string>
         <key>CFBundlePackageType</key>
         <string>APPL</string>
-        <key>CFBundleSignature</key>
-        <string>kiwi</string>
+        <key>CFBundleShortVersionString</key>
+        <string>@VERSION@</string>
         <key>CFBundleVersion</key>
-        <string>1.03</string>
+        <string>@SUB_VERSION@</string>
+        <key>LSMinimumSystemVersion</key>
+        <string>11.0</string>
         <key>NSHighResolutionCapable</key>
         <true/>
         <key>NSHumanReadableCopyright</key>
-        <string>Copyright © 2016 Thomas Daley.</string>
+        <string>Copyright © 2016-2026 Kiwi Labs.</string>
+        <key>NSSupportsAutomaticGraphicsSwitching</key>
+        <true/>
 
     </dict>
     </plist>

shared/Chip8.h

@@ -6,10 +6,22 @@
 #include "Input.h"
 #include "Audio.h"
 
-// APPNAME_VERSION is defined by the compiler via -DAPPNAME_VERSION="..."
+// APP_NAME is defined by the compiler via -DAPP_NAME="..."
 // Falls back to generic name if not defined (shouldn't happen in normal builds)
-#ifndef APPNAME_VERSION
-#define APPNAME_VERSION "Kiwi8"
+#ifndef APP_NAME
+#define APP_NAME "Kiwi8"
+#endif
+
+// VERSION is defined by the compiler via -DVERSION="..."
+// Falls back to unknown if not defined (shouldn't happen in normal builds)
+#ifndef VERSION
+#define VERSION "unknown"
+#endif
+
+// COMMIT_HASH is defined by the compiler via -DCOMMIT_HASH="..."
+// Falls back to generic name if not defined (shouldn't happen in normal builds)
+#ifndef COMMIT_HASH
+#define COMMIT_HASH "unknown"
 #endif
 
 #define MEM_SIZE 4096

shared/Gui.cc

@@ -2,6 +2,7 @@
 #include "Display.h"
 #include "Gui.h"
 #include "license.h" // Generated at build time from LICENSE
+#include <stdio.h>
 
 Gui::Gui() {
     soft_reset_flag = 0;
@@ -220,13 +221,18 @@ void Gui::HelpWindows() {
         ImGui::SetNextWindowPosCenter(ImGuiSetCond_Appearing);
         ImGui::Begin("About", &show_about);
 
+        // Truncate COMMIT_HASH to first 7 characters for display
+        char short_hash[8];
+        snprintf(short_hash, sizeof(short_hash), "%.7s", COMMIT_HASH);
+
         ImGui::TextWrapped(
-            APPNAME_VERSION "\n"
+            APP_NAME " " VERSION " (%s)\n"
             "\n"
             "A cross-platform Chip-8 interpreter written\n"
             "in C-Style C++ using SDL2, ImGui, and OpenGL.\n"
             "\n"
-            "<https://github.com/Diesel-Net/kiwi-8>\n"
+            "<https://github.com/Diesel-Net/kiwi-8>\n",
+            short_hash
         );
 
         ImGui::End();

shared/main.cc

@@ -1,15 +1,3 @@
-/*
-Author: Thomas Daley
-Date: September 8, 2016
-
-Usage: Kiwi8 [filename] [-FMLSV]
-    -F      Launch in fullscreen
-    -M      Launch with audio muted
-    -L      Disable load/store quirk
-    -S      Disable shift quirk
-    -V      Disable vertical wrapping
-*/
-
 #include "Chip8.h"
 #include <string.h>
 

windows/makefile

@@ -1,30 +1,24 @@
 APP_NAME = Kiwi8
 
-# Auto-detect version: use GITHUB_REF_NAME if set (CI), else git describe, else git branch
-!IFNDEF GITHUB_REF_NAME
-# Try git describe for exact tag match
-!IF [git describe --tags --exact-match > .version.tmp 2>nul] == 0
-!INCLUDE .version.tmp
-# Try git branch name
-!ELSE IF [git rev-parse --abbrev-ref HEAD > .version.tmp 2>nul] == 0
-!INCLUDE .version.tmp
+# Use GITHUB_REF_NAME from GitHub Actions, or default values for local builds
+!IFDEF GITHUB_REF_NAME
+VERSION = $(GITHUB_REF_NAME)
 !ELSE
 VERSION = unknown
 !ENDIF
-# Clean up temp file
-!IF [del .version.tmp 2>nul]
-!ENDIF
+
+!IFDEF GITHUB_SHA
+COMMIT_HASH = $(GITHUB_SHA)
 !ELSE
-VERSION = $(GITHUB_REF_NAME)
+COMMIT_HASH = unknown
 !ENDIF
 
-APP_NAME_VERSION = $(APP_NAME) $(VERSION)
 APP_EXE = $(APP_NAME).exe
 APP_PDB = $(APP_NAME).pdb
 APP_RES = $(APP_NAME).res
 
 CC = CL
-CFLAGS = /std:c++17 /W4 /MD /nologo /w44996 "/DAPPNAME_VERSION=\"$(APP_NAME_VERSION)\""
+CFLAGS = /std:c++17 /W4 /MD /nologo /w44996 "/DAPP_NAME=\"$(APP_NAME)\"" "/DVERSION=\"$(VERSION)\"" "/DCOMMIT_HASH=\"$(COMMIT_HASH)\""
 LFLAGS = /link \
 		 /LIBPATH:..\external\sdl\build\lib \
 		 /ENTRY:mainCRTStartup