Support OpenBW client connection on macOS (including Apple Silicon)

Author: Jasper Geurtz

build_with_openbw.md

@@ -26,11 +26,30 @@ unzip starcraft.zip "maps/BroodWar/ICCup/ICCup Destination 1.1.scx"
 BWAPI_CONFIG_AUTO_MENU__RACE=Terran BWAPI_CONFIG_AUTO_MENU__MAP="maps/BroodWar/ICCup/ICCup Destination 1.1.scx" ./bin/BWAPILauncher
 ```
 
-Compiling and running openbw on macos with client support (not working):
+Compiling and running openbw on macos with client support:
 
 ```bash
-brew install cmake sdl2 sdl2_mixer gcc
+# Download build deps
+brew install cmake sdl2 sdl2_mixer
+
+# Build openbw with client support
+git clone https://github.com/basil-ladder/openbw
+git clone -b linux-client-support https://github.com/basil-ladder/bwapi
+cd bwapi
+mkdir build
+cd build
+cmake .. -DCMAKE_BUILD_TYPE=Release -DOPENBW_DIR=../../openbw -DOPENBW_ENABLE_UI=1 -DCMAKE_POLICY_VERSION_MINIMUM=3.5
+make -j4
+
+# Download runtime deps
+curl -L "https://web.archive.org/web/20250823150201id_/https://www.cs.mun.ca/~dchurchill/starcraftaicomp/files/Starcraft_1161.zip" -o starcraft.zip
+unzip starcraft.zip patch_rt.mpq BROODAT.MPQ STARDAT.MPQ
+mv patch_rt.mpq Patch_rt.mpq.tmp && mv Patch_rt.mpq.tmp Patch_rt.mpq
+mv BROODAT.MPQ BrooDat.mpq.tmp && mv BrooDat.mpq.tmp BrooDat.mpq
+mv STARDAT.MPQ StarDat.mpq.tmp && mv StarDat.mpq.tmp StarDat.mpq
+
+# Run openbw using the map: Destination 1.1.scx
+unzip starcraft.zip "maps/BroodWar/ICCup/ICCup Destination 1.1.scx"
 
-cmake .. -D CMAKE_C_COMPILER=gcc-11 -D CMAKE_CXX_COMPILER=g++-11 -DCMAKE_BUILD_TYPE=Release -DOPENBW_DIR=../../openbw -DOPENBW_ENABLE_UI=1
-make -j4 
+BWAPI_CONFIG_AUTO_MENU__RACE=Terran BWAPI_CONFIG_AUTO_MENU__MAP="maps/BroodWar/ICCup/ICCup Destination 1.1.scx" OPENBW_ENABLE_UI=1 ./bin/BWAPILauncher
 ```

pom.xml

@@ -144,14 +144,14 @@
     </profiles>
     <dependencies>
         <dependency>
-            <groupId>no.fiken.oss.junixsocket</groupId>
+            <groupId>com.kohlschutter.junixsocket</groupId>
             <artifactId>junixsocket-common</artifactId>
-            <version>1.0.2</version>
+            <version>2.10.1</version>
         </dependency>
         <dependency>
-            <groupId>no.fiken.oss.junixsocket</groupId>
+            <groupId>com.kohlschutter.junixsocket</groupId>
             <artifactId>junixsocket-native-common</artifactId>
-            <version>1.0.2</version>
+            <version>2.10.1</version>
         </dependency>
 
         <dependency>

src/main/java/bwapi/ClientConnectionPosix.java

@@ -24,7 +24,7 @@ class ClientConnectionPosix implements ClientConnection {
     interface LibCExt extends LibC {
         LibCExt INSTANCE = Native.load(LibCExt.class);
 
-        Pointer mmap(Pointer addr, int length, int prot, int flags, int fd, int offset) throws LastErrorException;
+        Pointer mmap(Pointer addr, long length, int prot, int flags, int fd, long offset) throws LastErrorException;
     }
 
     interface PosixShm extends Library {
@@ -57,17 +57,26 @@ public void disconnect() {
     public WrappedBuffer getGameTable() {
         int fd = PosixShm.INSTANCE.shm_open("/bwapi_shared_memory_game_list", Fcntl.O_RDWR, 0);
         if (fd < 0) throw new IllegalStateException("SHM not found");
-        Pointer gameTableView = LibCExt.INSTANCE.mmap(Pointer.NULL, GameTable.SIZE, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
-        return new WrappedBuffer(gameTableView, GameTable.SIZE);
+        try {
+            Pointer gameTableView = LibCExt.INSTANCE.mmap(Pointer.NULL, GameTable.SIZE, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
+            return new WrappedBuffer(gameTableView, GameTable.SIZE);
+        } finally {
+            LibCExt.INSTANCE.close(fd);
+        }
     }
 
     @Override
     public WrappedBuffer getSharedMemory(int serverProcID) {
         String sharedMemoryName = "/bwapi_shared_memory_" + serverProcID;
         try {
-            Pointer mapFileView = LibCExt.INSTANCE.mmap(Pointer.NULL, ClientData.GameData.SIZE, PROT_READ | PROT_WRITE, MAP_SHARED, LibRT.INSTANCE.shm_open(sharedMemoryName, Fcntl.O_RDWR, 0),
-                    0);
-            return new WrappedBuffer(mapFileView, ClientData.GameData.SIZE);
+            int fd = PosixShm.INSTANCE.shm_open(sharedMemoryName, Fcntl.O_RDWR, 0);
+            if (fd < 0) throw new IllegalStateException("SHM not found");
+            try {
+                Pointer mapFileView = LibCExt.INSTANCE.mmap(Pointer.NULL, ClientData.GameData.SIZE, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
+                return new WrappedBuffer(mapFileView, ClientData.GameData.SIZE);
+            } finally {
+                LibCExt.INSTANCE.close(fd);
+            }
         } catch (Exception e) {
             throw new SharedMemoryConnectionException(sharedMemoryName, e);
         }