Merge pull request #15 from limbonaut/gdextension

Implement GDExtension support
limbonaut · Jan 13, 2024 · cc16879 · cc16879
2 parents c18fc2a + 46cd946
commit cc16879
Show file tree

Hide file tree

Showing 169 changed files with 3,724 additions and 1,075 deletions.
diff --git a/.github/actions/init-version-gdext/action.yml b/.github/actions/init-version-gdext/action.yml
@@ -0,0 +1,24 @@
+name: Setup version
+
+runs:
+  using: "composite"
+  steps:
+    - name: Set GDEXTENSION_VERSION & LIMBOAI_VERSION
+      shell: bash
+      run: |
+        cd godot-cpp
+        GDEXTENSION_VERSION=$( (git describe --tags --exact-match HEAD || git rev-parse --short HEAD) | sed 's/\(.*\)-\(.*\)/\1/g' )
+
+        if [[ ${GDEXTENSION_VERSION} == godot-* ]]; then
+           GDEXTENSION_VERSION=${GDEXTENSION_VERSION#"godot-"}
+        fi
+
+        echo "GDEXTENSION_VERSION=${GDEXTENSION_VERSION}" >> "$GITHUB_ENV"
+
+        cd ../limboai
+        echo "LIMBOAI_VERSION=$( (git describe --tags --exact-match HEAD || git rev-parse --short HEAD) | sed 's/\(.*\)-\(.*\)/\1/g' )" >> "$GITHUB_ENV"
+
+    - name: Set NAME_PREFIX
+      shell: bash
+      run: echo "NAME_PREFIX=gdextension-${GDEXTENSION_VERSION}.limboai+${LIMBOAI_VERSION}" >> "$GITHUB_ENV"
+
diff --git a/.github/workflows/gdextension.yml b/.github/workflows/gdextension.yml
@@ -0,0 +1,209 @@
+name: 🔌 GDExtension
+on:
+  workflow_call:
+    inputs:
+      godot-cpp-treeish:
+        description: A tag, branch or commit hash in the godot-cpp repository.
+        type: string
+        default: 4.2
+      limboai-treeish:
+        description: A tag, branch or commit hash in the LimboAI repository.
+        type: string
+        default: master
+      test-build:
+        description: Should we perform only a limited number of test builds?
+        type: boolean
+        default: false
+
+  workflow_dispatch:
+    inputs:
+      godot-cpp-treeish:
+        description: A tag, branch or commit hash in the godot-cpp repository.
+        type: string
+        default: 4.2
+      limboai-treeish:
+        description: A tag, branch or commit hash in the LimboAI repository.
+        type: string
+        default: master
+      test-build:
+        description: Should we perform only a limited number of test builds?
+        type: boolean
+        default: false
+
+# Global Settings
+env:
+  SCONS_CACHE_LIMIT: 4096
+  SCONSFLAGS: dev_build=no debug_symbols=no
+
+jobs:
+  gdextension:
+    runs-on: ${{ matrix.opts.runner }}
+    name: ${{ matrix.opts.name }}
+    strategy:
+      fail-fast: false
+      matrix:
+        opts:
+          - name: 🐧 Linux (x86_64, release)
+            runner: ubuntu-20.04
+            platform: linux
+            target: template_release
+            arch: x86_64
+            should-build: true
+
+          - name: 🐧 Linux (x86_64, debug)
+            runner: ubuntu-20.04
+            platform: linux
+            target: editor
+            arch: x86_64
+            should-build: true
+
+          - name: 🪟 Windows (x86_64, release)
+            runner: windows-latest
+            platform: windows
+            target: template_release
+            arch: x86_64
+            should-build: true
+
+          - name: 🪟 Windows (x86_64, debug)
+            runner: windows-latest
+            platform: windows
+            target: editor
+            arch: x86_64
+            should-build: true
+
+          - name: 🍎 macOS (universal, release)
+            runner: macos-latest
+            platform: macos
+            target: template_release
+            arch: universal
+            should-build: true
+
+          - name: 🍎 macOS (universal, debug)
+            runner: macos-latest
+            platform: macos
+            target: editor
+            arch: universal
+            should-build: true
+
+        exclude:
+          - { opts: {should-build: false }}
+
+    env:
+      BIN: liblimboai.${{matrix.opts.platform}}.${{matrix.opts.target}}.${{matrix.opts.arch}}
+
+    steps:
+      - name: Clone godot-cpp
+        uses: actions/checkout@v4
+        with:
+          repository: godotengine/godot-cpp
+          fetch-tags: true
+          path: godot-cpp
+          ref: ${{ inputs.godot-cpp-treeish }}
+
+      - name: Clone LimboAI module
+        uses: actions/checkout@v4
+        with:
+          path: limboai
+          fetch-tags: true
+          ref: ${{ inputs.limboai-treeish }}
+
+      # Inits GDEXTENSION_VERSION, LIMBOAI_VERSION and NAME_PREFIX environment variables.
+      - uses: ./limboai/.github/actions/init-version-gdext
+
+      - name: Set up Linux buildroot x86_64
+        if: matrix.opts.platform == 'linux' && matrix.opts.arch == 'x86_64'
+        run: |
+          wget https://download.tuxfamily.org/godotengine/toolchains/linux/x86_64-godot-linux-gnu_sdk-buildroot.tar.bz2
+          tar -xjf x86_64-godot-linux-gnu_sdk-buildroot.tar.bz2
+          mv x86_64-godot-linux-gnu_sdk-buildroot buildroot
+          cd buildroot
+          ./relocate-sdk.sh
+          cd ..
+
+      - name: Set up Linux buildroot x86_32
+        if: matrix.opts.platform == 'linux' && matrix.opts.arch == 'x86_32'
+        run: |
+          wget https://download.tuxfamily.org/godotengine/toolchains/linux/i686-godot-linux-gnu_sdk-buildroot.tar.bz2
+          tar -xjf i686-godot-linux-gnu_sdk-buildroot.tar.bz2
+          mv i686-godot-linux-gnu_sdk-buildroot buildroot
+          cd buildroot
+          ./relocate-sdk.sh
+          cd ..
+
+      - name: Set up Python 3.x
+        if: matrix.opts.platform == 'windows' || matrix.opts.platform == 'macos'
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+          architecture: 'x64'
+
+      - name: Set up scons
+        if: matrix.opts.platform == 'windows' || matrix.opts.platform == 'macos'
+        run: |
+          python -c "import sys; print(sys.version)"
+          python -m pip install scons==4.4.0
+          python --version
+          scons --version
+
+      - name: Set up MSVC problem matcher on Windows
+        if: matrix.opts.platform == 'windows'
+        uses: ammaraskar/msvc-problem-matcher@master
+
+      - name: Set up scons cache
+        uses: actions/cache@v3
+        with:
+          path: ${{github.workspace}}/.scons_cache/
+          key: ${{env.BIN}}-${{inputs.godot-cpp-treeish}}-${{inputs.limboai-treeish}}-${{env.LIMBOAI_VERSION}}
+          restore-keys: |
+            ${{env.BIN}}-${{inputs.godot-cpp-treeish}}-${{inputs.limboai-treeish}}-${{env.LIMBOAI_VERSION}}
+            ${{env.BIN}}-${{inputs.godot-cpp-treeish}}-${{inputs.limboai-treeish}}
+            ${{env.BIN}}-${{inputs.godot-cpp-treeish}}
+
+      - name: Setup project structure for GDExtension
+        shell: bash
+        run: |
+          python ./limboai/gdextension/update_icons.py
+          mkdir -p demo/addons/limboai/bin
+          mv limboai/icons demo/addons/limboai/
+          cp limboai/gdextension/SConstruct SConstruct
+          cp limboai/gdextension/limboai.gdextension demo/addons/limboai/bin
+          echo "---"
+          ls -l
+          ls -l -R ./demo/
+
+      - name: Compilation
+        shell: bash
+        env:
+          SCONS_CACHE: ${{github.workspace}}/.scons_cache/
+        run: |
+          PATH=${GITHUB_WORKSPACE}/buildroot/bin:$PATH
+          scons platform=${{matrix.opts.platform}} target=${{matrix.opts.target}} arch=${{matrix.opts.arch}} ${{env.SCONSFLAGS}}
+
+      - name: Prepare artifact
+        shell: bash
+        run: |
+          mkdir out
+          mv demo/addons/ out/
+          rm -f out/addons/limboai/bin/*.{exp,lib,pdb}
+          ls -R out/
+
+      - name: Strip lib
+        if: matrix.opts.platform != 'windows'
+        run: |
+          ls -l -R out/addons/limboai/bin/
+          echo "---"
+          if [ "$RUNNER_OS" == "macOS" ]; then
+            strip -u out/addons/limboai/bin/liblimboai*/liblimboai*
+          else
+            strip out/addons/limboai/bin/liblimboai*
+          fi
+          echo "---"
+          ls -l -R out/addons/limboai/bin/
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v3
+        env:
+          NAME: ${{env.NAME_PREFIX}}
+        with:
+          name: ${{ env.NAME }}
+          path: out/*
diff --git a/.github/workflows/test_builds.yml b/.github/workflows/test_builds.yml
@@ -10,11 +10,6 @@ on:
       - "**/*.png"
       - "demo/*"
       - "doc/*"
-    inputs:
-      godot-treeish:
-        description: A tag, branch or commit hash in the Godot repository.
-        type: string
-        default: 4.2.1-stable
 
   pull_request:
     branches: [ master ]
@@ -23,11 +18,12 @@ on:
       - "LICENSE"
       - "**/*.png"
       - "demo/*"
-    inputs:
-      godot-treeish:
-        description: A tag, branch or commit hash in the Godot repository.
-        type: string
-        default: 4.2.1-stable
+      - "doc/*"
+
+# Global Settings.
+env:
+  GODOT_REF: "4.2.1-stable"
+  GODOT_CPP_REF: "4.2"
 
 jobs:
   unit-tests:
@@ -45,7 +41,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           repository: godotengine/godot
-          ref: ${{ inputs.godot-treeish }}
+          ref: ${{ env.GODOT_REF }}
 
       - name: Clone LimboAI module
         uses: actions/checkout@v4
@@ -67,11 +63,11 @@ jobs:
         uses: actions/cache@v3
         with:
           path: ${{github.workspace}}/.scons_cache/
-          key: ${{env.BIN}}-${{inputs.godot-treeish}}-${{github.ref}}-${{github.sha}}
+          key: ${{env.BIN}}-${{env.GODOT_REF}}-${{github.ref}}-${{github.sha}}
           restore-keys: |
-            ${{env.BIN}}-${{inputs.godot-treeish}}-${{github.ref}}-${{github.sha}}
-            ${{env.BIN}}-${{inputs.godot-treeish}}-${{github.ref}}
-            ${{env.BIN}}-${{inputs.godot-treeish}}
+            ${{env.BIN}}-${{env.GODOT_REF}}-${{github.ref}}-${{github.sha}}
+            ${{env.BIN}}-${{env.GODOT_REF}}-${{github.ref}}
+            ${{env.BIN}}-${{env.GODOT_REF}}
         continue-on-error: true
 
       - name: Set up Python 3.x
@@ -107,26 +103,50 @@ jobs:
         run: |
           bin/${{ env.BIN }} --test --headless
 
+  cache-env:
+    runs-on: ubuntu-latest
+    outputs:
+      godot-ref: ${{ steps.cache-env.outputs.godot-ref }}
+      godot-cpp-ref: ${{ steps.cache-env.outputs.godot-cpp-ref }}
+    steps:
+      - name: Cache env
+        id: cache-env
+        run: |
+          echo "godot-ref=${GODOT_REF}" >> "$GITHUB_OUTPUT"
+          echo "godot-cpp-ref=${GODOT_CPP_REF}" >> "$GITHUB_OUTPUT"
+
   linux-test-build:
-    name: 🐧 Linux test build
+    name: 🐧 Linux
+    needs: cache-env
     uses: ./.github/workflows/linux.yml
     with:
-      godot-treeish: ${{ inputs.godot-treeish }}
+      godot-treeish: ${{ needs.cache-env.outputs.godot-ref }}
       limboai-treeish: ${{ github.sha }}
       test-build: true
 
   windows-test-build:
-    name: 🪟 Windows test build
+    name: 🪟 Windows
+    needs: cache-env
     uses: ./.github/workflows/windows.yml
     with:
-      godot-treeish: ${{ inputs.godot-treeish }}
+      godot-treeish: ${{ needs.cache-env.outputs.godot-ref }}
       limboai-treeish: ${{ github.sha }}
       test-build: true
 
   macos-test-build:
-    name: 🍎 macOS test build
+    name: 🍎 macOS
+    needs: cache-env
     uses: ./.github/workflows/macos.yml
     with:
-      godot-treeish: ${{ inputs.godot-treeish }}
+      godot-treeish: ${{ needs.cache-env.outputs.godot-ref }}
+      limboai-treeish: ${{ github.sha }}
+      test-build: true
+
+  gdextension:
+    name: 🔌 GDExtension
+    needs: cache-env
+    uses: ./.github/workflows/gdextension.yml
+    with:
+      godot-cpp-treeish: ${{ needs.cache-env.outputs.godot-cpp-ref }}
       limboai-treeish: ${{ github.sha }}
       test-build: true
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,7 @@
+# LimboAI-specific
+demo/addons/
+icons/*.import
+
 # Godot auto generated files
 *.gen.*
 .import/

diff --git a/SCsub b/SCsub
@@ -5,6 +5,8 @@ Import("env_modules")
 
 module_env = env.Clone()
 
+module_env.Append(CPPDEFINES = ['LIMBOAI_MODULE'])
+
 module_env.add_source_files(env.modules_sources, "*.cpp")
 module_env.add_source_files(env.modules_sources, "blackboard/*.cpp")
 module_env.add_source_files(env.modules_sources, "blackboard/bb_param/*.cpp")

diff --git a/blackboard/bb_param/bb_aabb.h b/blackboard/bb_param/bb_aabb.h
@@ -13,7 +13,6 @@
 #define BB_AABB_H
 
 #include "bb_param.h"
-#include "core/object/object.h"
 
 class BBAabb : public BBParam {
 	GDCLASS(BBAabb, BBParam);

diff --git a/blackboard/bb_param/bb_array.h b/blackboard/bb_param/bb_array.h
@@ -13,7 +13,6 @@
 #define BB_ARRAY_H
 
 #include "bb_param.h"
-#include "core/object/object.h"
 
 class BBArray : public BBParam {
 	GDCLASS(BBArray, BBParam);

diff --git a/blackboard/bb_param/bb_basis.h b/blackboard/bb_param/bb_basis.h
@@ -13,7 +13,6 @@
 #define BB_BASIS_H
 
 #include "bb_param.h"
-#include "core/object/object.h"
 
 class BBBasis : public BBParam {
 	GDCLASS(BBBasis, BBParam);

diff --git a/blackboard/bb_param/bb_bool.h b/blackboard/bb_param/bb_bool.h
@@ -13,7 +13,6 @@
 #define BB_BOOL_H
 
 #include "bb_param.h"
-#include "core/object/object.h"
 
 class BBBool : public BBParam {
 	GDCLASS(BBBool, BBParam);