Replace PyGame dependency with pillow

PyGame is used to load manipulate and save image data idependently
of their file format.

The PyGame project is fairly big and has caused various unexpected
logging in the tools, so replace it with pillow, which is sufficient
for our use case.

Also expose OOP and functional API for tiletool, so it can be
consumed by custom tools.

Author: dciabrin

.github/scripts/build-msys2.sh

@@ -11,7 +11,6 @@ autoreconf -iv
     --target=${MSYSTEM_CHOST} \
     --enable-external-toolchain \
     --enable-external-emudbg \
-    --enable-external-gngeo \
-    --enable-examples=no
+    --enable-external-gngeo
 make
 make install

.github/workflows/build-and-publish.yaml

@@ -47,7 +47,7 @@ jobs:
 
       - name: Install dependencies for ngdevkit-examples
         run: >
-          sudo apt-get install -y python3-yaml ngdevkit-gngeo python3-pygame imagemagick
+          sudo apt-get install -y python3-yaml ngdevkit-gngeo python3-pil imagemagick
           sox libsox-fmt-mp3 libglew-dev libsdl2-dev
 
       - name: Test by compiling ngdevkit-examples
@@ -86,6 +86,16 @@ jobs:
       - name: Build
         run: ./.github/scripts/build-msys2.sh
 
+      - name: Install dependencies for ngdevkit-examples
+        run: |
+          pacman -S --noconfirm pactoys rsync
+          pacboy -S --noconfirm python:u python-pillow:u toolchain:u zlib:u sox:u imagemagick:u
+          pip install python-yaml
+
+      - name: Test by compiling ngdevkit-examples
+        run: ./.github/scripts/test.sh
+
+
   macos:
     name: "macOS build"
     runs-on: macos-15
@@ -100,8 +110,8 @@ jobs:
         run: |
           brew tap dciabrin/ngdevkit
           brew install python3 --overwrite
+          brew install pillow
           brew install automake ngdevkit-toolchain zip pkg-config sdl2 sdl2_image
-          $(brew --prefix python)/libexec/bin/pip install pygame --break-system-packages
 
       - name: Build
         run: ./.github/scripts/build.sh

.github/workflows/build-tests.yaml

@@ -47,7 +47,7 @@ jobs:
 
       - name: Install dependencies for ngdevkit-examples
         run: >
-          sudo apt-get install -y python3-yaml ngdevkit-gngeo python3-pygame imagemagick
+          sudo apt-get install -y python3-yaml ngdevkit-gngeo python3-pil imagemagick
           sox libsox-fmt-mp3 libglew-dev libsdl2-dev
 
       - name: Test by compiling ngdevkit-examples
@@ -86,6 +86,16 @@ jobs:
       - name: Build
         run: ./.github/scripts/build-msys2.sh
 
+      - name: Install dependencies for ngdevkit-examples
+        run: |
+          pacman -S --noconfirm pactoys rsync
+          pacboy -S --noconfirm python:u python-pillow:u toolchain:u zlib:u sox:u imagemagick:u
+          pip install python-yaml
+
+      - name: Test by compiling ngdevkit-examples
+        run: ./.github/scripts/test.sh
+
+
   macos:
     name: "macOS build"
     runs-on: macos-15
@@ -100,8 +110,8 @@ jobs:
         run: |
           brew tap dciabrin/ngdevkit
           brew install python3 --overwrite
+          brew install pillow
           brew install automake ngdevkit-toolchain zip pkg-config sdl2 sdl2_image
-          $(brew --prefix python)/libexec/bin/pip install pygame --break-system-packages
 
       - name: Build
         run: ./.github/scripts/build.sh

README-linux.md

@@ -5,22 +5,26 @@
 In order to build the devkit you need autoconf, autoconf-archive and
 GNU Make 4.x, and various additional dependencies to build the
 toolchain modules such as GCC and SDCC. The devkit tools uses Python 3
-and PyGame 2. The emulator requires SDL 2 and optionally OpenGL
-libraries.
+and various dependencies (such as pillow and PyYAML).
+The emulator requires SDL 2 and optionally OpenGL libraries.
+
+Note that older version of the devkit and its example ROMs depended
+on PyGame, which has now been replaced by pillow. So please make
+sure to use the latest version of ngdevkit-examples for building ROMs.
 
 The examples require ImageMagick for all the graphics
 trickery and sox for audio conversion purpose.
 
-For example, on Ubuntu Focal (20.04), you can install the dependencies with:
+For example, on a recent Ubuntu version, you can install the dependencies with:
 
     apt-get install autoconf autoconf-archive automake gcc curl zip unzip
     apt-get install libsdl2-dev
