Build Stratagus.sh

#!/usr/bin/env zsh

# ANSI colour codes
PURPLE='\033[0;35m'
GREEN='\033[0;32m'
RED='\033[0;31m'
NC='\033[0m' # No Colour

# This just gets the location of the folder where the script is run from. 
SCRIPT_DIR=${0:a:h}
cd "$SCRIPT_DIR"

# Detect CPU architecture and number of cores
ARCH_NAME="$(uname -m)"
CORES=$(sysctl -n hw.ncpu)

# Introduction
echo "\n${PURPLE}This script is for compiling a native macOS build of:"
echo "${GREEN}War1gus - ${PURPLE}Warcraft: Orcs and Humans${NC}"
echo "${GREEN}Wargus - ${PURPLE}Warcraft II${NC}"
echo "${GREEN}Stargus - ${PURPLE}Starcraft${RED} Starcraft is currently not playable${NC}"

echo "\n${PURPLE}The app can extract the original game data from an official GoG or BNE game installer${NC}"
echo "\n${PURPLE}Note that due to a bug in the source code, the source folder is required when using the data extraction tool${NC}"
echo "${PURPLE}The source code folder can be safely deleted after you have extracted the game data\n${NC}"

echo "${GREEN}Homebrew${PURPLE} and the ${GREEN}Xcode command-line tools${PURPLE} are required to build${NC}"
echo "${PURPLE}If they are not present you will be prompted to install them${NC}\n"

# Check for homebrew installation
homebrew_check() {
	echo "${PURPLE}Checking for Homebrew...${NC}"
	if ! command -v brew &> /dev/null; then
		echo -e "${PURPLE}Homebrew not found. Installing Homebrew...${NC}"
		/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
		if [[ "${ARCH_NAME}" == "arm64" ]]; then 
			(echo; echo 'eval "$(/opt/homebrew/bin/brew shellenv)"') >> $HOME/.zprofile
			eval "$(/opt/homebrew/bin/brew shellenv)"
			else 
			(echo; echo 'eval "$(/usr/local/bin/brew shellenv)"') >> $HOME/.zprofile
			eval "$(/usr/local/bin/brew shellenv)"
		fi
		
		# Check for errors
		if [ $? -ne 0 ]; then
			echo "${RED}There was an issue installing Homebrew${NC}"
			echo "${PURPLE}Quitting script...${NC}"	
			exit 1
		fi
	else
		echo -e "${PURPLE}Homebrew found. Updating Homebrew...${NC}"
		brew update
	fi
}

# Function for checking for an individual dependency
single_dependency_check() {
	if [ -d "$(brew --prefix)/opt/$1" ]; then
		echo -e "${GREEN}Found $1. Checking for updates...${NC}"
		brew upgrade $1
	else
		echo -e "${PURPLE}Did not find $1. Installing...${NC}"
		brew install $1
	fi
}

# Install required dependencies
check_all_dependencies() {
	echo -e "${PURPLE}Checking for Homebrew dependencies...${NC}"
	# Required Homebrew packages
	deps=( cmake dylibbundler sdl2 sdl2_mixer sdl2_image lua libpng ffmpeg meson ninja )
	
	for dep in $deps[@]
	do 
		single_dependency_check $dep
	done
}

# Build Stratagus
build_stratagus() {
	echo "${PURPLE}Building Stratagus...${NC}"
	git clone --recurse-submodules https://github.com/Wargus/stratagus
	cd stratagus
	cmake . -B build -DBUILD_VENDORED_LUA=ON -DWITH_OPENMP=OFF 
	# If there is an issue with libs: -DBUILD_VENDORED_MEDIA_LIBS=ON
	make -C build -j$CORES
	cd ..
	export STRATAGUS_INCLUDE_DIR=${PWD}/stratagus/gameheaders
	export STRATAGUS=${PWD}/stratagus/build/stratagus
	
	# Check for errors
	if [ $? -ne 0 ]; then
		echo "${RED}There was an issue building Stratagus${NC}"
		echo "${PURPLE}Quitting script...${NC}"	
		exit 1
	fi
}

build_war1gus() {
	echo "${PURPLE}Building War1gus...${NC}"
	git clone --recurse-submodules https://github.com/Wargus/war1gus
	cd war1gus
	cmake . -B build \
			-DSTRATAGUS_INCLUDE_DIR=$STRATAGUS_INCLUDE_DIR \
			-DSTRATAGUS=$STRATAGUS \
			-DCMAKE_FIND_FRAMEWORK=LAST
	make -C build -j$CORES
	./mac/bundle.sh
	rm -rf ../Warcraft.app
	mv ./mac/War1gus.app ../Warcraft.app && cd ..
	# Optional: Get a Warcraft icon
	curl -o Warcraft.app/Contents/Resources/war1gus.icns https://parsefiles.back4app.com/JPaQcFfEEQ1ePBxbf6wvzkPMEqKYHhPYv8boI1Rc/b219394bc1718b8d2858b5977a1f4b8b_Warcraft.icns
	
	# Bundle libs & Codesign
	dylibbundler -of -cd -b -x ./Warcraft.app/Contents/MacOS/stratagus -d ./Warcraft.app/Contents/libs/
	dylibbundler -of -cd -b -x ./Warcraft.app/Contents/MacOS/war1tool -d ./Warcraft.app/Contents/libs/
	
	# Check for errors
	if [ $? -ne 0 ]; then
		echo "${RED}There was an issue building War1gus${NC}"
		echo "${PURPLE}Quitting script...${NC}"	
		exit 1
	fi
}

