jobe-m/littlekt

A multiplatform 2D game framework written in Kotlin. Build your own game engine on top.

Currently, in development.

Features - Docs - Dokka / KDocs - Samples - Showcase - Ask a Question - Changelog - Starter Project

A 2D game framework written in Kotlin

LittleKt (Little Kotlin) is a Kotlin multiplatform 2D game development framework based on OpenGL 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

Install

LittleKt releases are hosted on Maven Central and can be installed like so:

build.gradle.kts:

repositories {
    mavenCentral()
}

kotlin {
    jvm {
        compilations.all {
            kotlinOptions.jvmTarget = "11" // littlekt targets jvm 11 so we must target atleast 11
        }
    }
}

val littleKtVersion = "0.7.0" // get the latest release at the top
val kotlinCoroutinesVersion = "1.6.4" // or whatever version you are using

sourceSets {
    val commonMain by getting {
        dependencies {
            implementation("com.lehaine.littlekt:core:$littleKtVersion")
            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:

repositories {
    maven(url = "https://s01.oss.sonatype.org/content/repositories/snapshots/")
}

kotlin {
    jvm {
        compilations.all {
            kotlinOptions.jvmTarget = "11" // littlekt targets jvm 11 so we must target atleast 11
        }
    }
}

val littleKtVersion = "0.5.0.af4fdbf-SNAPSHOT" // or whichever hash you are using
val kotlinCoroutinesVersion = "1.6.0" // or whatever version you are using

sourceSets {
    val commonMain by getting {
        dependencies {
            implementation("com.lehaine.littlekt:core:$littleKtVersion")
            implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:$kotlinCoroutinesVersion")  // littlekt requires coroutines library on the classpath
        }
    }
}

Current targets

Platform	Support	Expected By
Desktop (JVM)	✅	Current version
Web (WebGL/2)	✅	Current version
Android	✅	Current version
iOS / Native	Planned	v1.0

Showcase

Real world examples instead of the samples' repo.

Glutton for Punishment

Source - Play

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 which is the main inspiration of this framework as well as the Kotlin framework KTX for the clever and awesome utilites and extensions built on top of libGDX.

Carlos Velasco's (soywiz) awesome Kotlin game engine 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 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 that allowed LittleKt to get up and running quickly.