iOS port

.github/workflows/build.yml

@@ -180,6 +180,50 @@ jobs:
       - name: Pack cache
         run: cd ~ && tar cJf ccache.tar.xz .cache/ccache workspacecache.tar
 
+  build-ios:
+    name: Build (iOS)
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Get Time
+        id: get-time
+        run: echo "time=$(date -u '+%Y-%m-%d-%H:%M:%S')" >> $GITHUB_OUTPUT
+      - uses: actions/cache@v5
+        with:
+          path: ~/ccache.tar.xz
+          key: ios-artifact-${{ steps.get-time.outputs.time }}
+          restore-keys: ios-artifact-
+      - name: Unpack cache
+        run: |
+          cd ~
+          [ -f ccache.tar.xz ] && tar xf ccache.tar.xz || true
+          [ -f workspacecache.tar ] && mv workspacecache.tar ${{ github.workspace }} || true
+      - name: Install dependencies
+        run: |
+          wget https://apt.llvm.org/llvm.sh
+          sudo bash llvm.sh 22
+          sudo apt-get update
+          sudo apt-get install -y ccache libplist-dev libplist-utils clang-22
+          [ -f workspacecache.tar ] && tar xf workspacecache.tar
+          ./artifacts/ios/build-toolchain.sh
+          tar cf workspacecache.tar artifacts/ios/build/toolchain
+          mv workspacecache.tar ~
+      - name: Build
+        run: |
+          PATH="$PWD/artifacts/ios/build/toolchain/bin:$PATH" make \
+              NO_COLOR=1 \
+              VERBOSE=1 \
+              CC='ccache ios-cc'
+        env:
+          CLANG: clang-22
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: butterscotch-ios
+          path: build/butterscotch.ipa
+      - name: Pack cache
+        run: cd ~ && tar cJf ccache.tar.xz .cache/ccache workspacecache.tar
+
   build-ps2:
     name: Build (PS2)${{ matrix.label }}
     runs-on: ubuntu-24.04

CMakeLists.txt

@@ -71,6 +71,7 @@ option(ENABLE_WAD16 "Enable support for WAD Version 15/16" ON)
 option(ENABLE_WAD17 "Enable support for WAD Version 17" ON)
 option(ENABLE_LEGACY_GL "Enable the legacy OpenGL renderer" ON)
 option(ENABLE_MODERN_GL "Enable the modern OpenGL renderer" ON)
+option(ENABLE_SW_RENDERER "Enable the software renderer" ON)
 if(NOT ENABLE_WAD14 AND NOT ENABLE_WAD16 AND NOT ENABLE_WAD17)
     message(FATAL_ERROR "You need to build Butterscotch with at least one WAD version enabled!")
 endif()
@@ -89,6 +90,9 @@ endif()
 if(ENABLE_MODERN_GL)
     add_compile_definitions(ENABLE_MODERN_GL)
 endif()
+if(ENABLE_SW_RENDERER)
+    add_compile_definitions(ENABLE_SW_RENDERER)
+endif()
 
 if(PLATFORM STREQUAL "web-meta")
     # Metadata-only build: just the data.win parser and its direct deps. No VM, no runner, no I/O subsystems.
@@ -186,20 +190,27 @@ if(PLATFORM STREQUAL "desktop")
     # Matches the GitHub Actions container flags (FORTIFY requires building with optimizations enabled!)
     target_compile_options(butterscotch PRIVATE "$<$<CONFIG:Release,RelWithDebInfo>:-U_FORTIFY_SOURCE;-D_FORTIFY_SOURCE=2>")
 
-    if(NOT ENABLE_LEGACY_GL AND NOT ENABLE_MODERN_GL)
+    if(NOT ENABLE_LEGACY_GL AND NOT ENABLE_MODERN_GL AND NOT ENABLE_SW_RENDERER)
         message(FATAL_ERROR "You must enable at least one renderer!")
     endif()
