• Stars
    star
    217
  • Rank 182,446 (Top 4 %)
  • Language
    C
  • Created over 1 year ago
  • Updated 6 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Embed Godot into Swift apps

SwiftGodotKit provides a way of embedding Godot into an existing Swift application and driving Godot from Swift, without having to use an extension.

Take a look at the TrivialSample here to see how it works.

You will need Swift 5.9 for this (Xcode 15 release candidate will do).

Reference this Package.swift and then you can write a simple program like this:

import Foundation
import SwiftGodot
import SwiftGodotKit

func loadScene (scene: SceneTree) {
    let rootNode = Node3D()
    let camera = Camera3D ()
    camera.current = true
    camera.position = Vector3(x: 0, y: 0, z: 2)
    
    rootNode.addChild(node: camera)
    
    func makeCuteNode (_ pos: Vector3) -> Node {
        let n = SpinningCube()
        n.position = pos
        return n
    }
    rootNode.addChild(node: makeCuteNode(Vector3(x: 1, y: 1, z: 1)))
    rootNode.addChild(node: makeCuteNode(Vector3(x: -1, y: -1, z: -1)))
    rootNode.addChild(node: makeCuteNode(Vector3(x: 0, y: 1, z: 1)))
    scene.root?.addChild(node: rootNode)
}


class SpinningCube: Node3D {
    required init (nativeHandle: UnsafeRawPointer) {
        super.init (nativeHandle: nativeHandle)
    }
    
    required init () {
        super.init ()
        let meshRender = MeshInstance3D()
        meshRender.mesh = BoxMesh()
        addChild(node: meshRender)
    }
    
    override func _input (event: InputEvent) {
        guard event.isPressed () && !event.isEcho () else { return }
        print ("SpinningCube: event: isPressed ")
    }
    
    public override func _process(delta: Double) {
        rotateY(angle: delta)
    }
}

func registerTypes (level: GDExtension.InitializationLevel) {
    switch level {
    case .scene:
        register (type: SpinningCube.self)
    default:
        break
    }
}

runGodot(args: [], initHook: registerTypes, loadScene: loadScene, loadProjectSettings: { settings in })

A standalone sample that you can use as a starting point is available here, when used as SwiftPM:

https://github.com/migueldeicaza/SwiftGodotKit/tree/main/StandaloneExample

Sausage Making Details

If you want to compile your own version of libgodot.framework, follow these instructions

Check out SwiftGodot and SwiftGodotKit as peers as well as a version of Godot suitable to be used as a library:

git clone [email protected]:migueldeicaza/SwiftGodot
git clone [email protected]:migueldeicaza/SwiftGodotKit
git clone [email protected]:migueldeicaza/libgodot

Compile libgodot, this sample shows how I do this myself, but you could have different versions

cd libgodot
scons target=template_debug dev_build=yes library_type=shared_library debug_symbols=yes 

The above will produce the binary that you want, then create an xcframework out of it, using the script in SwiftGodot (a peer to this repository):

cd ../SwiftGodot/scripts
sh -x make-libgodot.xcframework ../../SwiftGodot ../../libgodot /tmp/

Then you can reference that version of the libgodot.xcframework

Details

This relies currently on the LibGodot patch that is currently pending approval:

https://github.com/godotengine/godot/pull/72883

For your convenience, I have packaged the embeddable Godot for Mac as an xcframework so merely taking a dependency on this package should get everything that you need

More Repositories

1

TensorFlowSharp

TensorFlow API for .NET languages
C#
3,138
star
2

SwiftGodot

New Godot bindings for Swift
Swift
1,020
star
3

SwiftTerm

Xterm/VT100 Terminal emulator in Swift
Swift
938
star
4

mono-wasm

JavaScript
527
star
5

TermKit

Terminal Kit - Console UI toolkit for Swift applications
Swift
455
star
6

MonoTouch.Dialog

Tools to simplify creating dialogs with the user using MonoTouch
C#
430
star
7

WasmerSharp

.NET Bindings for the Wasmer Runtime
C#
317
star
8

SwiftTermApp

Swift
304
star
9

PlaticaBot

MacOS, iOS and watchOS ChatGPT client using your own OpenAI key
Swift
189
star
10

TweetStation

MonoTouch based Twitter client
C#
180
star
11

XtermSharp

XTerm emulator as a .NET library
C#
161
star
12

redis-sharp

A C#/.NET binding for the Redis server.
C#
152
star
13

SkiaKit

Swift Bindings to the Skia 2D graphics Library
Swift
134
star
14

TextBufferKit

Swift TextBuffer
Swift
104
star
15

CovidGraphs

Covid Graphs app
Swift
93
star
16

SwiftChatGPT

Simple ChatGPT API
Swift
74
star
17

GodotSwift

