diff --git a/README.md b/README.md index ce18ed6b..3612c6e7 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,14 @@ # Kotlin/Native binding for the Godot Game Engine +## Important notes +This project is sunsetted. +The performance of Kotlin Native for the use case of this binding is not where it needs to be to make it viable. + +For now, no further development will take place. You are very welcome though to work on it if you want to, altough it would need to be updated to the newest kotlin version and be migrated to Godot 4 which is no easy task. + +We moved on to develop the [Godot Kotlin/JVM](https://github.com/utopia-rise/godot-kotlin-jvm) binding which leverages an embedded JRE or Graal Native Image instead. This binding works on all major platforms and the performance and tooling is significalty better. Head over there if you want to enjoy working with Kotlin in Godot. + ## Overview This is a **Kotlin** language binding for the [**Godot**](https://godotengine.org/) game engine. It uses [**GDNative**](https://godotengine.org/article/dlscript-here) to interact with **Godot**'s core api's. The binding provides you Godot API's as Kotlin classes, so you can write your game logic completely in Kotlin. It will be compiled into a dynamic library using [*Kotlin/Native*](https://kotlinlang.org/docs/reference/native-overview.html). @@ -10,17 +18,6 @@ You don't have to worry about any binding logic. Just write your game scripts li [![GitHub](https://img.shields.io/github/license/utopia-rise/godot-kotlin?style=flat-square)](LICENSE) [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/utopia-rise/godot-kotlin/CI?style=flat-square)](https://github.com/utopia-rise/godot-kotlin/actions?query=workflow%3ACI) -## Important notes - -This version of the binding is currently in **Alpha** state and by no means production ready! - -This state will not change in the near foreseeable future. The Kotlin Native performance is not where it needs to be to make this binding efficient. Currently, the build times are incredibly slow due to the lack of incremental build support in Kotlin Native. Also, the runtime performance is much slower than GDScript in many cases. -The only case where this binding shines at the moment is in computation heavy scenarios like implementing an A* pathfinding algorithm where not many calls through the cinterop layer of K/N are necessary. In all other cases were many calls are needed, like Input checking and small logic in function like `_process`, the performance is not great because of the current performance of the K/N cinterop layer. -We were and are in touch with JB regarding those issues on youtrack and slack: [KT-40652](https://youtrack.jetbrains.com/issue/KT-40652) and [KT-40679](https://youtrack.jetbrains.com/issue/KT-40679) - -To still be able to use kotlin in a performant way, we started another project [(godot-jvm)](https://github.com/utopia-rise/godot-jvm/) which leverages an embedded JVM to use kotlin on the JVM rather than native. On our first tests, this increases performance dramatically and one can leverage the full JVM ecosystem. Head over there to see development updates. -This binding will not die though. We will provide bugfixes for existing bugs if necessary, keep it as up to date as our time allows us to do, but we will not improve tooling or add new features until the performance of K/N is more acceptable. - ## Documentation One can find the documentation for this binding [here](https://godot-kotl.in).