Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/littlektframework/littlekt
A multiplatform WebGPU 2D game framework written in Kotlin. Build your own game engine on top.
https://github.com/littlektframework/littlekt
2d 2d-game-framework android desktop framework game game-engine game-framework gamedev html5 ios kotlin kotlin-multiplatform linux macos mobile multiplatform opengl webgpu windows
Last synced: about 1 month ago
JSON representation
A multiplatform WebGPU 2D game framework written in Kotlin. Build your own game engine on top.
- Host: GitHub
- URL: https://github.com/littlektframework/littlekt
- Owner: littlektframework
- License: apache-2.0
- Created: 2021-12-28T00:46:57.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-28T12:54:10.000Z (4 months ago)
- Last Synced: 2024-08-28T14:04:39.912Z (4 months ago)
- Topics: 2d, 2d-game-framework, android, desktop, framework, game, game-engine, game-framework, gamedev, html5, ios, kotlin, kotlin-multiplatform, linux, macos, mobile, multiplatform, opengl, webgpu, windows
- Language: Kotlin
- Homepage: https://littlekt.com
- Size: 73 MB
- Stars: 310
- Watchers: 8
- Forks: 13
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - littlektframework/littlekt - A multiplatform WebGPU 2D game framework written in Kotlin. Build your own game engine on top. (Kotlin)
README
[](https://littlekt.com)
[](https://github.com/littlektframework/littlekt/blob/master/LICENSE)
[](https://github.com/littlektframework/littlekt/actions/workflows/build.yml)
[](https://search.maven.org/artifact/com.littlekt/core/0.10.1/pom)
Requires JDK 21+ in order to use due to the usage of the new Java FFM API.
**Currently, in development.**
[Features](https://littlekt.com/features/) - [Docs](https://littlekt.com/docs/) - [Dokka / KDocs](https://littlekt.com/dokka/) - [Samples](https://github.com/littlektframework/littlekt-samples) -
[Showcase](#showcase) - [Ask a Question](https://github.com/littlektframework/littlekt/discussions/categories/q-a) - [Changelog](CHANGELOG.md) - [Starter Project](https://github.com/littlektframework/littlekt-game-template)
## A 2D game framework written in Kotlin
**LittleKt (Little Kotlin) is a Kotlin multiplatform 2D game development framework based on WebGPU** that is inspired by
libGDX and KorGE. The goal of this project is to allow the freedom and flexibility that libGDX offers with enjoyable
idiomatic features coded in Kotlin that KorGE has to offer.
Check out some planned [features](https://github.com/littlektframework/littlekt/labels/enhancement)
If you are looking for the **OpenGL** version, check out
this [branch](https://github.com/littlektframework/littlekt/tree/opengl). Note: this branch is deprecated.
### Install
LittleKt releases are hosted on Maven Central and can be installed like so:
**build.gradle.kts**:
```kotlin
repositories {
mavenCentral()
}
kotlin {
jvm {
compilations.all {
kotlinOptions.jvmTarget = "21" // littlekt targets jvm 21 so we must target at least 21
}
}
}
val littleKtVersion = "0.10.1" // get the latest release at the top
val kotlinCoroutinesVersion = "1.9.0-RC" // or whatever version you are using
sourceSets {
val commonMain by getting {
dependencies {
implementation("com.littlekt:core:$littleKtVersion")
implementation("com.littlekt:scene-graph:$littleKtVersion") // optional scene-graph module
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:$kotlinCoroutinesVersion") // littlekt requires coroutines library on the classpath
}
}
}
```
### Snapshots
On every build a snapshot gets created. If you want to be on the bleeding edge then you can pull from the snapshot repo.
The snapshot versioning uses commit hashes as a suffix. The version convention looks like so: `x.x.x.hash-SNAPSHOT`.
E.g `0.2.1.080b1ad-SNAPSHOT`.
**Note**: this will most likely cause breaking changes
**build.gradle.kts**:
```kotlin
repositories {
maven(url = "https://s01.oss.sonatype.org/content/repositories/snapshots/")
}
kotlin {
jvm {
compilations.all {
kotlinOptions.jvmTarget = "21" // littlekt targets jvm 21 so we must target at least 17
}
}
}
val littleKtVersion = "0.10.0.a9529eb-SNAPSHOT" // or whichever hash you are using
val kotlinCoroutinesVersion = "1.9.0-RC" // or whatever version you are using
sourceSets {
val commonMain by getting {
dependencies {
implementation("com.littlekt:core:$littleKtVersion")
implementation("com.littlekt:scene-graph:$littleKtVersion") // optional scene-graph module
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:$kotlinCoroutinesVersion") // littlekt requires coroutines library on the classpath
}
}
}
```
### Current targets
| Platform | Support | Implementation | Expected By |
|---------------|:--------------------------------------------------------------------------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------|----------------:|
| Desktop (JVM) | ✅ | [wgpu-native](https://github.com/gfx-rs/wgpu-native) via [FFM](https://docs.oracle.com/en/java/javase/21/core/foreign-function-and-memory-api.html) | Current version |
| Web (JS) | ✅ | [webgpu](https://www.w3.org/TR/webgpu/) | Current version |
| Android | [In Progress](https://github.com/littlektframework/littlekt/tree/webgpu-android) | Planned: [wgpu-native](https://github.com/gfx-rs/wgpu-native) via JNI | v1.0 |
| iOS / Native | Planned | Planned: [wgpu-native](https://github.com/gfx-rs/wgpu-native) | v1.0 |
### Showcase
Real world examples instead of the [samples'](https://github.com/littlektframework/littlekt-samples) repo.
#### Glutton for Punishment
**[Source](https://github.com/LeHaine/ggo2022)** - **[Play](https://lehaine.itch.io/glutton-for-punishment)**
### Acknowledgements
LittleKt was put together based on bits and pieces of features found across multiple engines/frameworks and languages
that were very enjoyable to use and flexible. If a piece a code looks familiar, feel free to open an issue with details,
so that we can properly attribute the code.
A big thanks to the folks over on libGDX and KTX, KorGE, and MiniGDX.
The very popular and amazing [libGDX](https://github.com/libgdx/libgdx) which is the main inspiration of this framework
as well as the Kotlin framework [KTX](https://github.com/libktx/ktx) for the clever and awesome utilites and extensions
built on top of libGDX.
Carlos Velasco's (soywiz) awesome Kotlin game engine [KorGE](https://github.com/korlibs/korge) which has a bunch of very
enjoyable features and awesome ideas that were brought over to be used in LittleKt.
Max Thiele's (fabmax) incredible Kotlin OpenGL/Vulkan graphics engine [kool](https://github.com/fabmax/kool) where many
features were shamelessly copied and brought over as well which helped get many graphics related features working and
allowed me to understand how it worked.
David Wursteisen's excellent multiplatform game framework [MiniGDX](https://github.com/minigdx/minigdx/) that allowed
LittleKt to get up and running quickly.