update for 4.1

.github/actions/godot-cache/action.yml

@@ -0,0 +1,22 @@
+name: Setup Godot build cache
+description: Setup Godot build cache.
+inputs:
+  cache-name:
+    description: The cache base name (job name by default).
+    default: "${{github.job}}"
+  scons-cache:
+    description: The scons cache path.
+    default: "${{github.workspace}}/.scons-cache/"
+runs:
+  using: "composite"
+  steps:
+    # Upload cache on completion and check it out now
+    - name: Load .scons_cache directory
+      uses: actions/cache@v3
+      with:
+        path: ${{inputs.scons-cache}}
+        key: ${{inputs.cache-name}}-${{env.GODOT_BASE_BRANCH}}-${{github.ref}}-${{github.sha}}
+        restore-keys: |
+          ${{inputs.cache-name}}-${{env.GODOT_BASE_BRANCH}}-${{github.ref}}-${{github.sha}}
+          ${{inputs.cache-name}}-${{env.GODOT_BASE_BRANCH}}-${{github.ref}}
+          ${{inputs.cache-name}}-${{env.GODOT_BASE_BRANCH}}

.github/workflows/deploy.yml

@@ -0,0 +1,130 @@
+# Action name
+name: Deploy
+
+# 触发条件，这里是新的 tag 被 push 时触发
+on:
+  push:
+    tags:
+      # 正则匹配 tag 格式，如 v0.1.0
+      - "v[0-9]+.[0-9]+.[0-9]+"
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+# 实际工作
+jobs:
+  build-and-upload:
+    name: Build and Upload
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      # 配置编译目标平台，这里是在 Ubuntu, MacOS, Windows 上分别编译
+      matrix:
+        include:
+          - name: Linux (GCC)
+            platform: linux
+            arch: x86_64
+            os: ubuntu-latest
+            cache-name: linux-x86_64
+
+          - name: Windows (MSVC)
+            platform: windows
+            arch: x86_64
+            os: windows-latest
+            cache-name: windows-x86_64-msvc
+    # 执行流程
+    steps:
+      # 克隆仓库代码
+      - name: Clone repository
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      # 获取发布版本号
+      - name: Get the release version from the tag
+        shell: bash
+        run: echo "VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
+
+      # 设置 Godot 缓存
+      - name: Setup Godot build cache
+        uses: ./.github/actions/godot-cache
+        with:
+          cache-name: ${{ matrix.cache-name }}
+        continue-on-error: true
+
+      # 安装依赖库
+      - name: Install dependencies
+        if: ${{ matrix.platform == 'linux' }}
+        run: |
+          sudo apt-get update -qq
+          sudo apt-get install -qqq build-essential pkg-config tree
+    
+      # 安装 SCons
+      - name: Set up Python (for SCons)
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+
+      - name: Install scons
+        run: |
+          python -m pip install scons
+
+      # 构建二进制文件
+      - name: Build binary files (template_debug)
+        run: |
+          scons target=template_debug --sconstruct=gdextension_build/SConstruct
+
+      - name: Build binary files (template_release)
+        run: |
+          scons target=template_release --sconstruct=gdextension_build/SConstruct
+
+      # 打包上传二进制文件
+      - name: Archive files
+        shell: bash
+        run: |
+          addon_name="serialport"
+          addon_path="gdextension_build/example/addons/$addon_name"
+          archive_bin_dir="addons/serialport/bin"
+          
+          mkdir -p "$addon_path/bin"
+          mkdir -p "$archive_bin_dir"
+
+          if [ "${{ matrix.platform }}" = "linux" ]; then
+            addon_file_debug="lib$addon_name.${{ matrix.platform }}.template_debug.${{ matrix.arch }}.so"
+            addon_file_release="lib$addon_name.${{ matrix.platform }}.template_release.${{ matrix.arch }}.so"
+          elif [ "${{ matrix.platform }}" = "windows" ]; then
+            addon_file_debug="$addon_name.${{ matrix.platform }}.template_debug.${{ matrix.arch }}.dll"
+            addon_file_release="$addon_name.${{ matrix.platform }}.template_release.${{ matrix.arch }}.dll"
+          fi
+
+          mv $addon_path/bin/$addon_file_debug $archive_bin_dir/$addon_file_debug
+          mv $addon_path/bin/$addon_file_release $archive_bin_dir/$addon_file_release
+
+          cat>$archive_bin_dir/../$addon_name.gdextension<<EOF
+          [configuration]
+          entry_symbol = "${addon_name}_lib_init"
+          compatibility_minimum = 4.1
+
+          [libraries]
+          ${{ matrix.platform }}.debug.${{ matrix.arch }}= "bin/$addon_file_debug"
+          ${{ matrix.platform }}.release.${{ matrix.arch }}= "bin/$addon_file_release"
+
+          EOF
+
+          archive_name="$addon_name-${{ env.VERSION }}-${{ matrix.platform }}"
+          if [ "${{ matrix.platform }}" = "linux" ]; then
+            tree addons
+            tar -czvf "$archive_name.tar.gz" "addons"
+            echo "ASSET=$archive_name.tar.gz" >> $GITHUB_ENV
+          elif [ "${{ matrix.platform }}" = "windows" ]; then
+            7z a "$archive_name.zip" "addons"
+            echo "ASSET=$archive_name.zip" >> $GITHUB_ENV
+          fi
+
+      - name: Release files
+        uses: softprops/action-gh-release@v1
+        with:
+          files: |
+            ${{ env.ASSET }}

