Zircon Documentation

Welcome to the Zircon documentation! You can pick a topic from the cards below.

Important notice: All documentation pages which you see here are compatible with the latest major release of Zircon. Things might change in a PREVIEW version, so if you are using one, you might find small differences. Docs are updated before a major release so keep this in mind.

If you are not familiar with Zircon yet we recommend to take a look at the Zircon Crash Course first.

If you want to look at the Javadoc / Kdoc go here.

Animation Support

When static images won't cut it there is the built in animation system at your disposal.


Whenever you develop a program you'll eventually bump into some bugs. To debug them you're going to need proper logging.

Release Process and Versioning Scheme

Zircon follows a versioning scheme which is reminiscent to JetBrains' versioning strategy but with a twist.

Resource Handling

Zircon has a lot of built-in things in place but sometimes you want to use external resources. This page explains how to work with them.

Drawing Shapes

Sometimes all you want to do is just drawing shapes onto the screen. This article will teach you how to do so with Zircon.

Input Handling

All this fancy tile graphics and ASCII art is worth nothing if your player's can't interact with your game! In this article we'll learn how to handle Inputs in Zircon!

How Layers Work

If you want to display you TileGraphics on a TileGrid or Screen while still being able to move it around, try Layers!

Working With Color Themes

When you start using Components you'll quickly feel the need to have some uniform way for coloring your Components. Color Themes are the solution for this problem.

The Design Philosophy Behind Zircon

In this document you will explore the main design guidelines behind Zircon.

How to Work With TileGraphics

This document will help you understand how to compose Tiles into in-memory graphics objects.

The Component System

Drawing shapes and tiles by hand is only so much fun. Good thing is that Zircon comes with a full-blown Text GUI interface. This article will explore The Component System in depth.

A Primer on Screens

Wanna learn how to display different TileGrids on your screen at different times? This article explains how to use Screen objects to do so.

A Zircon Crash Course

This Crash Course is all you need to understand how Zircon works.