-    apt-get install python3-pygame
+    apt-get install python3-pil
     apt-get install libreadline-dev
     GCC_VERSION_PKG=$(apt-cache depends gcc | awk '/Depends.*gcc/ {print $2}')
     # make sure you have src packages enabled for dependency information
-    echo "deb-src http://archive.ubuntu.com/ubuntu/ focal main restricted" > /etc/apt/sources.list.d/ngdevkit.list
-    echo "deb-src http://archive.ubuntu.com/ubuntu/ focal universe" >> /etc/apt/sources.list.d/ngdevkit.list
+    echo "deb-src http://archive.ubuntu.com/ubuntu/ noble main restricted" > /etc/apt/sources.list.d/ngdevkit.list
+    echo "deb-src http://archive.ubuntu.com/ubuntu/ noble universe" >> /etc/apt/sources.list.d/ngdevkit.list
     apt-get update
     # install build-dependency packages
     apt-get build-dep $GCC_VERSION_PKG
@@ -33,7 +37,7 @@ For example, on Ubuntu Focal (20.04), you can install the dependencies with:
 Debian users (for example Buster) would install the dependencies above
 by updating the src packages URL as follows:
 
-    echo "deb-src http://deb.debian.org/debian buster main" > /etc/apt/sources.list.d/ngdevkit.list
+    echo "deb-src http://deb.debian.org/debian trixie main" > /etc/apt/sources.list.d/ngdevkit.list
     # the remaining dependencies are the same
 
 ## Building the toolchain

README-macos.md

@@ -17,24 +17,24 @@ later in this documentation.
 The devkit uses Python 3, which is installed globally in macOS but
 also in brew. To make sure you are installing python dependencies
 in the right python distribution, you need to have brew's python
-first in your PATH, as explained later in the document.
+first in your PATH.
 
 
 ## Pre-requisite
 
 In order to build the devkit you need autoconf, autoconf-archive and
 GNU Make 4.x, and various additional dependencies to build the
 toolchain modules such as GCC and SDCC. The devkit tools uses Python 3
-and PyGame 2. The emulator requires SDL 2 and optionally OpenGL
-libraries.
+and various dependencies (such as pillow and PyYAML). The emulator
+requires SDL 2 and optionally OpenGL libraries.
 
 The examples require ImageMagick for all the graphics
 trickery and sox for audio conversion purpose.
 
 Make sure that `brew` is in your PATH and its environment variables are
 set up properly. By default, brew is installed in `/usr/local/bin/brew`
 on Intel macs, and in `/opt/homebrew/bin/brew` on ARM macs. If `brew`
-is not found in your PATH, you must initialize your it with:
+is not found in your PATH, you must initialize it with:
 
     eval $(/opt/homebrew/bin/brew shellenv)
     # Intel macs would use /usr/local/bin/brew shellenv
@@ -43,25 +43,25 @@ Then, ngdevkit's dependencies are installed as follows:
 
     brew update
     brew install gmake
-    brew install autoconf-archive
-    brew install glew sdl2 sdl2_image
-    brew install python3
-    # make sure you use brew's python3 to install pygame
-    # if not, update your path like e.g.
-    # export PATH=$HOMEBREW_PREFIX/opt/python3/bin:$PATH
-    pip3 install pygame --break-system-packages
+    brew install python3 pillow
     brew deps gcc | xargs brew install
     brew deps sdcc | xargs brew install
     # dependencies for the example ROMs
+    brew install autoconf-archive
+    brew install glew sdl2 sdl2_image
     brew install zip imagemagick sox
 
+Note that older version of the devkit and its example ROMs depended
+on PyGame, which has now been replaced by pillow. So please make
+sure to use the latest version of ngdevkit-examples for building ROMs.
 
 ## Building the toolchain
 
 In order to build ngdevkit, the installed brew dependencies must
 be available to the compiler, so you must add brew's PATH into
 your build flags manually:
 
+    HOMEBREW_PREFIX=$(brew --prefix)
     export CFLAGS="-I${HOMEBREW_PREFIX}/include${CFLAGS+ ${CFLAGS}}"
     export CXXFLAGS="-I${HOMEBREW_PREFIX}/include${CXXFLAGS+ ${CXXFLAGS}}"
     export CPPFLAGS="-I${HOMEBREW_PREFIX}/include${CPPFLAGS+ ${CPPFLAGS}}"

README-msys2.md

@@ -63,21 +63,24 @@ ngdevkit dependencies:
     pacboy -S autoconf autoconf-archive automake pkgconf make tar zip unzip
     pacboy -S git flex bison expat gettext ncurses-devel zlib-devel
     pacboy -S gmp-devel isl-devel mpc-devel mpfr-devel texinfo