build_wargus() {
	echo "${PURPLE}Building Wargus...${NC}"
	git clone --recurse-submodules https://github.com/Wargus/wargus
	cd wargus
	cmake . -B build \
			-DSTRATAGUS_INCLUDE_DIR=$STRATAGUS_INCLUDE_DIR \
			-DSTRATAGUS=$STRATAGUS \
			-DCMAKE_FIND_FRAMEWORK=LAST
	make -C build -j$CORES
	./mac/bundle.sh
	rm -rf ../Warcraft\ II.app
	mv ./mac/Wargus.app ../Warcraft\ II.app && cd ..
	# Optional: Get a Warcraft II icon
	curl -o Warcraft\ II.app/Contents/Resources/wargus.icns https://parsefiles.back4app.com/JPaQcFfEEQ1ePBxbf6wvzkPMEqKYHhPYv8boI1Rc/f333e393cb0e0d7dffe4c63401aa9abb_Warcraft_2.icns
		
	# Bundle libs & Codesign
	dylibbundler -of -cd -b -x ./Warcraft\ II.app/Contents/MacOS/stratagus -d ./Warcraft\ II.app/Contents/libs/
	dylibbundler -of -cd -b -x ./Warcraft\ II.app/Contents/MacOS/wartool -d ./Warcraft\ II.app/Contents/libs/
	
	# Check for errors
	if [ $? -ne 0 ]; then
		echo "${RED}There was an issue building Wargus${NC}"
		echo "${PURPLE}Quitting script...${NC}"	
		exit 1
	fi
}

build_stargus() {
	echo "${PURPLE}Building Stargus...${NC}"
	git clone --recurse-submodules https://github.com/Wargus/stargus
	cd stargus
	meson setup -DSTRATAGUS_INCLUDE_DIR=$STRATAGUS_INCLUDE_DIR -DSTRATAGUS_BIN=$STRATAGUS build
	ninja -C build
	./mac/bundle.sh
	rm -rf ../Starcraft.app
	mv ./mac/Stargus.app ../Starcraft.app && cd ..
	# Optional: Get a Starcraft icon
	curl -o Starcraft.app/Contents/Resources/stargus.icns https://parsefiles.back4app.com/JPaQcFfEEQ1ePBxbf6wvzkPMEqKYHhPYv8boI1Rc/19a774b8baa4ad3dd3e9e097d30d6cd9_Starcraft.icns
		
	# Bundle libs & Codesign
	dylibbundler -of -cd -b -x ./Starcraft.app/Contents/MacOS/stratagus -d ./Starcraft.app/Contents/libs/
	dylibbundler -of -cd -b -x ./Starcraft.app/Contents/MacOS/startool -d ./Starcraft.app/Contents/libs/
	
	# Check for errors
	if [ $? -ne 0 ]; then
		echo "${RED}There was an issue building Stargus${NC}"
		echo "${PURPLE}Quitting script...${NC}"	
		exit 1
	fi
}

PS3='Which game would you like to build? '
OPTIONS=(
	"War1gus"
	"Wargus"
	"War1gus & Wargus"
	"Stargus"
	"All"
	"Quit")
select opt in $OPTIONS[@]
do
	case $opt in
		"War1gus")
			homebrew_check
			check_all_dependencies
			build_stratagus
			build_war1gus
			break
			;;
		"Wargus")
			homebrew_check
			check_all_dependencies
			build_stratagus
			build_wargus
			break
			;;
		"War1gus & Wargus")
			homebrew_check
			check_all_dependencies
			build_stratagus
			build_war1gus
			build_wargus
			break
			;;
		"Stargus")
			homebrew_check
			check_all_dependencies
			build_stratagus
			build_stargus
			break
			;;
		"All")
			homebrew_check
			check_all_dependencies
			build_stratagus
			build_war1gus
			build_wargus
			build_stargus
			break
			;;
		"Quit")
			echo -e "${RED}Quitting${NC}"
			exit 0
			;;
		*) echo "\"$REPLY\" is not one of the options...";;
	esac
done

# Cleanup
# Note: Not removing the source dir because it is required in order for the extractor tool to work due to a bug. 
echo "${PURPLE}Cleaning up...${NC}"
echo "${PURPLE}Not removing the source directories because they are required in order for the extractor tool to work${NC}"
echo "${PURPLE}After you have extracted the game data it is safe to delete the source directories${NC}"
rm -rf stratagus