-    file(GLOB GL_SOURCES src/image/*.c src/gl_common/*.c)
+    file(GLOB GL_SOURCES src/image/*.c)
+    if(ENABLE_LEGACY_GL OR ENABLE_MODERN_GL)
+        file(GLOB GL_SOURCES ${GL_SOURCES} src/gl_common/*.c)
+        target_include_directories(butterscotch PRIVATE ${CMAKE_SOURCE_DIR}/src/gl)
+        target_include_directories(butterscotch PRIVATE ${CMAKE_SOURCE_DIR}/src/gl_common)
+    endif()
     if(ENABLE_LEGACY_GL)
         file(GLOB GL_SOURCES ${GL_SOURCES} src/gl_legacy/*.c)
         target_include_directories(butterscotch PRIVATE ${CMAKE_SOURCE_DIR}/src/gl_legacy)
     endif()
     if(ENABLE_MODERN_GL)
         file(GLOB GL_SOURCES ${GL_SOURCES} src/gl/*.c)
     endif()
+    if(ENABLE_SW_RENDERER)
+        file(GLOB GL_SOURCES ${GL_SOURCES} src/sw/*.c)
+        target_include_directories(butterscotch PRIVATE ${CMAKE_SOURCE_DIR}/src/sw)
+    endif()
     target_sources(butterscotch PRIVATE ${GL_SOURCES})
-    target_include_directories(butterscotch PRIVATE ${CMAKE_SOURCE_DIR}/src/gl)
-    target_include_directories(butterscotch PRIVATE ${CMAKE_SOURCE_DIR}/src/gl_common)
     target_include_directories(butterscotch PRIVATE ${CMAKE_SOURCE_DIR}/src/image)
     if (MSVC)
         target_include_directories(butterscotch PRIVATE ${CMAKE_SOURCE_DIR}/compat/getopt)
@@ -231,13 +242,16 @@ if(PLATFORM STREQUAL "desktop")
     endif()
 
     # GLAD
-    add_library(glad STATIC vendor/glad/src/glad.c)
-    target_include_directories(glad PUBLIC vendor/glad/include)
+    if(ENABLE_LEGACY_GL OR ENABLE_MODERN_GL OR DESKTOP_BACKEND STREQUAL "glfw3" OR DESKTOP_BACKEND STREQUAL "glfw2")
+        add_library(glad STATIC vendor/glad/src/glad.c)
+        target_include_directories(glad PUBLIC vendor/glad/include)
+        set(PLATFORM_LIBRARIES glad)
+    endif()
 
     # stb_image
     target_include_directories(butterscotch PUBLIC vendor/stb/image)
 
-    set(PLATFORM_LIBRARIES glad bzip2 stb_ds sha1 stb_vorbis)
+    set(PLATFORM_LIBRARIES ${PLATFORM_LIBRARIES} bzip2 stb_ds sha1 stb_vorbis)
     if(NOT MSVC)
         set(PLATFORM_LIBRARIES ${PLATFORM_LIBRARIES} m)
     endif()

Makefile

@@ -42,8 +42,14 @@ INCLUDES += $(INCLUDE). \
 HEADERS := $(wildcard src/*.h) $(shell find vendor -name '*.h')
 SRCS := $(wildcard src/*.c) $(wildcard src/image/*.c) $(wildcard vendor/bzip2/*.c) vendor/md5/md5.c vendor/sha1/sha1.c vendor/base64/base64.c
 
+ifeq ($(OS),iOS)
+DESKTOP_BACKEND := ios
+AUDIO_BACKEND := openal
+DISABLE_LEGACY_GL := 1
+else
 DESKTOP_BACKEND := glfw3
 AUDIO_BACKEND := miniaudio
+endif
 
 ifdef BUTTERSCOTCH_COMMIT_DATE
 DEFINES += $(DEFINE)BUTTERSCOTCH_COMMIT_DATE=\"$(BUTTERSCOTCH_COMMIT_DATE)\"
@@ -101,7 +107,10 @@ SDL3_LIBS += $(shell pkg-config $(PKG_CONFIG_FLAGS) --libs sdl3)
 LIBS += $(SDL3_LIBS)
 DEFINES += $(DEFINE)USE_SDL3
 endif
-
+ifeq ($(DESKTOP_BACKEND),ios)
+LIBS += -framework Foundation -framework UIKit -framework OpenGLES -framework QuartzCore -framework CoreGraphics
+DEFINES += -DUSE_IOS
+endif
 
 # GNU make doesn't have a way to do OR in conditionals, stupid language for clowns
 ifndef DISABLE_LEGACY_GL
@@ -131,6 +140,13 @@ SRCS += $(wildcard src/gl/*.c)
 HEADERS += $(wildcard src/gl/*.h)
 endif
 
+ifndef DISABLE_SW_RENDERER
+DEFINES += -DENABLE_SW_RENDERER
+SRCS += $(wildcard src/sw/*.c)
+HEADERS += $(wildcard src/sw/*.h)
+INCLUDES += -Isrc/sw
+endif
+
 ifdef DISABLE_WAD14
 ifdef DISABLE_WAD16
 ifdef DISABLE_WAD17
@@ -141,25 +157,31 @@ endif
 
 ifdef DISABLE_LEGACY_GL
 ifdef DISABLE_MODERN_GL
+ifdef DISABLE_SW_RENDERER
 $(error must enable at least 1 renderer)
 endif
 endif
+endif
 
 ifeq ($(AUDIO_BACKEND),miniaudio)
 INCLUDES += $(INCLUDE)src/audio/miniaudio $(INCLUDE)vendor/miniaudio
 DEFINES += $(DEFINE)USE_MINIAUDIO
 SRCS += $(wildcard src/audio/miniaudio/*.c)
 HEADERS += $(wildcard src/audio/miniaudio/*.h)
 ifneq ($(OS),Windows)
+ifeq ($(OS),iOS)
+LIBS += -framework AVFoundation -framework AudioToolbox
+else
 LIBS += -pthread
 endif
 endif
+endif
 ifeq ($(AUDIO_BACKEND),openal)
 INCLUDES += $(INCLUDE)src/audio/openal
 DEFINES += $(DEFINE)USE_OPENAL
 SRCS += $(wildcard src/audio/openal/*.c)
 HEADERS += $(wildcard src/audio/openal/*.h)
-ifeq ($(OS),Darwin)
+ifneq ($(filter Darwin iOS,$(OS)),) # OS is 'Darwin' or 'iOS'
 LIBS += -framework OpenAL
 else
 LIBS += -lopenal
@@ -181,7 +203,7 @@ DEFINES += $(DEFINE)_CRT_SECURE_NO_WARNINGS
 endif
 DEFINES += $(DEFINE)WIN32_LEAN_AND_MEAN
 else
-ifeq ($(OS),Darwin)
+ifneq ($(filter Darwin iOS,$(OS)),) # OS is 'Darwin' or 'iOS'
 LIBS += -lobjc
 else
 LIBS += -lm
@@ -205,10 +227,11 @@ compat/config.mk: compat/configure.sh compat/tmp/cc
 
 endif
 
-build/butterscotch: $(OBJS)
+build/butterscotch: $(OBJS) $(if $(filter iOS,$(OS)),artifacts/ios/build-ipa.sh $(wildcard artifacts/ios/assets/*))
 	@{ [ -z "$(NO_COLOR)" ] && [ -t 1 ]; } && printf " \033[1;34mLD\033[0m butterscotch\n" || printf " LD butterscotch\n"
 	$(V)$(_CC) $(LDFLAGS) $(OBJS) $(LIBS) $(EXTRALIBS) $(OUTPUT_EXE)$@
 	@[ -f $@.exe ] && chmod +x $@.exe || true
+	@if [ "$(OS)" = 'iOS' ]; then artifacts/ios/build-ipa.sh; fi
 
 build/%.c.$(OBJ_EXT): %.c compat/config.mk $(if $(DISABLE_MMD),$(HEADERS))
 	@mkdir -p $(dir $@)

artifacts/ios/SDKSettings.json

@@ -0,0 +1,28 @@
+{
+  "DisplayName": "iOS 8.0",
+  "DocSetFeedURL": "http://developer.apple.com/rss/com.apple.adc.documentation.AppleiPhone8_0.atom",
+  "MinimalDisplayName": "8.0",
+  "DefaultProperties": {
+    "AD_HOC_CODE_SIGNING_ALLOWED": "NO",
+    "SUPPORTED_DEVICE_FAMILIES": "1,2",
+    "DEFAULT_COMPILER": "com.apple.compilers.llvm.clang.1_0",
+    "IPHONEOS_DEPLOYMENT_TARGET": "8.0",
+    "DEAD_CODE_STRIPPING": "YES",
+    "CODE_SIGN_ENTITLEMENTS": "",
+    "ENTITLEMENTS_REQUIRED": "YES",
+    "CODE_SIGNING_REQUIRED": "YES",
+    "PLATFORM_NAME": "iphoneos",
+    "GCC_THUMB_SUPPORT": "YES"
+  },
+  "Version": "8.0",
+  "Toolchains": [
+    "com.apple.dt.toolchain.iOS8_0"
+  ],
+  "MinimumSupportedToolsVersion": "3.2.3",
+  "IsBaseSDK": "YES",
+  "AlternateSDK": "iphonesimulator8.0",
+  "MaximumDeploymentTarget": "8.0.99",
+  "CanonicalName": "iphoneos8.0",
+  "DocSetFeedName": "Apple iPhone OS 8.0",
+  "CustomProperties": {}
+}

artifacts/ios/assets/Icon-60@2x.png

@@ -0,0 +1 @@
+Icon-40@3x.png

artifacts/ios/assets/Info.plist

@@ -0,0 +1,146 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+    <key>CFBundleDevelopmentRegion</key>
+    <string>en</string>
+    <key>CFBundleDisplayName</key>
+    <string>Butterscotch</string>
+    <key>CFBundleExecutable</key>
+    <string>butterscotch</string>
+    <key>CFBundleIdentifier</key>
+    <string>com.mrpowergamerbr.butterscotch</string>
+    <key>CFBundleInfoDictionaryVersion</key>
+    <string>6.0</string>
+    <key>CFBundleName</key>
+    <string>Butterscotch</string>
+    <key>CFBundlePackageType</key>
+    <string>APPL</string>
+    <key>CFBundleSignature</key>
+    <string>????</string>
+    <key>CFBundleVersion</key>
+    <string>0.7.6</string>
+    <key>CFBundleShortVersionString</key>
+    <string>0.7.6</string>
+    <key>CFBundleSupportedPlatforms</key>
+    <array>
+        <string>iPhoneOS</string>
+    </array>
+    <key>MinimumOSVersion</key>
+    <string>2.0</string>
+    <key>UIDeviceFamily</key>
+    <array>
+        <integer>1</integer>
+        <integer>2</integer>
+    </array>
+    <key>UIStatusBarHidden</key>
+    <true/>
+    <key>UIFileSharingEnabled</key>
+    <true/>
+    <key>LSSupportsOpeningDocumentsInPlace</key>
+    <true/>
+    <key>UIViewControllerBasedStatusBarAppearance</key>
+    <false/>
+    <key>CFBundleIconFiles</key>
+    <array>
+        <string>Icon.png</string>
+        <string>Icon@2x.png</string>
+        <string>Icon-72.png</string>
+        <string>Icon-72@2x.png</string>
+        <string>Icon-Small.png</string>
+        <string>Icon-Small@2x.png</string>
+    </array>
+    <key>CFBundleIcons</key>
+    <dict>
+        <key>CFBundlePrimaryIcon</key>
+        <dict>
+            <key>CFBundleIconFiles</key>
+            <array>
+                <string>Icon-20.png</string>
+                <string>Icon-20@2x.png</string>
+                <string>Icon-20@3x.png</string>
+                <string>Icon-40.png</string>
+                <string>Icon-40@2x.png</string>
+                <string>Icon-40@3x.png</string>
+                <string>Icon-60@2x.png</string>
+                <string>Icon-60@3x.png</string>
+            </array>
+        </dict>
+    </dict>
+    <key>CFBundleIcons~ipad</key>
+    <dict>
+        <key>CFBundlePrimaryIcon</key>
+        <dict>
+            <key>CFBundleIconFiles</key>
+            <array>
+                <string>Icon-20.png</string>
+                <string>Icon-20@2x.png</string>
+                <string>Icon-40.png</string>
+                <string>Icon-40@2x.png</string>
+                <string>Icon-72.png</string>
+                <string>Icon-72@2x.png</string>
+                <string>Icon-76.png</string>
+                <string>Icon-76@2x.png</string>
+                <string>Icon-83.5@2x.png</string>
+            </array>
+        </dict>
+    </dict>
+    <key>UILaunchImages</key>
+    <array>
+        <dict>
+            <key>UILaunchImageName</key>
+            <string>Default</string>
+            <key>UILaunchImageMinimumOSVersion</key>
+            <string>2.0</string>
+            <key>UILaunchImageOrientation</key>
+            <string>Portrait</string>
+            <key>UILaunchImageSize</key>
+            <string>{320, 480}</string>
+        </dict>
+        <dict>
+            <key>UILaunchImageName</key>
+            <string>Default-568h</string>
+            <key>UILaunchImageMinimumOSVersion</key>
+            <string>7.0</string>
+            <key>UILaunchImageOrientation</key>
+            <string>Portrait</string>
+            <key>UILaunchImageSize</key>
+            <string>{320, 568}</string>
+        </dict>
+        <dict>
+            <key>UILaunchImageName</key>
+            <string>Default-667h</string>
+            <key>UILaunchImageMinimumOSVersion</key>
+            <string>8.0</string>
+            <key>UILaunchImageOrientation</key>
+            <string>Portrait</string>
+            <key>UILaunchImageSize</key>
+            <string>{375, 667}</string>
+        </dict>
+        <dict>
+            <key>UILaunchImageName</key>
+            <string>Default-736h</string>
+            <key>UILaunchImageMinimumOSVersion</key>
+            <string>8.0</string>
+            <key>UILaunchImageOrientation</key>
+            <string>Portrait</string>
+            <key>UILaunchImageSize</key>
+            <string>{414, 736}</string>
+        </dict>
+        <dict>
+            <key>UILaunchImageName</key>
+            <string>Default-812h</string>
+            <key>UILaunchImageMinimumOSVersion</key>
+            <string>11.0</string>
+            <key>UILaunchImageOrientation</key>
+            <string>Portrait</string>
+            <key>UILaunchImageSize</key>
+            <string>{375, 812}</string>
+        </dict>
+    </array>
+    <key>UISupportedInterfaceOrientations</key>
+    <array>
+        <string>UIInterfaceOrientationPortrait</string>
+    </array>
+</dict>
+</plist>