Add headless and gymnasium client

- Adds remote input / output over ZeroMQ. - Adds a gymnasium client in python/minetester subdirectory, which uses the remote input / output. - Adds headless rendering support. Build with -DBUILD_HEADLESS=TRUE and run with --headless. Only supported on Linux. - Somewhat unrelated, but switches the CI to use conda packages for most dependencies. Co-Authored-By: Gary Mindlin Miguel <[email protected]>
Astera-org · Feb 15, 2024 · d777599 · d777599
1 parent fd5597a
commit d777599
Show file tree

Hide file tree

Showing 71 changed files with 2,184 additions and 306 deletions.
diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile
@@ -0,0 +1,4 @@
+FROM ubuntu:22.04
+
+RUN apt-get update -y && \
+    apt-get install -y g++ git libgl1-mesa-dev mold
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -0,0 +1,25 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+{
+	"build": {
+		"dockerfile": "Dockerfile"
+	},
+	"runArgs": [
+		// Allows debuggers to disable ASLR
+		// "--privileged"
+	],
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"charliermarsh.ruff",
+				"llvm-vs-code-extensions.vscode-clangd",
+				"ms-python.python",
+				"ms-vscode.cmake-tools",
+				"vadimcn.vscode-lldb"
+			]
+		}
+	},
+	"features": {
+		"ghcr.io/rocker-org/devcontainer-features/miniforge:1": {}
+	},
+	"postCreateCommand": "bash -c 'mamba init && mamba env create'"
+}
diff --git a/.github/workflows/android.yml b/.github/workflows/android.yml
diff --git a/.github/workflows/cpp_lint.yml b/.github/workflows/cpp_lint.yml
@@ -36,6 +36,15 @@ jobs:
         source ./util/ci/common.sh
         install_linux_deps $CLANG_TIDY
 
+    - uses: conda-incubator/setup-miniconda@v3
+      with:
+        python-version: '3.11'
+        mamba-version: "*"
+        channels: conda-forge,nodefaults
+        activate-environment: minetest
+        environment-file: environment.yml
+
     - name: Run clang-tidy
+      shell: bash -l {0}
       run: |
         ./util/ci/clang-tidy.sh
diff --git a/.github/workflows/linux.yml b/.github/workflows/linux.yml
@@ -43,7 +43,17 @@ jobs:
           source ./util/ci/common.sh
           install_linux_deps g++-7
 
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          python-version: '3.11'
+          mamba-version: "*"
+          channels: conda-forge,nodefaults
+          activate-environment: minetest
+          environment-file: environment.yml
+
       - name: Build
+        # Needed so conda environment is active
+        shell: bash -l {0}
         run: |
           ./util/ci/build.sh
         env:
@@ -64,7 +74,17 @@ jobs:
           source ./util/ci/common.sh
           install_linux_deps g++-12 libluajit-5.1-dev
 
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          python-version: '3.11'
+          mamba-version: "*"
+          channels: conda-forge,nodefaults
+          activate-environment: minetest
+          environment-file: environment.yml
+
       - name: Build
+        # Needed so conda environment is active
+        shell: bash -l {0}
         run: |
           ./util/ci/build.sh
         env:
@@ -85,12 +105,23 @@ jobs:
           source ./util/ci/common.sh
           install_linux_deps clang-7 valgrind
 
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          python-version: '3.11'
+          mamba-version: "*"
+          channels: conda-forge,nodefaults
+          activate-environment: minetest
+          environment-file: environment.yml
+
       - name: Build
+        # Needed so conda environment is active
+        shell: bash -l {0}
         run: |
           ./util/ci/build.sh
         env:
           CC: clang-7
           CXX: clang++-7
+          CMAKE_FLAGS: "-DENABLE_CURSES=FALSE"
 
       - name: Unittest
         run: |
@@ -110,7 +141,17 @@ jobs:
           source ./util/ci/common.sh
           install_linux_deps clang-14 gdb
 
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          python-version: '3.11'
+          mamba-version: "*"
+          channels: conda-forge,nodefaults
+          activate-environment: minetest
+          environment-file: environment.yml
+
       - name: Build
+        # Needed so conda environment is active
+        shell: bash -l {0}
         run: |
           ./util/ci/build.sh
         env:
@@ -125,6 +166,46 @@ jobs:
         run: |
           ./util/test_multiplayer.sh
 
+  pytest:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install deps
+        run: |
+          source ./util/ci/common.sh
+          install_linux_deps clang-14
+
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          python-version: '3.11'
+          mamba-version: "*"
+          channels: conda-forge,nodefaults
+          activate-environment: minetest
+          environment-file: environment.yml
+
+      - name: Build
+        # Needed so conda environment is active
+        shell: bash -l {0}
+        run: |
+          ./util/ci/build.sh
+        env:
+          CC: clang-14
+          CXX: clang++-14
+
+      - name: Run pytest
+        # Needed so conda environment is active
+        shell: bash -l {0}
+        run: |
+          cd python
+          set +o errexit
+          timeout --signal=KILL 5m pytest -v
+          exit_code=$?
+          if [ $exit_code -ne 0 ]; then
+            echo "test failed, printing minetest logs"
+            find artifacts/log -type f -name '*.log' -exec cat {} \;
+          fi
+          exit $exit_code
+
   # Build with prometheus-cpp (server-only)
   clang_9_prometheus:
     name: "clang_9 (PROMETHEUS=1)"
