Restructure and cleanup

Moved plugins and scripts to different folders. Direct usage of Godot's source instead of exported headers. XCFramework and Static Library scripts to build final plugin library.
godot-sdk-integrations · Jan 18, 2021 · a3a4f90 · a3a4f90
1 parent 401113c
commit a3a4f90
Show file tree

Hide file tree

Showing 48 changed files with 129 additions and 132 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "godot"]
+	path = godot
+	url = https://github.com/godotengine/godot
diff --git a/LICENCE b/LICENCE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Godot Engine
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,23 @@
+# Godot iOS plugins
+
+
+## Building a `.a` library
+
+* Use submodule to pull required Godot version into `godot` folder. (`master` branch for `4.0` and `3.2` branch for `3.2` version)  
+  Alternatively you can place a Godot's header files including generated ones at `godot` folder.  
+  You can extract headers from Godot's source manually or by using `extract_headers.sh` script from `scripts` folder.
+
+* Run `scons target=<debug|release|release_debug> arch=<arch> simulator=<no|yes> plugin=<plugin_name> version=<3.2|4.0>` to compile the plugin you need for specific version of Godot.  
+  You can also use `./scripts/generate_xcframework.sh <plugin_name> <debug|release|release_debug> <godot_version>` to generate fat static library with specific configuration.
+
+* The result `.a` binary will be stored in `bin` folder.
+
+## Building a `.xcframework` library
+
+* Use submodule to pull required Godot version into `godot` folder. (`master` branch for `4.0` and `3.2` branch for `3.2` version)  
+  Alternatively you can place a Godot's header files including generated ones at `godot` folder.  
+  You can extract headers from Godot's source manually or by using `extract_headers.sh` script from `scripts` folder.
+
+* Run `./scripts/generate_xcframework.sh <plugin_name> <debug|release|release_debug> <godot_version>` 
+
+* The result `.xcframework` will be stored in `bin` folder as well as intermidiate `.a` binaries.
diff --git a/SConstruct b/SConstruct
@@ -27,10 +27,6 @@ opts.Add(PathVariable('target_path', 'The path where the lib is installed.', 'bi
 opts.Add(EnumVariable('plugin', 'Plugin to build', '', ['', 'arkit', 'camera', 'icloud', 'gamecenter', 'inappstore']))
 opts.Add(EnumVariable('version', 'Godot version to target', '', ['', '3.2', '4.0']))
 
-# Local dependency paths, adapt them to your setup
-godot_path = "godot/"
-godot_library = "ios.fat.a"
-
 # Updates the environment with the option variables.
 opts.Update(env)
 
@@ -94,6 +90,9 @@ env.Prepend(CXXFLAGS=[
 ])
 env.Append(LINKFLAGS=["-arch", env['arch'], '-isysroot', sdk_path, '-F' + sdk_path])
 
+if env['arch'] == 'armv7':
+    env.Prepend(CXXFLAGS=['-fno-aligned-allocation'])
+
 if env['version'] == '3.2':
     env.Prepend(CFLAGS=['-std=gnu11'])
     env.Prepend(CXXFLAGS=['-DGLES_ENABLED', '-std=gnu++14'])
@@ -106,16 +105,22 @@ if env['version'] == '3.2':
             '-DPTRCALL_ENABLED',
         ])
     elif env['target'] == 'release_debug':