Swift bindings for the Godot Game Engine
C
56
star
18

mc

C# based curses file manager
C#
45
star
19

FuchsiaSharp

Bindings to Fuchsia
C#
36
star
20

OpenFlowSharp

Sample CoverFlow implementation for MonoTouch, based on OpenFlow
C#
33
star
21

muget

Command line front end to NuGet that is not overengineered
C#
31
star
22

RealityActions

RealityActions
Swift
27
star
23

monotouch-libs

Various MonoTouch bindings and libraries
C#
25
star
24

TldExtract

.NET Library to extracts the root domain, subdomain name, and top level domain from a host name using the Public Suffix List
C#
22
star
25

SwiftNavigation

C++
19
star
26

SwiftGodotBinary

SwiftGodot - binaries for ease of consumption
Swift
18
star
27

libgodot

Godot modified to be embeddable as a library, for use in SwiftGodotKit
C++
18
star
28

mono-wasm-libc

C
15
star
29

TurboSwift

Swift
14
star
30

mono-wasm-mono

C#
14
star
31

FluidInterfaces

Port of Nathan Gitter's Fluid Interfaces code
C#
14
star
32

MaterialSharp

Material design components for iOS applications written in C#
C#
13
star
33

NetCatNetwork

NetCat implementation using the new Apple Network framework, C# port of the C sample
C#
11
star
34

CovidExtractor

My Covid Extractor
Swift
9
star
35

SwiftGodotDocs

9
star
36

CocoaDriver

Xamarin.Mac-based Cocoa driver for Mono's System.Windows.Forms
C#
8
star
37

Darwin.CopyFile

Bindings for Darwin's CopyFile API
C#
8
star
38

SwiftNavigationDemo

Demo of the SwiftNavigation API
Swift
8
star
39

MonoTouch.Bindings

Some bindings for third party libraries
6
star
40

migueldeicaza

Repository for my README
6
star
41

gtk

Fork of Gtk branch 2-24 with all Xamarin patches from github.com/mono/bockbuild applied
C
5
star
42

KeyboardButton

Simple keyboard button in SwiftUI eventually for use in the Terminal Emulator
Swift
5
star
43

GodotSwiftLink

Binding module, temporary, while I move it to Godot.
C
4
star
44

Mac-SceneKit-Globe-Test

Sample F# Mac app showing SceneKit in action.
F#
4
star
45

PhotoPanner

C# version of Facebooks Photo Panner
C#
4
star
46

Mono.VFS

C# based Virtual File System API.
4
star
47

SimpleCollage

Simple picture collage with SkiaSharp
C#
4
star
48

til

4
star
49

MapWrapper

SwiftUI wrapper around MapKit
Swift
4
star
50

SwiftApiExtractIssue

Shows a bug with swift-api-extract
Swift
3
star
51

RosettaMaker

Creates the Rosetta HTML page that shows the C#/Objective-C/C mappings
C#
3
star
52

KitCore.NET

.NET bindings to KitCore - the ultimate core application framework
3
star
53

SplashView

C# Port of SplashView https://github.com/callumboddy/CBZSplashView
C#
3
star
54

NailedIt

My Google Glasses app to "Capture Moments" and "Nailed it"
Java
3
star
55

FileProvider-ios-crashing

Swift
2
star
56

monotouch-samples

MonoTouch Sample Programs
2
star
57

SwiftSH.binaries

Binary for the SwiftSH framework
C
2
star
58

SkiaKit.binaries

Precompiled binaries for various platforms of the runtime used by SkiaKit (SkiaSharp)
2
star
59

CovidExtractorPM

SwiftPM version of CovidExtractor
Swift
2
star
60

paint-mono

Automatically exported from code.google.com/p/paint-mono
C#
2
star
61

SkiaKitPayloads

Binary payloads directory for the SkiaKit library
Shell
1
star
62

SwiftOnnxMnist

Mnist sample using OnnxRuntime in Swift
C++
1
star
63

TreemapWeb

C#
1
star
64

iptoloc

IP to Location Tools
C#
1
star
65

mlist

Gtk# Mlist widget - managed implementation of a list view (2005 era)
C#
1
star
66

mono-soc-2007

Automatically exported from code.google.com/p/mono-soc-2007
C#
1
star
67

blog-monomac

MonoMac Blog
1
star
68

SwiftDocCPlusPlusBug

Sample of how Swift Docc fails if you use the new Swift C++ interop
Swift
1
star
69

GodotSnippetEditor

A tool to edit Godot documentation code snippets
Swift
1
star
70

SwiftTermDocs

Placeholder to publish the API docs for SwiftTerm
1
star
71

esctest

Mirror from https://gitlab.freedesktop.org/terminal-wg/esctest.git
Python
1
star
72

CoreKitSharp

Bindings to the Ultimate Framework Platform
1
star