-    pacboy -S python:u python-pygame:u toolchain:u zlib:u SDL2:u glew:u boost:u
+    pacboy -S python:u python-yaml python-pillow:u toolchain:u zlib:u
     # dependencies for the example ROMs
-    pacboy -S rsync sox:u imagemagick:u
+    pacboy -S rsync sox:u imagemagick:u SDL2:u glew:u boost:u
+
+Note that older version of the devkit and its example ROMs depended
+on PyGame, which has now been replaced by pillow. So please make
+sure to use the latest version of ngdevkit-examples for building ROMs.
 
 You can now compile the entire devkit. The latest ngdevkit's autoconf
 script should detect the location of all dependencies (python,
-pygame...) automatically, as long as you're running it in a UCRT64
+pillow, ...) automatically, as long as you're running it in a UCRT64
 environment as required.
 
     autoreconf -iv
     ./configure --prefix=$PWD/local
     make
     make install
 
-
 The most tedious part is over! You can now configure your environment
 to add the built binaries to your `PATH` and start experimenting
 with the devkit and build the example ROMs:
@@ -95,5 +98,4 @@ how to run the examples and the debugger.
 [msys2]: https://www.msys2.org
 [examples]: https://github.com/dciabrin/ngdevkit-examples
 [pywin]: https://www.python.org/downloads/windows
-[pygame]: https://www.pygame.org
 [subsys]: https://www.msys2.org/docs/environments

README.md

@@ -56,7 +56,7 @@ of dependencies for the examples ROMs:
     add-apt-repository -y ppa:dciabrin/ngdevkit
     apt update
     apt install ngdevkit ngdevkit-gngeo
-    # the remaining packages are only requred for the examples
+    # the remaining packages are only required for the examples
     apt install pkg-config autoconf zip imagemagick sox libsox-fmt-mp3
 
 If you are running a Fedora distribution, pre-built packages are
@@ -79,9 +79,6 @@ packages, available in the ngdevkit tap:
     # install ngdevkit
     brew tap dciabrin/ngdevkit
     brew install ngdevkit ngdevkit-gngeo
-    # make sure you use brew's python3 in your shell
-    export PATH=$HOMEBREW_PREFIX/opt/python3/bin:$PATH
-    pip3 install pygame pyyaml --break-system-packages
     # the remaining packages are only required for the examples
     brew install pkg-config autoconf automake zip imagemagick sox
 
@@ -99,7 +96,6 @@ configure the pacman repository as follows:
 
     MSYSTEM=UCRT64 /usr/bin/bash -l
     echo -e "\n[ngdevkit]\nSigLevel = Optional TrustAll\nServer = https://dciabrin.net/msys2-ngdevkit/\$arch" >> /etc/pacman.conf
-    
     # install pacboy with `pacman -S pactoys` if necessary
     pacboy -Sy
     pacboy -S ngdevkit:u ngdevkit-gngeo:u

tools/paltool.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-# Copyright (c) 2018-2019 Damien Ciabrini
+# Copyright (c) 2018-2026 Damien Ciabrini
 # This file is part of ngdevkit
 #
 # ngdevkit is free software: you can redistribute it and/or modify
@@ -20,18 +20,10 @@
 Extract palette from a 2D image and convert it to C or ASM data.
 """
 
-from __future__ import print_function
-import struct
-import os
-import sys
 import argparse
-from random import randint
-
-os.environ['PYGAME_HIDE_SUPPORT_PROMPT'] = '1'
-os.environ['SDL_VIDEODRIVER'] = 'dummy'
-os.environ['SDL_AUDIODRIVER'] = 'dummy'
-import pygame
 
+from PIL import Image
+from itertools import batched
 
 def rgb24_to_packed15(col):
     r, g, b = [c >> 2 for c in col]
@@ -62,15 +54,18 @@ def main():
 
     arguments = parser.parse_args()
 
-    img = pygame.image.load(arguments.FILE)
+    img = Image.open(arguments.FILE)
 
-    # only keep the first 16 colors, even if palette has other
-    # colors initialized but unused.
-    pal = img.get_palette()[:16]
+    # extract the palette as a 24bits RGB
+    pal_ints = img.getpalette()
+    pal_rgb = list(batched(pal_ints, 3))
+    # make sure the palette has 16colors
+    if len(pal_rgb) > 16:
+        pal_rgb = pal_rgb[:16]
+    elif len(pal_rgb) < 16:
+        pal_rgb.extend([(0, 0, 0)] * (16 - len(pal_rgb)))
 
-    # for the time being, do not the 16th bit available in
-    # the Neo Geo hardware
-    ngpal = [rgb24_to_packed15(c) for c in pal]
+    ngpal = [rgb24_to_packed15(c) for c in pal_rgb]
 
     out = open(arguments.output, "w")
     output_c_anonymous_palette(ngpal, out)