Merge pull request #1479 from mikeyTheMichael/main

New Port: FAITH: The Unholy Trinity

Author: Cebion

ports/faiththeunholytrinity/FAITH The Unholy Trinity.sh

@@ -0,0 +1,56 @@
+#!/bin/bash
+
+XDG_DATA_HOME=${XDG_DATA_HOME:-$HOME/.local/share}
+
+if [ -d "/opt/system/Tools/PortMaster/" ]; then
+  controlfolder="/opt/system/Tools/PortMaster"
+elif [ -d "/opt/tools/PortMaster/" ]; then
+  controlfolder="/opt/tools/PortMaster"
+elif [ -d "$XDG_DATA_HOME/PortMaster/" ]; then
+  controlfolder="$XDG_DATA_HOME/PortMaster"
+else
+  controlfolder="/roms/ports/PortMaster"
+fi
+
+source $controlfolder/control.txt
+[ -f "${controlfolder}/mod_${CFW_NAME}.txt" ] && source "${controlfolder}/mod_${CFW_NAME}.txt"
+get_controls
+
+# Variables
+GAME_NAME=faiththeunholytrinity
+GAMEDIR="/$directory/ports/$GAME_NAME"
+PATCH_MIN_TIME=5 #In Minutes
+PATCH_MAX_TIME=10 #In Minutes
+
+# CD and set permissions
+cd $GAMEDIR
+> "$GAMEDIR/log.txt" && exec > >(tee "$GAMEDIR/log.txt") 2>&1
+
+# Exports
+export GAME_NAME
+export GAMEDIR
+export PATCHER_FILE="$GAMEDIR/tools/patchscript"
+export PATCHER_GAME="$(basename "${0%.*}")" # This gets the current script filename without the extension
+export PATCHER_TIME="$PATCH_MIN_TIME to $PATCH_MAX_TIME minutes"
+export AARCH
+export LD_LIBRARY_PATH="/usr/lib:$GAMEDIR/lib:$GAMEDIR/tools/libs:$LD_LIBRARY_PATH"
+
+# Check if patchlog.txt to skip patching
+if [ ! -f patchlog.txt ]; then
+    if [ -f "$controlfolder/utils/patcher.txt" ]; then
+        source "$controlfolder/utils/patcher.txt"
+        $ESUDO kill -9 $(pidof gptokeyb)
+    else
+        echo "This port requires the latest version of PortMaster." > $CUR_TTY
+    fi
+else
+    echo "Patching process already completed. Skipping."
+fi
+
+# Assign gptokeyb and load the game
+$GPTOKEYB "gmloadernext.aarch64" -c "$GAME_NAME.gptk" &
+pm_platform_helper "$GAMEDIR/gmloadernext.aarch64"
+./gmloadernext.aarch64 -c gmloader.json
+
+# Cleanup by killing processes
+pm_finish

ports/faiththeunholytrinity/README.md

@@ -0,0 +1,32 @@
+# FAITH The Unholy  - PortMaster Modification & Wrapper
+This is a wrapper and xdelta modification for vanilla FAITH: The Unholy Trinity that makes the game more manageable on retro handheld systems running linux arm64.
+
+## Installation
+Purchase the game on Steam or GOG and copy all the data to `ports/faiththeunholytrinity/assets`, important files are data.win, audiogroup1.dat through audiogroup18.dat, and UTconfigs.cvs files. On first run the game will be patched.
+
+## Controls
+| Button | Action |
+|--|--|
+|START|Menu|
+|D-PAD|Move|
+|A|Action|
+
+## Performance Notes
+This port features audio compression in an attempt to reduce memory usage. This is necessary in order for the port to run on the linux arm handhelds targeted. These handhelds are equipped with low-end rockchip or allwinner processors and usually 1-2GB of memory, alongside Mali blob drivers. Low processing power, low memory, and low VRAM are all major things to watch for when running ports on these devices.
+
+## xDelta Patch Notes
+For the more technically inclined, here are specific modifications made in order to make FAITH: The Unholy Trinity run smoothly on the targeted devices:
+
+- [GMTools](https://github.com/cdeletre/gmtools) by Cyril Deletre to resample audio at a lower bitrate
+- [UndertaleModTool](https://github.com/UnderminersTeam/UndertaleModTool) to make some specific changes to the game
+    - Compress Textures to save memory.
+    - (Steam Version Only) About 50% of steam api function calls did not check if steam was initialized, leading to some math with undefined values which would cause segfaults. Steam API functions are now wrapped in an if statement to verifed that steam is initialized.
+
+## Thanks
+Airdorf -- For the amazing game
+- https://store.steampowered.com/app/1179080/FAITH_The_Unholy_Trinity/
+- https://www.gog.com/en/game/faith_the_unholy_trinity
+JohnnyOnFlame -- For GMLoader-Next 
+Cyril aka kotzebuedog -- For GMTools audio patcher
+Jeod -- For the UFO 50 port, which was used as reference for this port
+Testers & Devs from the PortMaster Discord

ports/faiththeunholytrinity/cover.png

@@ -0,0 +1,24 @@
+back = \"
+start = \"
+up = \"
+down = \"
+left = \"
+right = \"
+a = \"
+b = \"
+x = \"
+y = \"
+l1 = \"
+l2 = \"
+l3 = \"
+r1 = \"
+r2 = \"
+r3 = \"
+left_analog_up = \"
+left_analog_down = \"
+left_analog_left = \"
+left_analog_right = \"
+right_analog_up = \"
+right_analog_down = \" 
+right_analog_left = \"
+right_analog_right = \"

ports/faiththeunholytrinity/faiththeunholytrinity/assets/.gitkeep

@@ -0,0 +1,8 @@
+{
+    "save_dir" : "saves",
+    "apk_path" : "faiththeunholytrinity.port",
+    "show_cursor" : false,
+    "disable_controller" : false,
+    "disable_depth" : false,
+    "force_platform" : "os_windows"
+}