SwiftGodot

支持平台

SwiftGodot为Godot 4.2游戏引擎提供了Swift语言绑定，使用新的GDExtension系统（对于4.1版本的兼容性，请使用4.1分支，即将发布的4.3版本预览在4.3分支中）。

SwiftGodot可用于构建可添加到现有Godot项目的扩展，其中您的代码为游戏引擎提供服务，也可以与SwiftGodotKit一起用作API，将Godot嵌入为直接由Swift驱动的应用程序。

教程和文档：

社区感兴趣的内容：

使用GodotVision在VisionPro上运行Godot
Godot在Vision上的示例GodotVisionExample

从Swift驱动Godot的优势在于，在MacOS上您可以从Xcode调试您的代码以及Godot代码。

https://user-images.githubusercontent.com/36863/232163186-dc7c0290-71db-49f2-b812-c775c55b8b77.mov

为什么选择SwiftGodot？

不会因GC造成游戏卡顿，与C#不同。
了解更多：Swift Godot：修复价值数百万美元的错误

快速入门

SwiftGodotKick项目可以创建一个带有Swift的GDExtension骨架模板，以及一个独立的SwiftGodotKit项目，可用于在MacOS上快速迭代您的游戏。

支持的平台

目前，SwiftGodot可用于针对iOS、Linux、macOS或Windows平台的项目。可能可以针对其他平台，但目前尚未完成对其他平台的测试，无法验证稳定性。

开发状态

SwiftGodot建立在GDExtension框架之上，该框架仍处于实验状态，因此SwiftGodot也仍处于实验状态。为了修复重大错误或包含关键功能，可能会破坏兼容性。尽管如此，Godot API的大部分表面已经实现，SwiftGodot适用于小型到中型项目。

使用SwiftGodot

使用SwiftGodot有两种方式，您可以在SwiftPM中引用此模块（使用此地址），它将为您触发完整的源代码构建，或者为了在MacOS上快速迭代，您可以使用对等的https://github.com/migueldeicaza/SwiftGodotBinary 中的便捷二进制文件。

目前这需要Swift 5.9或Xcode 15。

使用此存储库

通过从SwiftPM引用此包，您应该就可以开始了，但如果您只想处理绑定生成器，您可能想打开Generator项目并编辑okList变量以缩短构建时间。

从Swift驱动Godot

要从Swift驱动Godot，请使用配套的SwiftGodotKit模块，它将Godot直接嵌入到您的应用程序中，允许您从代码中启动Godot运行时。

创建扩展

创建可在Godot中使用的扩展需要几个组件：

您的Swift代码：这是您发挥魔力的地方
一个.gdextension文件，描述在哪里找到所需的Swift库资源
一些Swift注册代码和引导代码
将您的扩展导入到您的项目中

您的Swift代码

您的Swift代码将被编译成Godot将调用的共享库。要开始，最简单的方法是创建一个引用Swift Godot包的Swift库包，如下所示：

// swift-tools-version: 5.9
import PackageDescription
```swift
让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"])]
)

上述代码将为你编译所有SwiftGodot - 或者，如果你不需要访问源代码，你可以使用SwiftPM的.binaryTarget功能，引用我已经方便地发布在GitHub上的.xcframework：https://github.com/migueldeicaza/SwiftGodotBinary

下一步是创建带有魔法的源文件，这里我们声明了一个旋转的立方体：

import SwiftGodot

@Godot(.tool)
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)
    }
}

此外，你需要为你的项目编写一些胶水代码，以便Godot可以加载它，你可以这样做：

/// 当我们被告知场景正在加载时，我们注册我们的新类型
func setupScene (level: GDExtension.InitializationLevel) {
    if level == .scene {
        register(type: SpinningCube.self)
    }
}

// 导出我们的入口点给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
}

或者，你可以使用#initSwiftExtension宏：

import SwiftGodot

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

打包你的扩展

为了使你的扩展可用于Godot，你需要为所有目标平台构建二进制文件，并创建一个.gdextension文件，列出这些负载以及你上面声明的入口点。

你可以在名为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"

在上面的例子中，扩展始终期望平台特定的负载被称为"MyFirstGame"，不管是什么平台。如果你想将你的扩展分发给其他用户并拥有单一负载，你需要手动为这些设置不同的名称。