Home

KTX

Welcome to the KTX wiki!

Getting started

If you are unfamiliar with the libGDX framework, check out the official libGDX wiki.

Each KTX module contains a README.md file with a list of features and numerous usage examples. If you are familiar with libGDX, going through the official documentation is a great way to learn KTX.

To create a new KTX project, the gdx-liftoff tool is recommended. You can find instructions on how to generate a Kotlin project with KTX template in the README. If you prefer a concrete example, sample projects generated with gdx-liftoff include:

• ktx-sample-project: includes all KTX modules and the official libGDX extensions. Targets the desktop and mobile platforms.
• ktx-sample-web-project: includes most KTX modules that are at least partially supported by the web platform, as well as the official libGDX extensions. Targets the desktop, mobile and web platforms.

If you are a beginner, @Quillraven's simple KTX game tutorial goes through the basics of the framework and teaches you to create a very simple game with libGDX and KTX.

If you prefer videos, @Quillraven's YouTube series goes through majority of the KTX modules. These tutorials are a bit more advanced. You can find the complete game here.

Unsure if you want to use the framework? Check out the Choosing KTX article.

Additional resources

• The official KTX website with many useful links and open source projects.
• The official sources documentation generated from KTX code via Dokka.
• @jojomickymack's blog about KTX.
• @jojomickymack's demos showcasing various modules of the framework.
• Example applications discussion lists a bunch of links, repositories and posts about the project. It's a good starting point if you're looking for more resources.
• awesome-libgdx repository with links to many useful libGDX tools and libraries.
• gdx-liftoff is a modern libGDX project setup tool that supports KTX project templates.

Getting help

• GitHub Discussions - feel free to start a new discussion if you have any questions about the project.
• question-tagged issues - if you think your problem might require some changes in KTX, create a new issue and we'll do our best to help.
• Official libGDX Discord - an active community of LibGDX developers. You can talk with other KTX users and developers on the #kotlin channel.
• Official Kotlin Slack - an active community of Kotlin developers. Ask your Kotlin-related questions there. You might also find #gamedev and #libgdx channels useful, but keep in mind that the libGDX developers are more active on the Discord.
• StackOverflow tag - if your question is not specific to the KTX features, and you would like to ask both the KTX and libGDX communities, tag your question with both libgdx and libktx.