-- Leo's gemini proxy

-- Connecting to tilde.pink:1965...

-- Connected

-- Sending request

-- Meta line: 20 text/gemini;

Porting X11 apps to OpenBSD

2024-03-15

I was getting interested in BSD systems, more specifically OpenBSD, its firewall (pf) and more generally its security. Then I wanted to use some programs with a graphical interface such as xclicker. But it doesn't exist on the distribution, so I wanted to integrate it.


*By the way, there's a site that explains why OpenBSD is great (

why-openbsd.rocks

).*


I thought it could be interesting to port/package some games I've played during my childhood such as

Super Mario War

or

VVVVVV

.


Before making the game compatible with the distribution, it's best to fetch the port tree (

doc

) and read the official documentation (

doc

) to get the essentials.


OpenBSD environment


My test environment is just a virtual machine managed by VirtualBox on which

OpenBSD 7.4

has been installed, following the steps

here

.


To manage X displays, I used xenodm which is installed by default on OpenBSD. You can activate its system service with the following command.


rcctl enable xenodm

And for the windows manager, there's a basic one (cwm) but I opted for i3wm anyway.


Porting VVVVVV


Few years ago, VVVVVV has released an open source version (engine + levels). The game binary requires a **data.zip** file which must be in the same folder, luckily there are options to specify in which folders to look for the fonts and languages.


So that the user doesn't have to fill in all this information himself, I've created a shell script with the appropriate values.


#!/bin/sh

NAME=VVVVVV
GAMES_DIR=${TRUEPREFIX}/games/${NAME}
SHARE_DIR=${TRUEPREFIX}/share/${NAME}

cd ${GAMES_DIR}

exec ./${NAME} \
     -fontsdir ${SHARE_DIR}/fonts \
     -langdir ${SHARE_DIR}/lang \
     ${@}

Note that ${TRUEPREFIX} is not defined in the script, this is normal, it will be replaced by ${SUBST_CMD} defined in **/usr/ports/infrastructure/mk/bsd.port.mk**.


This is what the game's makefile looks like.


COMMENT=	puzzle-platform game

V=		2.4.1
NAME=		VVVVVV
PKGNAME= 	${NAME}-${V}

CATEGORIES=	games

HOMEPAGE=	http://thelettervsixtim.es

MAINTAINER=	Theo Bori <nagi@tilde.team>

EXTRACT_SUFX=	.zip

WRKSRC=		${WRKDIST}/${NAME}/desktop_version

SITES= 		https://github.com/terrycavanagh/${NAME}/releases/download/${V}/
SITES.a=	${HOMEPAGE}/makeandplay/

DISTFILES=	${PKGNAME}${EXTRACT_SUFX}
DISTFILES.a=	vvvvvv-mp-linux-02132024${EXTRACT_SUFX}

# Bsd-like
PERMIT_PACKAGE=	Yes

WANTLIB+=	c SDL2 physfs tinyxml2 FAudio

LIB_DEPENDS=	devel/sdl2 \
    	devel/physfs \
    	audio/faudio \
    	textproc/tinyxml2

CXXFLAGS+= 	-I${PREFIX}/include

MODULES=	devel/cmake

CONFIGURE_ARGS=		-DBUNDLE_DEPENDENCIES="OFF"

do-extract:
    unzip ${FULLDISTDIR}/${PKGNAME}${EXTRACT_SUFX} -d ${WRKDIR}/
    unzip ${FULLDISTDIR}/vvvvvv-mp-linux-02132024${EXTRACT_SUFX} -d ${WRKDIR}/${PKGNAME}-data

do-install:
    ${INSTALL_DATA_DIR} ${PREFIX}/games/${NAME}
    ${INSTALL_PROGRAM} ${WRKBUILD}/${NAME} ${PREFIX}/games/${NAME}/${NAME}

    ${SUBST_CMD} -c -m 755 ${FILESDIR}/${NAME} ${PREFIX}/bin/${NAME}

post-install:
    ${INSTALL_DATA} ${WRKDIR}/${PKGNAME}-data/data.zip ${PREFIX}/games/${NAME}

    ${INSTALL_DATA_DIR} ${PREFIX}/share/${NAME}

.for d in lang licenses fonts
    cp -r ${WRKDIR}/${PKGNAME}-data/${d} ${PREFIX}/share/${NAME}
.endfor

.include <bsd.port.mk>

As you can see, I had to override some of the BSD port makefile targets, because, actually this ports is a little bit special. It must download multiple distfiles from different sites (see below).


SITES= 		https://github.com/terrycavanagh/${NAME}/releases/download/${V}/
SITES.a=	${HOMEPAGE}/makeandplay/

DISTFILES=	${PKGNAME}${EXTRACT_SUFX}
DISTFILES.a=	vvvvvv-mp-linux-02132024${EXTRACT_SUFX}

Moreover, there were conflicts with the extracted files names, so I had to rename the directory containing **data.zip**.


do-extract:
    unzip ${FULLDISTDIR}/${PKGNAME}${EXTRACT_SUFX} -d ${WRKDIR}/
    unzip ${FULLDISTDIR}/vvvvvv-mp-linux-02132024${EXTRACT_SUFX} -d ${WRKDIR}/${PKGNAME}-data

Also, we didn't want to build the dependencies using the github modules, because obviously, the released zip file doesn't have a **.git** folder inside.


I've also patched a few source files, the full port is available

here

.


Links


My OpenBSD ports

-- Response ended

-- Page fetched on Sun May 19 13:15:27 2024