SwiftGodot

0.41.0

New Godot bindings for Swift
migueldeicaza/SwiftGodot

What's New

2024-03-20T22:41:35Z

Version 0.41 is out, with lots of small improvements:

  • Wrapped.isValid can now be used to determine if an object has been
    released, this is the case when you might have called the
    queueFree method, use this on those objects to check if the object
    has alreayd been released or not.

    This helps alleviate the issue discussed in:
    #416

    Miguel

  • New helper method Variant.typeName (GType) which can be used to get
    the underlying type name (Miguel)

  • Add support for Swift 5.10 on Windows, which had a handful of
    breaking issues (Mikhail Tishin)

  • Upgraded Swift Syntax to a newer version (Mikhail Tishin)

  • GDictionary now supports debugDescription which will return the
    dictionary contents (Miguel)

  • Updates the documentation to reflect some recent API changes
    (Mikhail Tishin, Miguel).

  • We no longer depend on Foundation to build SwiftGodot, which should
    help users that do not want to pay the price of using it. The
    downside is that we lost the PackedByteArray.asData() method (as
    Data is defined in Foundation). But in exchange, we got an
    asBytes that reutnrs a byte array, and two unsafe with* methods
    that can be used to access the underlying buffer directly) - Mikhail
    Tishin and Miguel.

  • Packed Byte, Int32, Int64, Double and Float can now be initialized
    from arrays of those types without using an intermediary GArray of
    Variants (Miguel)

  • Now we have a static library of SwiftGodot in the build for those
    that need it (Mikhail Tishin)

  • Fixes a leak in returned VariatnCollections (Miguel).

SwiftGodot

SwiftGodot provides Swift language bindings for the Godot 4.2 game engine using the new GDExtension system (for 4.1 compatibility, use the 4.1 branch).

SwiftGodot can be used to either build an extension that can be added to an existing Godot project, where your code is providing services to the game engine, or it can be used as an API with SwiftGodotKit which embeds Godot as an application that is driven directly from Swift.

Tutorials and Documentation:

Of interest to the community:

Driving Godot from Swift has the advantage that on MacOS you can debug your code from Xcode as well as the Godot code.

Screen.Recording.2023-04-02.at.11.59.18.AM.mov

Why SwiftGodot?

Consuming SwiftGodot

There are two ways of consuming SwiftGodot, you can either reference this module in SwiftPM by using this address - and it will trigger a complete source code build for you, or to quickly iterate on MacOS, you can use a convenient binary in the peer https://github.com/migueldeicaza/SwiftGodotBinary

Currently this requires Swift 5.9 or Xcode 15.

Working with this Repository

You should be all set by referencing this as a package from SwiftPM but if you want to just work on the binding generator, you may want to open the Generator project and edit the okList variable to trim the build times.

Driving Godot From Swift

To drive Godot from Swift, use the companion SwiftGodotKit module which embeds Godot directly into your application, which allows you to to launch the Godot runtime from your code.

Creating an Extension

Creating an extension that can be used in Godot requires a few components:

  • Your Swift code: this is where you bring the magic
  • A .gdextension file that describes where to find the requires Swift library assets
  • Some Swift registation code and bootstrap code
  • Importing your extension into your project

Your Swift Code

Your Swift code will be compiled into a shared library that Godot will call. To get started, the simplest thing to do is to create a Swift Library Package that references the Swift Godot package, like this:

// swift-tools-version: 5.9
import PackageDescription

let package = Package(
    name: "MyFirstGame",
    products: [
        .library(name: "MyFirstGame", type: .dynamic, targets: ["MyFirstGame"]),
    ],
    dependencies: [
        .package(url: "https://github.com/migueldeicaza/SwiftGodot", branch: "main")
    ],
    targets: [
        .target(
            name: "MyFirstGame",
            dependencies: ["SwiftGodot"])]
)

The above will compile all of SwiftGodot for you - alternatively, if you do not need access to the source, you can use the .binaryTarget feature of SwiftPM and reference an .xcframework that I have conveniently published on GitHub at https://github.com/migueldeicaza/SwiftGodotBinary

The next step is to create your source file with the magic on it, here we declare a spinning cube:

import SwiftGodot

@Godot
class SpinningCube: Node3D {
    public override func _ready () {
        let meshRender = MeshInstance3D()
        meshRender.mesh = BoxMesh()
        addChild(node: meshRender)
    }

    public override func _process(delta: Double) {
        rotateY(angle: delta)
    }
}

Additionally, you need to write some glue code for your project to be loadable by Godot, you can do it like this:

/// We register our new type when we are told that the scene is being loaded
func setupScene (level: GDExtension.InitializationLevel) {
    if level == .scene {
        register(type: SpinningCube.self)
    }
}

// Export our entry point to Godot:
@_cdecl ("swift_entry_point")
public func swift_entry_point(
    interfacePtr: OpaquePointer?,
    libraryPtr: OpaquePointer?,
    extensionPtr: OpaquePointer?) -> UInt8
{
    print ("SwiftGodot Extension loaded")
    guard let interfacePtr, let libraryPtr, let extensionPtr else {
        print ("Error: some parameters were not provided")
        return 0
    }
    initializeSwiftModule(interfacePtr, libraryPtr, extensionPtr, initHook: setupScene, deInitHook: { x in })
    return 1
}

Alternatively, you can use the #initSwiftExtension macro:

import SwiftGodot

#initSwiftExtension(cdecl: "swift_entry_point", types: [SpinningCube.self])

Bundling Your Extension

To make your extension available to Godot, you will need to build the binaries for all of your target platforms, as well as creating a .gdextension file that lists this payload, along with the entry point you declared above.

You would create something like this in a file called MyFirstGame.gdextension:

[configuration]
entry_symbol = "swift_entry_point"
compatibility_minimum = 4.2

[libraries]
macos.debug = "res://bin/MyFirstGame"
macos.release = "res://bin/MyFirstGame"
windows.debug.x86_32 = "res://bin/MyFirstGame"
windows.release.x86_32 = "res://bin/MyFirstGame"
windows.debug.x86_64 = "res://bin/MyFirstGame"
windows.release.x86_64 = "res://bin/MyFirstGame"
linux.debug.x86_64 = "res://bin/MyFirstGame"
linux.release.x86_64 = "res://bin/MyFirstGame"
linux.debug.arm64 = "res://bin/MyFirstGame"
linux.release.arm64 = "res://bin/MyFirstGame"
linux.debug.rv64 = "res://bin/MyFirstGame"
linux.release.rv64 = "res://bin/MyFirstGame"
android.debug.x86_64 = "res://bin/MyFirstGame"
android.release.x86_64 = "res://bin/MyFirstGame"
android.debug.arm64 = "res://bin/MyFirstGame"
android.release.arm64 = "res://bin/MyFirstGame"

In the example above, the extension always expects the platform specific payload to be called "MyFirstGame", regarless of the platform. If you want to distribute your extension to other users and have a single payload, you will need to manually set different names for those.

Installing your Extension

You need to copy both the new .gdextension file into an existing project, along with the resources it references.

Once it is there, Godot will load it for you.

Using your Extension

Once you create your extension and have loaded it into Godot, you can reference it from your code by using the "Add Child Node" command in Godot (Command-A on MacOS) and then finding it in the hierarchy.

In our example above, it would appear under Node3D, as it is a Node3D subclass.

Community

Join the community on Slack

Description

  • Swift Tools 5.9.0
View More Packages from this Author

Dependencies

Last updated: Sat Apr 20 2024 20:31:22 GMT-0900 (Hawaii-Aleutian Daylight Time)