@@ -136,28 +217,29 @@ jobs:
           source ./util/ci/common.sh
           install_linux_deps clang-9
 
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          python-version: '3.11'
+          mamba-version: "*"
+          channels: conda-forge,nodefaults
+          activate-environment: minetest
+          environment-file: environment.yml
+
       - name: Build prometheus-cpp
+        shell: bash -l {0}
         run: |
           ./util/ci/build_prometheus_cpp.sh
 
       - name: Build
+        # Needed so conda environment is active
+        shell: bash -l {0}
         run: |
           ./util/ci/build.sh
         env:
           CC: clang-9
           CXX: clang++-9
-          CMAKE_FLAGS: "-DENABLE_PROMETHEUS=1 -DBUILD_CLIENT=0"
+          CMAKE_FLAGS: "-DENABLE_PROMETHEUS=1 -DBUILD_CLIENT=0 -DENABLE_CURSES=FALSE"
 
       - name: Test
         run: |
           ./bin/minetestserver --run-unittests
-
-  docker:
-    name: "Docker image"
-    runs-on: ubuntu-20.04
-    steps:
-      - uses: actions/checkout@v3
-      - name: Build docker image
-        run: |
-          docker build . -t minetest:latest
-          docker run --rm minetest:latest /usr/local/bin/minetestserver --version
diff --git a/.github/workflows/lua.yml b/.github/workflows/lua.yml
@@ -23,9 +23,18 @@ jobs:
     - name: Install deps
       run: |
         source ./util/ci/common.sh
-        install_linux_deps clang-10 gdb libluajit-5.1-dev
+        install_linux_deps clang-10 gdb
+
+    - uses: conda-incubator/setup-miniconda@v3
+      with:
+        python-version: '3.11'
+        mamba-version: "*"
+        channels: conda-forge,nodefaults
+        activate-environment: minetest
+        environment-file: environment.yml
 
     - name: Build
+      shell: bash -l {0}
       run: |
         ./util/ci/build.sh
       env:

diff --git a/.github/workflows/macos.yml b/.github/workflows/macos.yml
@@ -26,37 +26,37 @@ jobs:
     runs-on: macos-latest
     steps:
       - uses: actions/checkout@v3
+
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          python-version: '3.11'
+          mamba-version: "*"
+          channels: conda-forge,nodefaults
+          activate-environment: minetest
+          environment-file: environment.yml
+
       - name: Install deps
         run: |
           source ./util/ci/common.sh
           install_macos_deps
 
       - name: Build
+        shell: bash -l {0}
         run: |
-          git clone https://github.com/minetest/irrlicht lib/irrlichtmt --depth 1 -b $(cat misc/irrlichtmt_tag.txt)
-          mkdir build
-          cd build
-          cmake .. \
-            -DCMAKE_OSX_DEPLOYMENT_TARGET=10.14 \
+          cmake -B build -S . \
             -DCMAKE_FIND_FRAMEWORK=LAST \
-            -DCMAKE_INSTALL_PREFIX=../build/macos/ \
-            -DRUN_IN_PLACE=FALSE -DENABLE_GETTEXT=TRUE \
-            -DINSTALL_DEVTEST=TRUE
-          cmake --build . -j$(sysctl -n hw.logicalcpu)
-          make install
+            -DCMAKE_INSTALL_PREFIX=build/macos/ \
+            -DRUN_IN_PLACE=FALSE \
+            -DENABLE_GETTEXT=TRUE \
+            -DCMAKE_BUILD_TYPE=Debug \
+            -DBUILD_HEADLESS=FALSE \
+            -GNinja \
+            -DINSTALL_DEVTEST=TRUE \
+            -DICONV_LIBRARY="${CONDA_PREFIX}/lib/libiconv.dylib" \
+            -DCMAKE_INSTALL_RPATH="${CONDA_PREFIX}/lib"
+          cmake --build build
+          cmake --install build
 
       - name: Test
         run: |
           ./build/macos/minetest.app/Contents/MacOS/minetest --run-unittests
-
-      # Zipping the built .app preserves permissions on the contained files,
-      #   which the GitHub artifact pipeline would otherwise strip away.
-      - name: CPack
-        run: |
-          cd build
-          cpack -G ZIP -B macos
-
-      - uses: actions/upload-artifact@v3
-        with:
-          name: minetest-macos
-          path: ./build/macos/*.zip