Suggest Change / Typo

FAQ

Table of contents:

Are these libraries free?

Yes. All these libraries are dual licensed under MIT and Apache 2.0, except some libraries that I have ported from other languages and were not licensed as MIT, that propagate their own license. But in any case, all the licenses used are free and permissive.

Where can I find the libraries?

I get an error: unable to find library -lGL on Linux

Since linux doesn’t include graphic or audio libraries by default, you might get this error if you try to compile a korge application with ./gradlew runNativeDebug.

> Task :linkDebugExecutableLinuxX64 FAILED
e: /home/parallels/.konan/dependencies/clang-llvm-8.0.0-linux-x86-64/bin/ld.lld invocation reported errors

The /home/parallels/.konan/dependencies/clang-llvm-8.0.0-linux-x86-64/bin/ld.lld command returned non-zero exit code: 1.
output:
ld.lld: error: unable to find library -lGL
ld.lld: error: unable to find library -lGLU
ld.lld: error: unable to find library -lglut
ld.lld: error: unable to find library -lopenal

If you are using Ubuntu or other Debian-based distro, you can execute the following command to install the required libraries:

sudo apt-get -y install freeglut3-dev libopenal-dev

You can find this command in the Targets -> Desktop section.

How do I include these libraries in my multiplatform projects?

The libraries are multiplatform Kotlin projects that uses GRADLE_METADATA to detect supported platforms. They require Gradle 5.5.1 or greater.

settings.gradle

enableFeaturePreview('GRADLE_METADATA')

build.gradle

repositories {
    jcenter()
    maven { url = uri("https://dl.bintray.com/korlibs/korlibs/") }
}
dependencies {
    implementation("com.soywiz.korlibs.klock:klock:1.6.1")
}

How do I include these libraries in my pure-java projects?

build.gradle

dependencies {
    // ...
    implementation("com.soywiz.korlibs.klock:klock-jvm:1.6.1")
}

You might need to disambiguate in some cases:

implementation("com.soywiz.korlibs.klock:klock-jvm:1.6.1") {
    attributes {
        attribute(org.jetbrains.kotlin.gradle.plugin.KotlinPlatformType.attribute, org.jetbrains.kotlin.gradle.plugin.KotlinPlatformType.jvm)
    }
}

Artifacts can’t be resolved

Check that you are using at least Gradle 5.5.1

./gradlew --version

You can update it with:

./gradlew wrapper --gradle-version=5.5.1

Check that you have the repositories set

repositories {
    jcenter()
    maven { url = uri("https://dl.bintray.com/korlibs/korlibs/") }
}

How do I get the current’s device resolution on KorGE?

KorGE doesn’t provide a direct way of getting the device resolution. This is intended to simplify your code. Instead you use a Virtual Resolution, and an Extended Virtual Resolution when your virtual Aspect Ratio doesn’t match the one’s from the device. Similar to OpenGL and some engines default (-1,+1) screen coordinates, but with the dimensions defined by you.

Slack

GitHub

GitHub Sponsors / Donations

OpenCollective

How are issues prioritized?

In normal circumstances, bugs and sponsored tickets coming from sponsors are done first.

There is a Kanban board at GitHub here where you can see the progress and the current prioritization: https://github.com/orgs/korlibs/projects/1

Contributing

This is an Opensource project. That means that it is free of charge, and that you can see, modify and suggest changes to the source code. The whole project stack is opensource, so you can contribute to this project itself, the documentation or even the blog.

Think that this is a huge project that has been initially developed by a single person, and that requires a lot of time. So probably it will have some rough edges. But you can help to improve it!

How can I close a KorGE Game Window programatically?

views.gameWindow.close()

e: Unable to compile C bridges

```shell script sudo apt install libncurses5


### e: This declaration is experimental and its usage must be marked with '@kotlin.time.ExperimentalTime'

/build/platforms/native-desktop/bootstrap.kt: (5, 98): This declaration is experimental and its usage must be marked with ‘@kotlin.time.ExperimentalTime’ or ‘@OptIn(kotlin.time.ExperimentalTime::class)’ ```

If you main entry point of Korge is using @ExperimentalTime or other experimental APIs you have to replace it with @OptIn(ExperimentalClass::class) eg. @OptIn(ExperimentalTime::class).

Contributing to the documentation

Did you find something wrong, misleading or confusing? Or just want to add more content to the documentation?

All the documentation is hosted at github using github pages and jekyll:

https://github.com/korlibs/korlibs.soywiz.com

In order to make it easier to contribute, each page of the documentation contains a pencil link, that sends you to the github page of the documentation to modify the file itself.

How is KorGE pronounced

Since this was not specified from the very beginning, we used up to three different pronunciations for it.

The original pronounciation is like saying Jorge in Spanish but starting with K.

Can you listen it here: