SwiftGodotKit Documentation

When building from source or using specific branches, you must ensure that the SwiftGodot bindings and the godot engine sources are API-compatible. Mismatched branches can lead to runtime failures with gdextension_classdb_get_method_bind errors.

For the current embeddable system, use these specific branches:

• SwiftGodot branch: swiftgodotkit
• godot branch: swiftgodotkit-4.6

To embed a Godot game or UI elements into an existing SwiftUI project, use the GodotApp and GodotAppView types.

1. Add your Godot PCK file to your Xcode project.
2. Initialize a GodotApp with the path to your .pck file.
3. Use GodotAppView() within your SwiftUI view hierarchy.
4. Inject the GodotApp instance into the environment using the .environment(\.godotApp, app) modifier.

Note: There can only be one GodotApp instance per application, but you can reference different scenes from it.

import SwiftUI
import SwiftGodot
import SwiftGodotKit

struct ContentView: View {
    @State var app = GodotApp(packFile: "game.pck")

    var body: some View {
        VStack {
            Text("Game is below:")
            GodotAppView()
                .padding()
        }
        .environment(\.godotApp, app)
    }
}

You can integrate SwiftGodotKit into a standalone Swift Package by initializing a new package and extending its Package.swift to reference the SwiftGodotKit dependency.

To run the standalone example, you must ensure the libgodot.dylib library is present in the current directory before executing the run command.

# Initialize the package
swift package init -n StandaloneExample

# Prepare the environment by copying the Godot library
cp .build/*/*/libgodot.dylib .

# Run the application
swift run

Add SwiftGodotKit to your Package.swift file by referencing the GitHub URL and specifying the exact version tag. You can then depend on the SwiftGodotKit product.

SwiftPM will automatically handle downloading the correct libgodot binary target (libgodot-macos.xcframework.zip or libgodot-ios.xcframework.zip) based on your target platform.

.package(url: "https://github.com/migueldeicaza/SwiftGodotKit", exact: "<SwiftGodotKit tag>")

// and depend on the product
.product(name: "SwiftGodotKit", package: "SwiftGodotKit")