Building

There are three main build scripts located in the script directory.

Cross-Platform Builds

Cross-platform builds with the build.sh script.

Build Options

Output Locations

Android Builds

Quick Reference

# Clean and build Android debug
./script/build.sh -a -- -cb

# Clean and build Android release
./script/build.sh -a -- -cbr

# Install Android plugin to demo app
./script/build_android.sh -D

# Uninstall Android plugin from demo app
./script/build_android.sh -d

# Create Android release archive
./script/build_android.sh -R

Build Options

Android Studio

If using Android Studio, make sure to open the root Gradle project from the common directory.

iOS Builds

Quick Reference

# Clean and run iOS debug build
./script/build.sh -i -- -cb

# Full build (first time - downloads Godot headers automatically)
./script/build_ios.sh -A

# Clean and rebuild (reuses existing Godot headers)
./script/build_ios.sh -ca

# Full clean rebuild (removes Godot headers directory first)
./script/build_ios.sh -cgA

# Clean, build and create archive
./script/build_ios.sh -cR

# Debug build for simulator
./script/build_ios.sh -bs

# Release build for simulator
./script/build_ios.sh -Bs

# Install iOS plugin to demo app
./script/build_ios.sh -D

# Uninstall iOS plugin from demo app
./script/build_ios.sh -d

# Resolve SPM dependencies only
./script/build_ios.sh -r

Build Options

Build Process Explained

The iOS build process involves several steps that are orchestrated automatically:

1. Download Godot Headers (if needed):

   • Downloads a pre-built Godot headers archive from github.com/godot-mobile-plugins/godot-headers
   • Version is determined by godotVersion and godotReleaseType in godot.properties
   • Extracted to ios/godot/ by default, or to the path set by godot.dir in common/local.properties
   • The download is skipped if the correct version is already present (checked via a GODOT_VERSION file)
   • If the directory exists but contains a different version, the build fails with a clear error - run ./script/build_ios.sh -gG to switch versions

2. Validate Swift Version:

   • Reads swift_version from ios/config/ios.properties
   • Fails early with a clear error if the property is missing or blank
   • Syncs the version into plugin.xcodeproj/project.pbxproj automatically

3. Validate Godot Version:

   • Confirms the GODOT_VERSION file in the Godot headers directory matches godotVersion in godot.properties

4. Update & Resolve SPM Packages:

   • Reads dependency definitions from ios/config/spm_dependencies.json
   • Injects package references into the Xcode project via script/spm_manager.rb (requires Ruby and the xcodeproj gem)
   • Resolves the packages with xcodebuild -resolvePackageDependencies

5. Build XCFrameworks:

   • Builds up to four variants via xcodebuild archive:

• The -s flag selects simulator variants; without it, device variants are built
• Archives are created as .xcarchive bundles under ios/build/lib/
• XCFrameworks combining device and simulator slices are assembled in ios/build/framework/
• Only the plugin's own xcframeworks (PluginName.debug.xcframework, PluginName.release.xcframework) are copied into the plugin directory and included in release archives
• SPM dependency xcframeworks produced in ios/build/DerivedData/ are not bundled in the archive; they are resolved by Xcode at Godot iOS export time using the Package.resolved file that is committed alongside the Xcode project

Output Locations

• Godot headers: ios/godot/ (default) or path set by godot.dir in common/local.properties
• Build artifacts: ios/build/
• xcarchives: ios/build/lib/ios_debug.xcarchive, ios_release.xcarchive, sim_debug.xcarchive, sim_release.xcarchive
• Plugin XCFrameworks: ios/build/framework/OAuth2Plugin.debug.xcframework, OAuth2Plugin.release.xcframework
• Release archive: release/OAuth2Plugin-iOS-v*.zip