.gitmodules

@@ -1,9 +1,9 @@
 [submodule "serial"]
 	path = serial
-	url = https://github.com/matrixant/serial.git
+	url = https://github.com/wjwwood/serial.git
 [submodule "godot-cpp"]
 	path = godot-cpp
-	url = https://github.com/matrixant/godot-cpp.git
+	url = https://github.com/godotengine/godot-cpp.git
 [submodule "gdextension_build/example"]
 	path = gdextension_build/example
 	url = https://github.com/matrixant/serial_port_example.git

README.md

@@ -14,6 +14,8 @@ git clone https://github.com/matrixant/serial_port.git --recursive
 > cd godot
 > scons target=editor
 > ```
+> * Simple API document included. (Only available when build as module)
+
 > Or you want to build as plugin, switch to the `plugin` branch and update the submodules, then compile the plugin.
 > ```bash
 > cd serial_port
@@ -23,9 +25,8 @@ git clone https://github.com/matrixant/serial_port.git --recursive
 > ```
 > The plugin things will be build to `gdextension_build/example/addons/serialport` directory.
 
+
 2. The `SerialPort` class will add to godot. You can new a SerialPort object and set it's 'port', 'baudrate', 'bytesize' and so on. Then open it and communicate with your serial device.
 3. There is an example in [serial_port_example](https://github.com/matrixant/serial_port_example) repo. 
 
-> Simple API document included.
-
 ![example](https://github.com/raw/matrixant/serial_port_example/main/screen_shot_0.png)

gdextension_build/SConstruct

@@ -38,14 +38,24 @@ addon_name = "serialport"
 addon_path = "gdextension_build/example/addons/{}".format(addon_name)
 if env["platform"] == "macos":
     library = env.SharedLibrary(
-        "{0}/bin/lib{1}.{2}.{3}.framework/lib{1}.{2}.{3}".format(
+        "{0}/bin/lib{1}.{2}.{3}.dylib".format(
             addon_path,
             addon_name,
             env["platform"],
             env["target"]
         ),
         source=addon_sources,
     )
+elif env["platform"] == "windows":
+    library = env.SharedLibrary(
+        "{0}/bin/{1}{2}{3}".format(
+            addon_path,
+            addon_name,
+            env["suffix"],
+            env["SHLIBSUFFIX"]
+        ),
+        source=addon_sources,
+    )
 else:
     library = env.SharedLibrary(
         "{0}/bin/lib{1}{2}{3}".format(

register_types.cpp

@@ -53,8 +53,8 @@ void uninitialize_serial_port_module(ModuleInitializationLevel p_level) {
 
 extern "C" {
 // Initialization.
-GDExtensionBool GDE_EXPORT serial_port_library_init(const GDExtensionInterface *p_interface, GDExtensionClassLibraryPtr p_library, GDExtensionInitialization *r_initialization) {
-	godot::GDExtensionBinding::InitObject init_obj(p_interface, p_library, r_initialization);
+GDExtensionBool GDE_EXPORT serialport_lib_init(const GDExtensionInterfaceGetProcAddress p_get_proc_addr, GDExtensionClassLibraryPtr p_library, GDExtensionInitialization *r_initialization) {
+	godot::GDExtensionBinding::InitObject init_obj(p_get_proc_addr, p_library, r_initialization);
 
 	init_obj.register_initializer(initialize_serial_port_module);
 	init_obj.register_terminator(uninitialize_serial_port_module);
@@ -64,4 +64,4 @@ GDExtensionBool GDE_EXPORT serial_port_library_init(const GDExtensionInterface *
 }
 } // extern "C"
 
-#endif
+#endif