-        env.Prepend(CXXFLAGS=['-O2', '-ftree-vectorize', '-fomit-frame-pointer', 
+        env.Prepend(CXXFLAGS=['-O2', '-ftree-vectorize',
             '-DNDEBUG', '-DNS_BLOCK_ASSERTIONS=1', '-DDEBUG_ENABLED', 
             '-DPTRCALL_ENABLED',
         ])
+
+        if env['arch'] != 'armv7':
+            env.Prepend(CXXFLAGS=['-fomit-frame-pointer'])
     else:
         env.Prepend(CXXFLAGS=[
-            '-O2', '-ftree-vectorize', '-fomit-frame-pointer', 
+            '-O2', '-ftree-vectorize',
             '-DNDEBUG', '-DNS_BLOCK_ASSERTIONS=1', 
             '-DPTRCALL_ENABLED',
         ])
+
+        if env['arch'] != 'armv7':
+            env.Prepend(CXXFLAGS=['-fomit-frame-pointer'])
 elif env['version'] == '4.0':
     env.Prepend(CFLAGS=['-std=gnu11'])
     env.Prepend(CXXFLAGS=['-DVULKAN_ENABLED', '-std=gnu++17'])
@@ -128,38 +133,44 @@ elif env['version'] == '4.0':
         ])
     elif env['target'] == 'release_debug':
         env.Prepend(CXXFLAGS=[
-            '-O2', '-ftree-vectorize', '-fomit-frame-pointer', 
+            '-O2', '-ftree-vectorize',
             '-DNDEBUG', '-DNS_BLOCK_ASSERTIONS=1', '-DDEBUG_ENABLED',
         ])
+
+        if env['arch'] != 'armv7':
+            env.Prepend(CXXFLAGS=['-fomit-frame-pointer'])
     else:
         env.Prepend(CXXFLAGS=[
-            '-O2', '-ftree-vectorize', '-fomit-frame-pointer',
+            '-O2', '-ftree-vectorize',
             '-DNDEBUG', '-DNS_BLOCK_ASSERTIONS=1',
         ])
+
+        if env['arch'] != 'armv7':
+            env.Prepend(CXXFLAGS=['-fomit-frame-pointer'])            
 else:
     print("No valid version to set flags for.")
     quit();
 
 # Adding header files
 env.Append(CPPPATH=[
     '.', 
-    'godot_headers', 
-    'godot_headers/main', 
-    'godot_headers/core', 
-    'godot_headers/core/os', 
-    'godot_headers/core/platform',
-    'godot_headers/platform/iphone',
-    'godot_headers/modules',
-    'godot_headers/scene',
-    'godot_headers/servers',
-    'godot_headers/drivers',
-    'godot_headers/thirdparty',
+    'godot', 
+    'godot/main', 
+    'godot/core', 
+    'godot/core/os', 
+    'godot/core/platform',
+    'godot/platform/iphone',
+    'godot/modules',
+    'godot/scene',
+    'godot/servers',
+    'godot/drivers',
+    'godot/thirdparty',
 ])
 
 # tweak this if you want to use different folders, or more folders, to store your source code in.
-sources = Glob(env['plugin'] + '/*.cpp')
-sources.append(Glob(env['plugin'] + '/*.mm'))
-sources.append(Glob(env['plugin'] + '/*.m'))
+sources = Glob('plugins/' + env['plugin'] + '/*.cpp')
+sources.append(Glob('plugins/' + env['plugin'] + '/*.mm'))
+sources.append(Glob('plugins/' + env['plugin'] + '/*.m'))
 
 # lib<plugin>.<arch>-<simulator|iphone>.<release|debug|release_debug>.a
 library_platform = env["arch"] + "-" + ("simulator" if env["simulator"] else "iphone")

diff --git a/arkit/SCsub b/arkit/SCsub
diff --git a/arkit/config.py b/arkit/config.py
diff --git a/camera/SCsub b/camera/SCsub
diff --git a/camera/config.py b/camera/config.py
diff --git a/gamecenter/SCsub b/gamecenter/SCsub
diff --git a/gamecenter/config.py b/gamecenter/config.py
diff --git a/godot b/godot
diff --git a/godot_headers/dummy b/godot_headers/dummy
diff --git a/icloud/SCsub b/icloud/SCsub
diff --git a/icloud/config.py b/icloud/config.py
diff --git a/inappstore/SCsub b/inappstore/SCsub
diff --git a/inappstore/config.py b/inappstore/config.py
diff --git a/arkit/arkit.gdip → plugins/arkit/arkit.gdip b/arkit/arkit.gdip → plugins/arkit/arkit.gdip
@@ -1,6 +1,6 @@
 [config]
 name="ARKit"
-binary="arkit_lib.a"
+binary="arkit.a"
 
 initialization="register_arkit_types"
 deinitialization="unregister_arkit_types"

