Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tayloraswift/godot-swift
swift language support for the godot game engine
https://github.com/tayloraswift/godot-swift
godot godot-nativescript godot-swift swift
Last synced: 16 days ago
JSON representation
swift language support for the godot game engine
- Host: GitHub
- URL: https://github.com/tayloraswift/godot-swift
- Owner: tayloraswift
- Created: 2021-03-16T23:26:13.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-04-03T06:44:56.000Z (over 2 years ago)
- Last Synced: 2024-08-06T23:51:44.881Z (3 months ago)
- Topics: godot, godot-nativescript, godot-swift, swift
- Language: Swift
- Homepage:
- Size: 181 MB
- Stars: 116
- Watchers: 7
- Forks: 5
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Swift for Godot
0.1.0
*Godot Swift* is a [Swift Package Manager](https://swift.org/package-manager/) plugin that builds and packages Swift projects as [Godot Native](https://docs.godotengine.org/en/latest/tutorials/scripting/gdnative/what_is_gdnative.html) libraries.
```swift
final
class MySwiftClass:Godot.NativeScript
{
var foo:Int = 5
init(delegate _:Godot.Unmanaged.Spatial)
{
}
func bar(delegate _:Godot.Unmanaged.Spatial, x:Int) -> Int
{
self.foo * x
}
@Interface
static var interface:Interface
{
Interface.properties
{
\.foo <- "foo"
}
Interface.methods
{
bar(delegate:x:) <- "bar"
}
}
}
extension Godot.Library
{
@Interface
static var interface:Interface
{
MySwiftClass.self <- "MyExportedSwiftClass"
}
}
```
### getting started
*Godot Swift* uses the experimental Swift [package plugins](https://github.com/apple/swift-evolution/blob/main/proposals/0303-swiftpm-extensible-build-tools.md) feature, which is currently only available in recent [nightly Swift toolchains](https://swift.org/download/#snapshots). Because this feature is in active development, we *strongly recommend* using the following Swift toolchain version to avoid compilation issues:
* **`DEVELOPMENT-SNAPSHOT-2021-06-01-a`**
We recommend using [`swiftenv`](https://github.com/kylef/swiftenv) to manage multiple Swift toolchain installations. You can install a custom toolchain using `swiftenv` by passing the `swiftenv install` command the url of the toolchain on [swift.org](https://swift.org).
For example, to install the `2021-06-01-a` snapshot on Ubuntu 20.04 x86_64, run:
```bash
swiftenv install \
https://swift.org/builds/development/ubuntu2004/swift-DEVELOPMENT-SNAPSHOT-2021-06-01-a/swift-DEVELOPMENT-SNAPSHOT-2021-06-01-a-ubuntu20.04.tar.gz
```
*Godot Swift* builds native libraries for [**Godot 3.3.0**](https://downloads.tuxfamily.org/godotengine/).
> **Warning:** Although *Godot Swift* libraries should be compatible with later Godot versions, we *strongly recommend* using Godot 3.3.0 to avoid unrecognized-symbol errors at runtime.
To use *Godot Swift* in a project, add it as a dependency in `Package.swift`, and add the `GodotNative` module and the `GodotNativeScript` plugin to your build target.
```swift
// swift-tools-version:5.5
import PackageDescription
let package = Package(
name: "example",
products:
[
.library(name: "godot-swift-example", type: .dynamic,
targets:
[
"GodotSwiftExample"
])
],
dependencies:
[
.package(url: "https://github.com/kelvin13/godot-swift/", .branch("master"))
],
targets:
[
.target(name: "GodotSwiftExample",
dependencies:
[
.product(name: "GodotNative", package: "godot-swift")
],
plugins:
[
.plugin(name: "GodotNativeScript", package: "godot-swift")
])
]
)
```
### [tutorials and example programs](examples/)
1. [basic usage](examples#basic-usage) ([`sources`](examples/swift/basic-usage.swift))
2. [advanced methods](examples#advanced-methods) ([`sources`](examples/swift/advanced-methods.swift))
3. [advanced properties](examples#advanced-properties) ([`sources`](examples/swift/advanced-properties.swift))
4. [signals](examples#signals) ([`sources`](examples/swift/signals.swift))
5. [life cycle management](examples#life-cycle-management) ([`sources`](examples/swift/life-cycle-management.swift))
6. [using custom types](examples#using-custom-types) ([`sources`](examples/swift/custom-types.swift))
### [api reference](https://kelvin13.github.io/godot-swift/)
* [`Godot`](https://kelvin13.github.io/godot-swift/Godot)
* [`Godot.Library`](https://kelvin13.github.io/godot-swift/Godot/Library)
* [`Godot.NativeScript`](https://kelvin13.github.io/godot-swift/Godot/NativeScript)
### [math library reference](https://kelvin13.github.io/godot-swift/)
* [`Vector`](https://kelvin13.github.io/godot-swift/Vector)
* [`Vector.Plane`](https://kelvin13.github.io/godot-swift/Vector/Plane)
* [`Vector.Rectangle`](https://kelvin13.github.io/godot-swift/Vector/Rectangle)
* [`Vector.ClosedRectangle`](https://kelvin13.github.io/godot-swift/Vector/ClosedRectangle)
* [`Quaternion`](https://kelvin13.github.io/godot-swift/Quaternion)