Build PSP

.github/workflows/compile.yml → .github/workflows/compile-linux.yml

@@ -1,7 +1,6 @@
 name: linux ubuntu build
 
-on:
-  push
+on: push
 
 jobs:
   build:
@@ -15,7 +14,7 @@ jobs:
         run: |
             sudo apt update
             ./easy-compile-ubuntu
-
+    
       - name: Run Release
         if: startsWith(github.ref, 'refs/tags/')
         run: ./release/release-ubuntu

.github/workflows/compile-psp.yml

@@ -0,0 +1,48 @@
+name: psp build
+
+on:
+  push
+
+jobs:
+  build:
+    name: Compile
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Run build
+        run: ./easy-compile-docker-psp
+
+      - name: Run Release
+        if: startsWith(github.ref, 'refs/tags/')
+        run: ./release/release-psp
+
+      - name: Archive Folder
+        uses: actions/upload-artifact@v4
+        with:
+          name: artifact
+          path: |
+            ${{github.workspace}}/*.pbp
+            ${{github.workspace}}/*.prx
+
+  publish-release:
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Download Artifact
+        uses: actions/download-artifact@v4
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          name: artifact
+          path: ${{github.workspace}}
+
+      - name: Create Release
+        id: create_release
+        uses: softprops/action-gh-release@v1
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          files: |
+            ${{ github.workspace }}/*.pbp
+            ${{ github.workspace }}/*.prx

.gitignore

@@ -1,5 +1,6 @@
 build
 build-debug
+build-psp
 mingw-bin
 /paintown
 .scon*
@@ -17,3 +18,8 @@ peg_*.py
 *.dmg.sparseimage
 *.deb
 .idea
+
+
+*.pbp
+*.prx
+*.elf

Makefile

@@ -51,5 +51,11 @@ ensure-mingw:
 	@x86_64-w64-mingw32-g++-posix --version > /dev/null || { exit 1; }
 	@echo "Ok."
 
+# Default values
+PRX := false
+psp:
+	./easy-compile-docker-psp -prx $(PRX) && \
+	./release/release-psp -prx $(PRX)
+
 clean:
-	rm -rf build-debug build-release build-mingw
+	rm -rf .tmp build build-*

README.md

@@ -19,6 +19,7 @@ Paintown is a 2-d fighting game that is similar in style to Streets of Rage. Pai
 ![Mac Arm Build](https://github.com/kazzmir/paintown/actions/workflows/compile-mac-arm.yml/badge.svg)
 ![Mingw Cross-Compile Build](https://github.com/kazzmir/paintown/actions/workflows/mingw-cross.yml/badge.svg)
 ![Devkitpro Cross-Compile Build](https://github.com/kazzmir/paintown/actions/workflows/compile-dkp.yml/badge.svg)
+![PSP Cross-Compile Build](https://github.com/kazzmir/paintown/actions/workflows/compile-psp.yml/badge.svg)
 ![Steam Cross-Compile Build](https://github.com/kazzmir/paintown/actions/workflows/compile-steam.yml/badge.svg)
 
 ## Releases
@@ -44,6 +45,7 @@ You need the following things to compile Paintown:
 	* *Note that you will need to have c++11 support*
 * Software construction tools
 	* [Meson](https://mesonbuild.com/)
+    * [Docker](http://docker.com)
 * [zlib](http://www.zlib.net/)
 * [libpng](http://www.libpng.org/pub/png/libpng.html)
 * [SDL2](https://github.com/libsdl-org/SDL/tree/SDL2)
@@ -92,11 +94,14 @@ $ ./easy-compile-mingw
 `
 $ ./easy-compile-fedora
 `
-
 ### Mac Arm
 `
 $ ./easy-compile-mac-arm
 `
+### PSP
+```shell
+./easy-compile-docker-psp
+```
 
 ## Scripting
 

docker/Dockerfile.psp

@@ -0,0 +1,10 @@
+FROM pspdev/pspdev
+
+# build : DOCKER_DEFAULT_PLATFORM=linux/amd64 docker build -t paintown-psp-build -f Dockerfile.psp .
+# shell : DOCKER_DEFAULT_PLATFORM=linux/amd64 docker run --rm -itv${PWD}:/paintown-bin -w /paintown-bin paintown-psp-build bash
+
+ENV PSPSDK $PSPDEV/psp
+ENV PATH   $PATH:$PSPDEV/bin:$PSPSDK/bin
+
+RUN apk add meson build-base bash git autoconf automake python3 py3-pip cmake pkgconfig libarchive-dev openssl-dev gpgme-dev libtool curl-dev
+RUN psp-pacman -Sy && echo y | psp-pacman -Syu yaml-cpp

easy-compile-docker-psp

@@ -0,0 +1,59 @@
+#!/bin/bash -e
+
+EXE=paintown-psp.elf
+BUILD_DIR=/tmp
+
+# usage: ./easy-compile-docker-psp -prx true
+
+# Default values
+PRX=false
+
+# Parse named arguments
+while [[ $# -gt 0 ]]; do
+    case "$1" in
+        -prx)
+            PRX="$2"
+            shift 2
+            ;;
+        *)
+            echo "Invalid option: $1" >&2
+            exit 1
+            ;;
+    esac
+done
+echo PRX=$PRX
+
+
+export DOCKER_DEFAULT_PLATFORM=linux/amd64
+docker build -t paintown-psp-build -f docker/Dockerfile.psp .
+docker run --rm -iv${PWD}:/paintown-bin -w /paintown-bin paintown-psp-build sh -s <<EOF
+
+# copy for further modification
+cp misc/psp/mips32-eabi-psp.txt ${BUILD_DIR}/mips32-eabi-psp.txt
+
+if [[ '$PRX' == 'false' ]]; then
+    # Clean link_flags_prx
+    sed -i '/^link_flags_prx = /c\link_flags_prx = \[\]' ${BUILD_DIR}/mips32-eabi-psp.txt
+fi
+
+# setup
+misc/psp-environment.sh
+meson setup --cross-file ${BUILD_DIR}/mips32-eabi-psp.txt ${BUILD_DIR}
+
+# compile
+(cd ${BUILD_DIR}; meson configure -Dbuild_tests=false)
+meson compile -C ${BUILD_DIR} || { echo "Compilation ERROR"; exit 1; }
+
+# copy
+chown $(id -u):$(id -g) ${BUILD_DIR}/paintown
+cp ${BUILD_DIR}/paintown ${EXE}
+psp-readelf -S ${EXE}
+EOF
+
+echo "
+To run you will need a CFW [custom firmware] or system that can boot unsigned applications
+"
+ls -l ${EXE}
+file ${EXE}
+echo "Here is the executable ${EXE}. To run you need to package as a pbp file"
+

meson.build

@@ -16,6 +16,7 @@ sdl_graphics_dependency = []
 sdl_graphics_library = []
 yaml_cpp_dependency = []
 yaml_cpp_library = []
+have_pic = not meson.is_cross_build()
 other_dependencies = []
 
 # Not supported in mingw

misc/psp-environment.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+echo "
+Isn't necessary to install any dependency.
+Because docker image pspdev/pspdev already contains: SDL2,SDL2_image,SDL2_mixer,SDL2_image,SDL2_gfx,yaml-cpp
+"

misc/psp/mips32-eabi-psp.txt

@@ -0,0 +1,43 @@
+[constants]
+psp_root = '/usr/local/pspdev'
+psp_sdk_root = psp_root / 'psp/sdk'
+common_args = ['-I' + psp_root / 'include'
+             , '-I' + psp_sdk_root / '/include'
+             , '-I' + psp_root / 'psp/include'
+             , '-I' + psp_root / 'include/freetype2'
+             , '-I' + psp_root / 'include/SDL'
+             , '-I' + psp_sdk_root / 'include'
+             , '-DDEBUG'
+             , '-DMINPSPW'
+             , '-DHAVE_YAML_CPP'
+             , '-DDATA_PATH="ms0:/PSP/GAME/paintown/data"'
+             , '-D_PSP_FW_VERSION=500'
+             , '-DINCLUDE_SCE_MODULE_INFO'
+             , '-L' + psp_root / 'sdk/lib'
+             , '-L' + psp_root / 'lib'
+             , '-L' + psp_sdk_root / 'lib'
+             , '-lSDL2_gfx'
+             , '-latomic'
+             , '-lpspdebug'
+             , '-lyaml-cpp'
+             , '-fno-rtti'
+            ]
+link_flags_prx = ['-specs=' + psp_root + '/psp/sdk/lib/prxspecs' , '-Wl,-q,-T' + psp_root + '/psp/sdk/lib/linkfile.prx']
+
+[binaries]
+c = 'psp-gcc'
+cpp = 'psp-g++'
+ar = 'psp-ar'
+strip = 'psp-strip'
+pkg-config = 'psp-pkgconf'
+sdl2-config = psp_root / 'psp/bin/sdl2-config'
+
+[built-in options]
+cpp_args = common_args
+cpp_link_args = common_args + link_flags_prx
+
+[host_machine]
+system = 'psp'
+cpu_family = 'mips'
+cpu = 'mipsel'
+endian = 'little'

release/release-psp

@@ -0,0 +1,96 @@
+#!/bin/bash -e
+
+SCRIPT_DIR="$(dirname "$(readlink -f "$0")")"
+EXEDIR="$SCRIPT_DIR/.." 
+EXE=paintown.pbp
+
+APPVERSION_TAG=`git tag --sort=-committerdate | head -n 1`
+APPVERSION_COMMIT=`git log --format=%h -n 1`
+
+# Regular expression to match 'v' followed by a number version
+TAG_VERSION_REGEX='^v[0-9]+\.[0-9]+'
+
+# Check if the variable matches the regular expression
+if [[ $APPVERSION_TAG =~ $TAG_VERSION_REGEX ]]; then
+    APPVERSION=$APPVERSION_TAG
+else
+    APPVERSION=$APPVERSION_COMMIT
+fi
+
+# usage: ./release/release-psp -prx true
+
+# Default values
+PRX=false
+
+# Parse named arguments
+while [[ $# -gt 0 ]]; do
+    case "$1" in
+        -prx)
+            PRX="$2"
+            shift 2
+            ;;
+        *)
+            echo "Invalid option: $1" >&2
+            exit 1
+            ;;
+    esac
+done
+echo PRX=$PRX
+
+# inside tmp
+cd $SCRIPT_DIR
+rm -rf tmp && mkdir tmp && cd tmp
+
+# copy resources
+cp $EXEDIR/misc/psp/ICON0.PNG $EXEDIR/misc/psp/ICON1.PNG .
+cp $EXEDIR/misc/psp/PIC0.PNG $EXEDIR/misc/psp/PIC1.PNG .
+cp $EXEDIR/misc/psp/SND0.AT3 .
+cp $EXEDIR/paintown-psp.elf EBOOT.ELF
+
+# builder
+docker run --rm -iv `pwd`:/paintown-bin -w /paintown-bin paintown-psp-build bash -s <<EOF
+
+echo 1. Creating PARAM.SFO files.
+mksfo "Paintown $APPVERSION" PARAM.SFO && echo "OK" || echo "Error"
+
+echo 2. Fixing up import tables post-linking to remove unused functions from the executable.
+psp-fixup-imports EBOOT.ELF && echo "OK" || echo "Error"
+
+if [[ '$PRX' == 'true' ]]; then
+
+    echo 3. Converting specially made ELFs to PRX files.
+    psp-prxgen EBOOT.ELF EBOOT.PRX && echo "OK" || echo "Error"
+
+    chown $(id -u):$(id -g) EBOOT.PRX
+    ls -lh EBOOT.PRX
+
+else 
+
+    # pack-pbp <output.pbp> <param.sfo> <icon0.png> <icon1.pmf> <pic0.png> <pic1.png> <snd0.at3> <data.psp> <data.psar>
+    # <output.pbp>: The desired name for your PBP file.
+    # <param.sfo> : The PARAM.SFO file containing metadata about your application.
+    # <icon0.png> : The icon image that represents your application on the PSP menu.
+    # <icon1.pmf> : The 44x44 pixel image file.
+    # <pic0.png>  : The background image for the PSP menu. (PSP menu background): 480x272 pixels
+    # <pic1.png>  : The background image for the settings screen.  (Settings screen background): 480x272 pixels
+    # <snd0.at3>  : The startup sound file.
+    # <data.psp>  : The main executable file (EBOOT.BIN).
+    # <data.psar> : An optional data file in PSAR format.
+
+    echo 3. Generating EBOOT.PBP
+    pack-pbp EBOOT.PBP PARAM.SFO ICON0.PNG ICON1.PNG PIC0.PNG PIC1.PNG SND0.AT3 EBOOT.ELF NULL && echo "OK" || echo "Error"
+
+    chown $(id -u):$(id -g) EBOOT.PBP
+    ls -lh EBOOT.PBP
+
+fi
+EOF
+
+tree
+
+# Move outside the contiainer
+if [[ "$PRX" == "true" ]]; then
+    mv EBOOT.PRX $EXEDIR/paintown-psp-$APPVERSION.prx
+else
+    mv EBOOT.PBP $EXEDIR/paintown-psp-$APPVERSION.pbp
+fi

runtime-test-nix

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+# Check if running on macOS
+if [[ "$(uname)" == "Darwin" ]]; then
+    # Check if gtimeout is available
+    if command -v gtimeout &> /dev/null; then
+        alias timeout="gtimeout"
+    else
+        echo "brew install coreutils"
+    fi
+fi
+
+# Another display
+export DISPLAY=:1
+
+# Setup xvfb for screen 0
+Xvfb $DISPLAY -screen 0 800x600x24 &
+
+# Test
+timeout 3s ./paintown -s nosound -m nomusic --data `pwd`/data | tee paintown.log
+
+# Check if the application started and terminated successfully based on the log
+if grep -q "Set graphics mode: Ok" paintown.log && grep -q "Bye" paintown.log ; then
+    echo "Test passed"
+else
+    echo "Test failed"
+    exit 1
+fi

src/main-menu.cpp

@@ -12,7 +12,7 @@
  * On consoles set it to -1 to disable all text output.
  * If you are debugging then higher values like 1 or 2 are ok.
  */
-#if defined(XENON) || defined(DEVKITPRO)
+#if defined(XENON) || defined(DEVKITPRO) || defined(MINPSPW)
 //static const int DEFAULT_DEBUG = -1;
 static const int DEFAULT_DEBUG = 3;
 #else