diff --git a/arkit/arkit_interface.h → plugins/arkit/arkit_interface.h b/arkit/arkit_interface.h → plugins/arkit/arkit_interface.h
diff --git a/arkit/arkit_interface.mm → plugins/arkit/arkit_interface.mm b/arkit/arkit_interface.mm → plugins/arkit/arkit_interface.mm
diff --git a/arkit/arkit_module.cpp → plugins/arkit/arkit_module.cpp b/arkit/arkit_module.cpp → plugins/arkit/arkit_module.cpp
diff --git a/arkit/arkit_module.h → plugins/arkit/arkit_module.h b/arkit/arkit_module.h → plugins/arkit/arkit_module.h
diff --git a/arkit/arkit_session_delegate.h → plugins/arkit/arkit_session_delegate.h b/arkit/arkit_session_delegate.h → plugins/arkit/arkit_session_delegate.h
diff --git a/arkit/arkit_session_delegate.mm → plugins/arkit/arkit_session_delegate.mm b/arkit/arkit_session_delegate.mm → plugins/arkit/arkit_session_delegate.mm
diff --git a/camera/camera.gdip → plugins/camera/camera.gdip b/camera/camera.gdip → plugins/camera/camera.gdip
@@ -1,6 +1,6 @@
 [config]
 name="Camera"
-binary="camera_lib.a"
+binary="camera.a"
 
 initialization="register_camera_types"
 deinitialization="unregister_camera_types"

diff --git a/camera/camera_ios.h → plugins/camera/camera_ios.h b/camera/camera_ios.h → plugins/camera/camera_ios.h
diff --git a/camera/camera_ios.mm → plugins/camera/camera_ios.mm b/camera/camera_ios.mm → plugins/camera/camera_ios.mm
diff --git a/camera/camera_module.cpp → plugins/camera/camera_module.cpp b/camera/camera_module.cpp → plugins/camera/camera_module.cpp
diff --git a/camera/camera_module.h → plugins/camera/camera_module.h b/camera/camera_module.h → plugins/camera/camera_module.h
diff --git a/gamecenter/game_center.h → plugins/gamecenter/game_center.h b/gamecenter/game_center.h → plugins/gamecenter/game_center.h
diff --git a/gamecenter/game_center.mm → plugins/gamecenter/game_center.mm b/gamecenter/game_center.mm → plugins/gamecenter/game_center.mm
diff --git a/gamecenter/game_center_delegate.h → plugins/gamecenter/game_center_delegate.h b/gamecenter/game_center_delegate.h → plugins/gamecenter/game_center_delegate.h
diff --git a/gamecenter/game_center_delegate.mm → plugins/gamecenter/game_center_delegate.mm b/gamecenter/game_center_delegate.mm → plugins/gamecenter/game_center_delegate.mm
diff --git a/gamecenter/game_center_module.cpp → plugins/gamecenter/game_center_module.cpp b/gamecenter/game_center_module.cpp → plugins/gamecenter/game_center_module.cpp
diff --git a/gamecenter/game_center_module.h → plugins/gamecenter/game_center_module.h b/gamecenter/game_center_module.h → plugins/gamecenter/game_center_module.h
diff --git a/gamecenter/gamecenter.gdip → plugins/gamecenter/gamecenter.gdip b/gamecenter/gamecenter.gdip → plugins/gamecenter/gamecenter.gdip
@@ -1,6 +1,6 @@
 [config]
 name="GameCenter"
-binary="gamecenter_lib.a"
+binary="gamecenter.a"
 
 initialization="register_gamecenter_types"
 deinitialization="unregister_gamecenter_types"

diff --git a/icloud/icloud.gdip → plugins/icloud/icloud.gdip b/icloud/icloud.gdip → plugins/icloud/icloud.gdip
@@ -1,6 +1,6 @@
 [config]
 name="iCloud"
-binary="icloud_lib.a"
+binary="icloud.a"
 
 initialization="register_icloud_types"
 deinitialization="unregister_icloud_types"

diff --git a/icloud/icloud.h → plugins/icloud/icloud.h b/icloud/icloud.h → plugins/icloud/icloud.h
diff --git a/icloud/icloud.mm → plugins/icloud/icloud.mm b/icloud/icloud.mm → plugins/icloud/icloud.mm
diff --git a/icloud/icloud_module.cpp → plugins/icloud/icloud_module.cpp b/icloud/icloud_module.cpp → plugins/icloud/icloud_module.cpp
diff --git a/icloud/icloud_module.h → plugins/icloud/icloud_module.h b/icloud/icloud_module.h → plugins/icloud/icloud_module.h
diff --git a/inappstore/in_app_store.h → plugins/inappstore/in_app_store.h b/inappstore/in_app_store.h → plugins/inappstore/in_app_store.h
diff --git a/inappstore/in_app_store.mm → plugins/inappstore/in_app_store.mm b/inappstore/in_app_store.mm → plugins/inappstore/in_app_store.mm
diff --git a/inappstore/in_app_store_module.cpp → plugins/inappstore/in_app_store_module.cpp b/inappstore/in_app_store_module.cpp → plugins/inappstore/in_app_store_module.cpp
diff --git a/inappstore/in_app_store_module.h → plugins/inappstore/in_app_store_module.h b/inappstore/in_app_store_module.h → plugins/inappstore/in_app_store_module.h
diff --git a/inappstore/inappstore.gdip → plugins/inappstore/inappstore.gdip b/inappstore/inappstore.gdip → plugins/inappstore/inappstore.gdip
@@ -1,6 +1,6 @@
 [config]
 name="InAppStore"
-binary="inappstore_lib.a"
+binary="inappstore.a"
 
 initialization="register_inappstore_types"
 deinitialization="unregister_inappstore_types"

diff --git a/scripts/extract_headers.sh b/scripts/extract_headers.sh
@@ -0,0 +1,3 @@
+#!/bin/bash
+
+rsync -a -m -R --include '*/' --include '*.h' --include '*.inc' --exclude '*' ./ extracted_headers
diff --git a/scripts/generate_static_library.sh b/scripts/generate_static_library.sh
@@ -0,0 +1,17 @@
+#!/bin/bash
+
+# Compile static libraries
+
+# ARM64 Device
+scons target=$2 arch=arm64 plugin=$1 version=$3
+# ARM7 Device
+scons target=$2 arch=armv7 plugin=$1 version=$3
+# x86_64 Simulator
+scons target=$2 arch=x86_64 simulator=yes plugin=$1 version=$3
+
+# Creating a fat libraries for device and simulator
+# lib<plugin>.<arch>-<simulator|iphone>.<release|debug|release_debug>.a
+lipo -create "./bin/lib$1.x86_64-simulator.$2.a" \
+    "./bin/lib$1.armv7-iphone.$2.a" \
+    "./bin/lib$1.arm64-iphone.$2.a" \
+    -output "./bin/$1.$2.a"
diff --git a/scripts/generate_xcframework.sh b/scripts/generate_xcframework.sh
@@ -0,0 +1,23 @@
+#!/bin/bash
+
+# Compile static libraries
+
+# ARM64 Device
+scons target=$2 arch=arm64 plugin=$1 version=$3
+# ARM7 Device
+scons target=$2 arch=armv7 plugin=$1 version=$3
+# x86_64 Simulator
+scons target=$2 arch=x86_64 simulator=yes plugin=$1 version=$3
+# ARM64 Simulator
+scons target=$2 arch=arm64 simulator=yes plugin=$1 version=$3
+
+# Creating a fat libraries for device and simulator
+# lib<plugin>.<arch>-<simulator|iphone>.<release|debug|release_debug>.a
+lipo -create "./bin/lib$1.x86_64-simulator.$2.a" "./bin/lib$1.arm64-simulator.$2.a" -output "./bin/$1-simulator.$2.a"
+lipo -create "./bin/lib$1.armv7-iphone.$2.a" "./bin/lib$1.arm64-iphone.$2.a" -output "./bin/$1-device.$2.a"
+
+# Creating a xcframework 
+xcodebuild -create-xcframework \
+    -library "./bin/$1-device.$2.a" \
+    -library "./bin/$1-simulator.$2.a" \
+    -output "./bin/$1.$2.xcframework"