Revision as of 10:54, 14 October 2018

Zircon - A user-friendly Text GUI & Tile Engine <a href="https://twitter.com/intent/tweet?text=Do%20you%20plan%20to%20make%20a%20roguelike%3F%20Look%20no%20further.%20Zircon%20is%20the%20right%20tool%20for%20the%20job.&url=https://github.com/Hexworks/zircon&hashtags=games,roguelikes" rel="nofollow"><img src="https://camo.githubusercontent.com/83d4084f7b71558e33b08844da5c773a8657e271/68747470733a2f2f696d672e736869656c64732e696f2f747769747465722f75726c2f687474702f736869656c64732e696f2e7376673f7374796c653d736f6369616c" alt="Tweet" data-canonical-src="https://img.shields.io/twitter/url/http/shields.io.svg?style=social" style="max-width:100%;"></a>

Zircon
Library project
Developer	Adam Arold
Released	July 9 2017
Updated	Dec 23 2017 (Stable), Mar 22 2018 (Preview)
Status	Stable
Licensing	MIT License
P. Language	Kotlin, Java
Platforms	Linux, Mac OS, Windows
Dependencies
	Official site of Zircon

Note that this library was inspired by <a href="https://github.com/mabe02/lanterna">Lanterna</a>. Check it out if you are looking for a terminal emulator instead.

Need info? Check the <a href="https://github.com/Hexworks/zircon/wiki">Wiki</a> | or <a href="https://github.com/Hexworks/zircon/issues/new">Create an issue</a> | Check <a href="https://github.com/Hexworks/zircon/projects/2">our project Board</a> | <a href="https://discord.gg/hbzytQJ" rel="nofollow">Ask us on Discord</a> | Support us on <a href="https://www.patreon.com/hexworks" rel="nofollow">Patreon</a>

>Table of Contents

<a href="https://github.com/Hexworks/zircon#getting-started">Getting Started</a>
- <a href="https://github.com/Hexworks/zircon#some-rules-of-thumb">Some rules of thumb</a>
- <a href="https://github.com/Hexworks/zircon#creating-an-application">Creating an Application</a>
- <a href="https://github.com/Hexworks/zircon#working-with-screens">Working with Screens</a>
- <a href="https://github.com/Hexworks/zircon#components">Components</a>
- <a href="https://github.com/Hexworks/zircon#additional-features">Additional features</a>
  - <a href="https://github.com/Hexworks/zircon#layering">Layering</a>
  - <a href="https://github.com/Hexworks/zircon#input-handling">Input handling</a>
  - <a href="https://github.com/Hexworks/zircon#shape-and-box-drawing">Shape and box drawing</a>
  - <a href="https://github.com/Hexworks/zircon#fonts-and-tilesets">Fonts and tilesets</a>
  - <a href="https://github.com/Hexworks/zircon#rexpaint-file-loading">REXPaint file loading</a>
  - <a href="https://github.com/Hexworks/zircon#color-themes">Color themes</a>
  - <a href="https://github.com/Hexworks/zircon#animations-beta">Animations (BETA)</a>
  - <a href="https://github.com/Hexworks/zircon#the-api">The API</a>
<a href="https://github.com/Hexworks/zircon#road-map">Road map</a>
<a href="https://github.com/Hexworks/zircon#license">License</a>
<a href="https://github.com/Hexworks/zircon#credits">Credits</a>

<a id="user-content-getting-started" class="anchor" aria-hidden="true" href="#getting-started"> <svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"> <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path> </svg> </a>Getting Started

If you want to work with Zircon you can add it to your project as a dependency.

from Maven:

<<span
            class="pl-ent">dependency</span>>
    <<span class="pl-ent">groupId</span>>com.github.hexworks.zircon</<span class="pl-ent">groupId</span>>
    <<span class="pl-ent">artifactId</span>>zircon.jvm.swing</<span class="pl-ent">artifactId</span>>
    <<span class="pl-ent">version</span>>2018.3.27-PREVIEW</<span class="pl-ent">version</span>>
</<span class="pl-ent">dependency</span>>

or you can also use Gradle:

compile(<span class="pl-s"><span class="pl-pds">"</span>com.github.hexworks.zircon:zircon.jvm.swing:2018.3.27-PREVIEW<span
                                            class="pl-pds">"</span></span>)

Note that you need to use <a href="https://jitpack.io/#Hexworks/Zircon" rel="nofollow">Jitpack</a> for the above dependencies to work.

Want to use a PREVIEW? Check <a href="https://github.com/Hexworks/zircon/wiki/Release-process-and-versioning-scheme#snapshot-releases">this Wiki page</a>

<a id="user-content-some-rules-of-thumb" class="anchor" aria-hidden="true" href="#some-rules-of-thumb"> <svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"> <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path> </svg> </a>Some rules of thumb

Before we start there are some guidelines which can help you if you are stuck:

If you want to build something (a TileGraphics, a Component or anything which is part of the public API) it is almost sure that there is a Builder or a Factory for it. The convention is that if you want to create an TileGraphics for example, then you can use the DrawSurfaces class to do so. (so it is the plural form of the thing which you want to build). Your IDE will help you with this. These classes reside in the org.hexworks.zircon.api package.
If you want to work with external files like tilesets or REXPaint files check the same package (org.hexworks.zircon.api), and look for classes which end with *Resources. There are a bunch of built-in tilesets for example which you can choose from but you can also load your own. The rule of thumb is that if you need something external there is probably a *Resources class for it (like the <a href="https://github.com/Hexworks/zircon/blob/master/zircon.jvm/src/main/kotlin/org/hexworks/zircon/api/CP437TilesetResources.kt">CP437TilesetResources</a>).
You can use anything you can find in the <a href="https://github.com/Hexworks/zircon/tree/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api">API</a> package, they are part of the public API, and safe to use. The <a href="https://github.com/Hexworks/zircon/tree/master/zircon.core/src/main/kotlin/org/hexworks/zircon/internal">internal</a> package however is considered private to Zircon so don't depend on anything in it.
Some topics are explained in depth on the <a href="https://github.com/Hexworks/zircon/wiki">Wiki</a>
If you want to see some example code look <a href="https://github.com/Hexworks/zircon/tree/master/zircon.examples/src/main">here</a>.
If all else fails read the javadoc. API classes are well documented.
If you have any problems which are not answered here feel free to ask us at the <a href="https://discord.gg/hbzytQJ" rel="nofollow">Hexworks Discord server</a>.

<a id="user-content-creating-an-application" class="anchor" aria-hidden="true" href="#creating-an-application"> <svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"> <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path> </svg> </a>Creating an Application

In Zircon almost every object you might want to use has a helper class for building it. This is the same for <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/application/Application.kt">Application</a>s as well so let's create one using the <a href="https://github.com/Hexworks/zircon/blob/master/zircon.jvm.swing/src/main/kotlin/org/hexworks/zircon/api/SwingApplications.kt">SwingApplications</a> class:

Note that these examples reside in the org.hexworks.zircon.examples.docs package in the zircon.examples project, you can try them all out.

<span class="pl-k">import</span> <span
            class="pl-smi">org.hexworks.zircon.api.SwingApplications</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.application.Application</span>;

<span class="pl-k">public</span> <span class="pl-k">class</span> <span class="pl-en">CreatingAnApplication</span> {

    <span class="pl-k">public</span> <span class="pl-k">static</span> <span class="pl-k">void</span> <span
                class="pl-en">main</span>(<span class="pl-k">String</span>[] <span
                class="pl-v">args</span>) {

        <span class="pl-smi">Application</span> application <span class="pl-k">=</span> <span class="pl-smi">SwingApplications</span><span
                class="pl-k">.</span>startApplication();
    }
}

Running this snippet will result in this screen:

Not very useful, is it? So what happens here? An <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/application/Application.kt">Application</a> is just an object which has a <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/internal/renderer/Renderer.kt">Renderer</a> for rendering <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/data/Tile.kt">Tile</a>s on your screen), and a <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/grid/TileGrid.kt">TileGrid</a>, which is the main interface which you will use to interact with Zircon. An <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/application/Application.kt">Application</a> is responsible for continuously rendering the contents of the grid on the screen. Here we use the Swing variant, but there are other types in the making (one for LibGDX, and one which works in the browser).

Since most of the time you don't care about the <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/application/Application.kt">Application</a> itself, there is a function for creating a <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/grid/TileGrid.kt">TileGrid</a> directly:

<span class="pl-k">import</span> <span
            class="pl-smi">org.hexworks.zircon.api.SwingApplications</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.grid.TileGrid</span>;

<span class="pl-k">public</span> <span class="pl-k">class</span> <span class="pl-en">CreatingATileGrid</span> {

    <span class="pl-k">public</span> <span class="pl-k">static</span> <span class="pl-k">void</span> <span
                class="pl-en">main</span>(<span class="pl-k">String</span>[] <span
                class="pl-v">args</span>) {

        <span class="pl-smi">TileGrid</span> tileGrid <span class="pl-k">=</span> <span
                class="pl-smi">SwingApplications</span><span class="pl-k">.</span>startTileGrid();
    }
}

Now let's see how we can specify how a <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/grid/TileGrid.kt">TileGrid</a> is created. We'll use the <a href="https://github.com/Hexworks/zircon/blob/master/zircon.jvm/src/main/kotlin/org/hexworks/zircon/api/AppConfigs.kt">AppConfigs</a> helper for this:

<span class="pl-k">import</span> <span
            class="pl-smi">org.hexworks.zircon.api.AppConfigs</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.CP437TilesetResources</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.Sizes</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.SwingApplications</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.grid.TileGrid</span>;

<span class="pl-k">public</span> <span class="pl-k">class</span> <span class="pl-en">CreatingATileGrid</span> {

    <span class="pl-k">public</span> <span class="pl-k">static</span> <span class="pl-k">void</span> <span
                class="pl-en">main</span>(<span class="pl-k">String</span>[] <span
                class="pl-v">args</span>) {

        <span class="pl-smi">TileGrid</span> tileGrid <span class="pl-k">=</span> <span
                class="pl-smi">SwingApplications</span><span class="pl-k">.</span>startTileGrid(
                <span class="pl-smi">AppConfigs</span><span class="pl-k">.</span>newConfig()
                        .defaultSize(<span class="pl-smi">Sizes</span><span class="pl-k">.</span>create(<span
                class="pl-c1">10</span>, <span class="pl-c1">10</span>))
                        .defaultTileset(<span class="pl-smi">CP437TilesetResources</span><span class="pl-k">.</span>rexPaint16x16())
                        .build());
    }
}

Adding and formatting <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/data/Tile.kt">Tile</a>s is very simple:

<span class="pl-k">import</span> <span
            class="pl-smi">org.hexworks.zircon.api.AppConfigs</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.CP437TilesetResources</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.Positions</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.Sizes</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.SwingApplications</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.Tiles</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.color.ANSITileColor</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.grid.TileGrid</span>;

<span class="pl-k">public</span> <span class="pl-k">class</span> <span class="pl-en">CreatingATileGrid</span> {

    <span class="pl-k">public</span> <span class="pl-k">static</span> <span class="pl-k">void</span> <span
                class="pl-en">main</span>(<span class="pl-k">String</span>[] <span
                class="pl-v">args</span>) {

        <span class="pl-smi">TileGrid</span> tileGrid <span class="pl-k">=</span> <span
                class="pl-smi">SwingApplications</span><span class="pl-k">.</span>startTileGrid(
                <span class="pl-smi">AppConfigs</span><span class="pl-k">.</span>newConfig()
                        .defaultSize(<span class="pl-smi">Sizes</span><span class="pl-k">.</span>create(<span
                class="pl-c1">10</span>, <span class="pl-c1">10</span>))
                        .defaultTileset(<span class="pl-smi">CP437TilesetResources</span><span class="pl-k">.</span>rexPaint16x16())
                        .build());

        tileGrid<span class="pl-k">.</span>setTileAt(
                <span class="pl-smi">Positions</span><span class="pl-k">.</span>create(<span
                class="pl-c1">2</span>, <span class="pl-c1">3</span>),
                <span class="pl-smi">Tiles</span><span class="pl-k">.</span>newBuilder()
                        .backgroundColor(<span class="pl-smi">ANSITileColor</span><span class="pl-c1"><span
                class="pl-k">.</span>CYAN</span>)
                        .foregroundColor(<span class="pl-smi">ANSITileColor</span><span class="pl-c1"><span
                class="pl-k">.</span>WHITE</span>)
                        .character(<span class="pl-s"><span class="pl-pds">'</span>x<span class="pl-pds">'</span></span>)
                        .build());

        tileGrid<span class="pl-k">.</span>setTileAt(
                <span class="pl-smi">Positions</span><span class="pl-k">.</span>create(<span
                class="pl-c1">3</span>, <span class="pl-c1">4</span>),
                <span class="pl-smi">Tiles</span><span class="pl-k">.</span>newBuilder()
                        .backgroundColor(<span class="pl-smi">ANSITileColor</span><span class="pl-c1"><span
                class="pl-k">.</span>RED</span>)
                        .foregroundColor(<span class="pl-smi">ANSITileColor</span><span class="pl-c1"><span
                class="pl-k">.</span>GREEN</span>)
                        .character(<span class="pl-s"><span class="pl-pds">'</span>y<span class="pl-pds">'</span></span>)
                        .build());

        tileGrid<span class="pl-k">.</span>setTileAt(
                <span class="pl-smi">Positions</span><span class="pl-k">.</span>create(<span
                class="pl-c1">4</span>, <span class="pl-c1">5</span>),
                <span class="pl-smi">Tiles</span><span class="pl-k">.</span>newBuilder()
                        .backgroundColor(<span class="pl-smi">ANSITileColor</span><span class="pl-c1"><span
                class="pl-k">.</span>BLUE</span>)
                        .foregroundColor(<span class="pl-smi">ANSITileColor</span><span class="pl-c1"><span
                class="pl-k">.</span>MAGENTA</span>)
                        .character(<span class="pl-s"><span class="pl-pds">'</span>z<span class="pl-pds">'</span></span>)
                        .build());
    }
}

Running the above code will result in something like this:

As you can see there is a helper for every class which you might want to use. Here we used Positions.create to create a <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/data/Position.kt">Position</a>, Sizes.create for creating <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/data/Size.kt">Size</a>s and the <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/builder/data/TileBuilder.kt">TileBuilder</a> to create tiles.

A Position denotes a coordinate on a TileGrid, so for example a Position of (3, 4) points to the 3rd column and the 4th row (x, y) on the grid.

Conversely a Size denotes an area with a width and a height. These two classes are used throughout Zircon.

A <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/data/Tile.kt">Tile</a> is the most basic graphical unit Zircon supports. In most cases it is a simple character with a foreground and a background color (like in the example above).

In addition to colors and characters you can also use <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/modifier/Modifier.kt">Modifier</a>s in your <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/data/Tile.kt">Tile</a>s.

A lot of fancy stuff can be done with <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/modifier/Modifier.kt">Modifier</a>s, like this:

<a target="_blank" rel="noopener noreferrer" href="https://camo.githubusercontent.com/adcb972ba57d23f7b92443f4723a61e91b04c6b5/68747470733a2f2f63646e2e646973636f72646170702e636f6d2f6174746163686d656e74732f3336333737313633313732373830343431362f3437373437303638333531333838303537362f6d6f646966696572732e676966"><img src="https://camo.githubusercontent.com/adcb972ba57d23f7b92443f4723a61e91b04c6b5/68747470733a2f2f63646e2e646973636f72646170702e636f6d2f6174746163686d656e74732f3336333737313633313732373830343431362f3437373437303638333531333838303537362f6d6f646966696572732e676966" alt="" data-canonical-src="" style="max-width:100%;"></a>

If interested check out the code examples <a href="https://github.com/Hexworks/zircon/tree/master/zircon.examples/src/main">here</a>.

Tileset (and by extension resource) handling in Zircon is very simple and if you are interested in how to load your custom fonts and other resources take a look at the <a href="https://github.com/Hexworks/zircon/wiki/Resource-Handling">Resource handling wiki page</a>.

<a id="user-content-working-with-screens" class="anchor" aria-hidden="true" href="#working-with-screens"> <svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"> <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path> </svg> </a>Working with Screens

<a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/grid/TileGrid.kt">TileGrid</a>s alone won't suffice if you want to get any serious work done since they are rather rudimentary.

A <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/screen/Screen.kt">Screen</a> has its own buffer and it can be displayed on a <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/grid/TileGrid.kt">TileGrid</a> any time. This means that you can have multiple <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/screen/Screen.kt">Screen</a>s at the same time representing your actual game screens. Note that only one <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/screen/Screen.kt">Screen</a> can be displayed at a given moment. displaying one deactivates the previous <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/screen/Screen.kt">Screen</a>.

Let's create a <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/screen/Screen.kt">Screen</a> and fill it up with some stuff:

<span class="pl-k">import</span> <span
            class="pl-smi">org.hexworks.zircon.api.AppConfigs</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.CP437TilesetResources</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.ColorThemes</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.Positions</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.Screens</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.Sizes</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.SwingApplications</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.DrawSurfaces</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.Tiles</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.component.ColorTheme</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.graphics.TileGraphics</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.grid.TileGrid</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.screen.Screen</span>;

<span class="pl-k">public</span> <span class="pl-k">class</span> <span class="pl-en">CreatingAScreen</span> {

    <span class="pl-k">public</span> <span class="pl-k">static</span> <span class="pl-k">void</span> <span
                class="pl-en">main</span>(<span class="pl-k">String</span>[] <span
                class="pl-v">args</span>) {

        <span class="pl-smi">TileGrid</span> tileGrid <span class="pl-k">=</span> <span
                class="pl-smi">SwingApplications</span><span class="pl-k">.</span>startTileGrid(
                <span class="pl-smi">AppConfigs</span><span class="pl-k">.</span>newBuilder()
                        .defaultSize(<span class="pl-smi">Sizes</span><span class="pl-k">.</span>create(<span
                class="pl-c1">20</span>, <span class="pl-c1">8</span>))
                        .defaultTileset(<span class="pl-smi">CP437TilesetResources</span><span class="pl-k">.</span>wanderlust16x16())
                        .build());

        <span class="pl-k">final</span> <span class="pl-smi">Screen</span> screen <span class="pl-k">=</span> <span
                class="pl-smi">Screens</span><span class="pl-k">.</span>createScreenFor(tileGrid);

        <span class="pl-k">final</span> <span class="pl-smi">ColorTheme</span> theme <span class="pl-k">=</span> <span
                class="pl-smi">ColorThemes</span><span class="pl-k">.</span>adriftInDreams();

        <span class="pl-k">final</span> <span class="pl-smi">TileGraphics</span> image <span class="pl-k">=</span> <span
                class="pl-smi">DrawSurfaces</span><span class="pl-k">.</span>tileGraphicsBuilder()
                .size(tileGrid<span class="pl-k">.</span>size)
                .build()
                .fill(<span class="pl-smi">Tiles</span><span class="pl-k">.</span>newBuilder()
                        .foregroundColor(theme<span class="pl-k">.</span>getBrightForegroundColor())
                        .backgroundColor(theme<span class="pl-k">.</span>getBrightBackgroundColor())
                        .character(<span class="pl-s"><span class="pl-pds">'</span>~<span class="pl-pds">'</span></span>)
                        .build());

        screen<span class="pl-k">.</span>draw(image, <span class="pl-smi">Positions</span><span class="pl-k">.</span>defaultPosition());

        screen<span class="pl-k">.</span>display();
    }
}

and we've got a nice ocean:

What happens here is that we:

Create a <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/screen/Screen.kt">Screen</a>
Fetch a nice <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/component/ColorTheme.kt">ColorTheme</a> which has colors we need
Create a <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/graphics/TileGraphics.kt">TileGraphics</a> with the colors added and fill it with ~s
Draw the graphic onto the <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/screen/Screen.kt">Screen</a>

For more explanation about these jump to the <a href="https://github.com/Hexworks/zircon#how-zircon-works">How Zircon works</a> section.

You can do so much more with <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/screen/Screen.kt">Screen</a>s. If interested then check out <a href="https://github.com/Hexworks/zircon/wiki/A-primer-on-Screens">A primer on Screens</a> on the Wiki!

<a id="user-content-components" class="anchor" aria-hidden="true" href="#components"> <svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"> <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path> </svg> </a>Components

Zircon supports a bunch of <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/component/Component.kt">Component</a>s out of the box:

Button: A simple clickable component with corresponding event listeners
CheckBox: Like a BUTTON but with checked / unchecked state
Label: Simple component with text
Header: Like a label but this one has emphasis (useful when using <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/component/ColorTheme.kt">ColorTheme</a>s)
Panel: A <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/component/Container.kt">Container</a> which can hold multiple <a href="https://github.com/Hexworks/zircon/wiki/The-component-system">Components</a>
RadioButtonGroup and RadioButton: Like a CheckBox but only one can be selected at a time
TextBox: Similar to a text area in HTML this <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/component/Component.kt">Component</a> can be written into

These components are rather simple and you can expect them to work in a way you might be familiar with:

You can click on them (press and release are different events)
You can attach event listeners on them
Zircon implements focus handling so you can navigate between the components using the [Tab] key (forwards) or the [Shift]+[Tab] key stroke (backwards).
Components can be hovered and they can change their styling when you do so

Let's look at an example (notes about how it works are in the comments):

<span class="pl-k">import</span> <span
            class="pl-smi">org.hexworks.zircon.api.*</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.component.Button</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.component.CheckBox</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.component.Header</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.component.Panel</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.grid.TileGrid</span>;
<span class="pl-k">import</span> <span class="pl-smi">org.hexworks.zircon.api.screen.Screen</span>;

<span class="pl-k">public</span> <span class="pl-k">class</span> <span class="pl-en">UsingComponents</span> {

    <span class="pl-k">public</span> <span class="pl-k">static</span> <span class="pl-k">void</span> <span
                class="pl-en">main</span>(<span class="pl-k">String</span>[] <span
                class="pl-v">args</span>) {

        <span class="pl-k">final</span> <span class="pl-smi">TileGrid</span> tileGrid <span class="pl-k">=</span> <span
                class="pl-smi">SwingApplications</span><span class="pl-k">.</span>startTileGrid(
                <span class="pl-smi">AppConfigs</span><span class="pl-k">.</span>newConfig()
                        .defaultSize(<span class="pl-smi">Sizes</span><span class="pl-k">.</span>create(<span
                class="pl-c1">34</span>, <span class="pl-c1">18</span>))
                        .defaultTileset(<span class="pl-smi">CP437TilesetResources</span><span class="pl-k">.</span>wanderlust16x16())
                        .build());
        <span class="pl-k">final</span> <span class="pl-smi">Screen</span> screen <span class="pl-k">=</span> <span
                class="pl-smi">Screens</span><span class="pl-k">.</span>createScreenFor(tileGrid);

        <span class="pl-smi">Panel</span> panel <span class="pl-k">=</span> <span class="pl-smi">Components</span><span
                class="pl-k">.</span>panel()
                .wrapWithBox() <span class="pl-c"><span class="pl-c">//</span> panels can be wrapped in a box</span>
                .title(<span class="pl-s"><span class="pl-pds">"</span>Panel<span class="pl-pds">"</span></span>) <span
                class="pl-c"><span class="pl-c">//</span> if a panel is wrapped in a box a title can be displayed</span>
                .wrapWithShadow() <span class="pl-c"><span class="pl-c">//</span> shadow can be added</span>
                .size(<span class="pl-smi">Sizes</span><span class="pl-k">.</span>create(<span class="pl-c1">32</span>, <span
                class="pl-c1">16</span>)) <span class="pl-c"><span class="pl-c">//</span> the size must be smaller than the parent's size</span>
                .position(<span class="pl-smi">Positions</span><span class="pl-k">.</span>offset1x1())
                .build(); <span class="pl-c"><span
                class="pl-c">//</span> position is always relative to the parent</span>

        <span class="pl-k">final</span> <span class="pl-smi">Header</span> header <span class="pl-k">=</span> <span
                class="pl-smi">Components</span><span class="pl-k">.</span>header()
                <span class="pl-c"><span class="pl-c">//</span> this will be 1x1 left and down from the top left</span>
                <span class="pl-c"><span class="pl-c">//</span> corner of the panel</span>
                .position(<span class="pl-smi">Positions</span><span class="pl-k">.</span>offset1x1())
                .text(<span class="pl-s"><span class="pl-pds">"</span>Header<span class="pl-pds">"</span></span>)
                .build();

        <span class="pl-k">final</span> <span class="pl-smi">CheckBox</span> checkBox <span class="pl-k">=</span> <span
                class="pl-smi">Components</span><span class="pl-k">.</span>checkBox()
                .text(<span class="pl-s"><span class="pl-pds">"</span>Check me!<span class="pl-pds">"</span></span>)
                .position(<span class="pl-smi">Positions</span><span class="pl-k">.</span>create(<span
                class="pl-c1">0</span>, <span class="pl-c1">1</span>)
                        <span class="pl-c"><span class="pl-c">//</span> the position class has some convenience methods</span>
                        <span class="pl-c"><span class="pl-c">//</span> for you to specify your component's position as</span>
                        <span class="pl-c"><span class="pl-c">//</span> relative to another one</span>
                        .relativeToBottomOf(header))
                .build();

        <span class="pl-k">final</span> <span class="pl-smi">Button</span> left <span class="pl-k">=</span> <span
                class="pl-smi">Components</span><span class="pl-k">.</span>button()
                .position(<span class="pl-smi">Positions</span><span class="pl-k">.</span>create(<span
                class="pl-c1">0</span>, <span class="pl-c1">1</span>) <span
                class="pl-c"><span class="pl-c">//</span> this means 1 row below the check box</span>
                        .relativeToBottomOf(checkBox))
                .text(<span class="pl-s"><span class="pl-pds">"</span>Left<span class="pl-pds">"</span></span>)
                .build();

        <span class="pl-k">final</span> <span class="pl-smi">Button</span> right <span class="pl-k">=</span> <span
                class="pl-smi">Components</span><span class="pl-k">.</span>button()
                .position(<span class="pl-smi">Positions</span><span class="pl-k">.</span>create(<span
                class="pl-c1">1</span>, <span class="pl-c1">0</span>) <span
                class="pl-c"><span class="pl-c">//</span> 1 column right relative to the left BUTTON</span>
                        .relativeToRightOf(left))
                .text(<span class="pl-s"><span class="pl-pds">"</span>Right<span class="pl-pds">"</span></span>)
                .build();

        panel<span class="pl-k">.</span>addComponent(header);
        panel<span class="pl-k">.</span>addComponent(checkBox);
        panel<span class="pl-k">.</span>addComponent(left);
        panel<span class="pl-k">.</span>addComponent(right);

        screen<span class="pl-k">.</span>addComponent(panel);

        <span class="pl-c"><span class="pl-c">//</span> we can apply color themes to a screen</span>
        screen<span class="pl-k">.</span>applyColorTheme(<span class="pl-smi">ColorThemes</span><span
                class="pl-k">.</span>techLight());

        <span class="pl-c"><span class="pl-c">//</span> this is how you can define interactions with a component</span>
        left<span class="pl-k">.</span>onMouseReleased((mouseAction <span class="pl-k">-</span><span
                class="pl-k">></span> {
            screen<span class="pl-k">.</span>applyColorTheme(<span class="pl-smi">ColorThemes</span><span
                class="pl-k">.</span>adriftInDreams());
        }));

        right<span class="pl-k">.</span>onMouseReleased((mouseAction <span class="pl-k">-</span><span
                class="pl-k">></span> {
            screen<span class="pl-k">.</span>applyColorTheme(<span class="pl-smi">ColorThemes</span><span
                class="pl-k">.</span>solarizedDarkOrange());
        }));

        <span class="pl-c"><span
                class="pl-c">//</span> in order to see the changes you need to display your screen.</span>
        screen<span class="pl-k">.</span>display();
    }
}

And the result will look like this:

You can check out more examples <a href="https://github.com/Hexworks/zircon/tree/master/zircon.examples/src/main">here</a>. Here are some screenshots of them:

<a id="user-content-tileset-example" class="anchor" aria-hidden="true" href="#tileset-example"> <svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"> <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path> </svg> </a>Tileset example:

<a id="user-content-animations" class="anchor" aria-hidden="true" href="#animations"> <svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"> <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path> </svg> </a>Animations:

<a id="user-content-components-1" class="anchor" aria-hidden="true" href="#components-1"> <svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"> <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path> </svg> </a>Components:

<a id="user-content-additional-features" class="anchor" aria-hidden="true" href="#additional-features"> <svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"> <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path> </svg> </a>Additional features

There are a bunch of other things Zircon can do which are not detailed in this README but you can read about them in either the source code or the <a href="https://github.com/Hexworks/zircon/wiki">Wiki</a>:

<a id="user-content-layering" class="anchor" aria-hidden="true" href="#layering"> <svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"> <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path> </svg> </a>Layering

Note that when creating Layers you can set their offset from the builder but after attaching it to a TileGrid or Screen you can change its position by calling moveTo with a new Position.

<a id="user-content-input-handling" class="anchor" aria-hidden="true" href="#input-handling"> <svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"> <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path> </svg> </a>Input handling

Both the <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/grid/TileGrid.kt">TileGrid</a> and the <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/screen/Screen.kt">Screen</a> interfaces implement <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/behavior/InputEmitter.kt">InputEmitter</a> which means that they re-emit all inputs from your users (key strokes and mouse actions) and you can listen on them. There is a <a href="https://github.com/Hexworks/zircon/wiki/Input-handling">Wiki page</a> with more info.

<a id="user-content-shape-and-box-drawing" class="anchor" aria-hidden="true" href="#shape-and-box-drawing"> <svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"> <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path> </svg> </a>Shape and box drawing

You can draw <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/shape/Shape.kt">Shape</a>s like rectangles and triangles by using one of the <a href="https://github.com/Hexworks/zircon/blob/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api/shape/ShapeFactory.kt">ShapeFactory</a> implementations. Check the corresponding <a href="https://github.com/Hexworks/zircon/wiki/Shapes">Wiki page</a> for more info.

<a id="user-content-fonts-and-tilesets" class="anchor" aria-hidden="true" href="#fonts-and-tilesets"> <svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"> <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path> </svg> </a>Fonts and tilesets

Zircon comes with a bunch of built-in tilesets. These come in 2 flavors:

CP437 tilesets (More on using them <a href="https://github.com/Hexworks/zircon/wiki/Resource-Handling#cp437-tilesets">here</a>)
and Graphic tilesets (Usage info <a href="https://github.com/Hexworks/zircon/wiki/Resource-Handling#graphic-tilesets">here</a>)

Read more about them in the <a href="https://github.com/Hexworks/zircon/wiki/Resource-Handling">resource handling Wiki page</a> if you want to know more or if you want to use your own tilesets and fonts.

Zircon also comes with its own tileset format (ztf: Zircon Tileset Format) which is very easy to use. Its usage is detailed <a href="https://github.com/Hexworks/zircon/wiki/Resource-Handling#graphic-tilesets">here</a>.

<a id="user-content-rexpaint-file-loading" class="anchor" aria-hidden="true" href="#rexpaint-file-loading"> <svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"> <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path> </svg> </a>REXPaint file loading

REXPaint files (.xp) can be loaded into Zircon Layers. Read about this feature <a href="https://github.com/Hexworks/zircon/wiki/Resource-Handling#rexpaint-files">here</a>.

<a id="user-content-color-themes" class="anchor" aria-hidden="true" href="#color-themes"> <svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"> <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path> </svg> </a>Color themes

Zircon comes with a bunch of built-in color themes which you can apply to your components. If interested you can read more about how this works <a href="https://github.com/Hexworks/zircon/wiki/Working-with-ColorThemes">here</a>.

<a id="user-content-animations-beta" class="anchor" aria-hidden="true" href="#animations-beta"> <svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"> <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path> </svg> </a>Animations (BETA)

Animations are a beta feature. More info <a href="https://github.com/Hexworks/zircon/wiki/Animation-support">here</a>.

<a id="user-content-the-api" class="anchor" aria-hidden="true" href="#the-api"> <svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"> <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path> </svg> </a>The API

If you just want to peruse the Zircon API just navigate <a href="https://github.com/Hexworks/zircon/tree/master/zircon.core/src/main/kotlin/org/hexworks/zircon/api">here</a>. Everything which is intended to be the public API is there.

<a id="user-content-road-map" class="anchor" aria-hidden="true" href="#road-map"> <svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"> <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path> </svg> </a>Road map

If you want to see a new feature feel free to <a href="https://github.com/Hexworks/zircon/issues/new">create a new Issue</a> or discuss it with us on <a href="https://discord.gg/hbzytQJ" rel="nofollow">discord</a>. Here are some features which are either under way or planned:

libGDX support
Layouts for Components with resizing support
Components for games like MapDisplay
Multi-Font support
Next to ColorThemes we'll introduce ComponentThemes as well (custom look and feel for your components)

<a id="user-content-license" class="anchor" aria-hidden="true" href="#license"> <svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"> <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path> </svg> </a>License

Zircon is made available under the <a href="http://www.opensource.org/licenses/mit-license.php" rel="nofollow">MIT License</a>.

<a id="user-content-credits" class="anchor" aria-hidden="true" href="#credits"> <svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"> <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path> </svg> </a>Credits

Zircon is created and maintained by Adam Arold, Milan Boleradszki and Gergely Lukacsy

We're open to suggestions, feel free to message us on <a href="https://discord.gg/hbzytQJ" rel="nofollow">Discord</a> or open an issue. Pull requests are also welcome!

Zircon is powered by:

   <a href="https://www.jetbrains.com/idea/" rel="nofollow">
       <img src=""
            width="40" height="40" style="max-width:100%;">
   </a>
   <a href="https://kotlinlang.org/" rel="nofollow">
       <img src=""
            width="40" height="40" style="max-width:100%;">
   </a>
   <a href="https://www.yourkit.com/java/profiler/" rel="nofollow">
       <img src=""
            width="168" height="40" style="max-width:100%;">
   </a>

@@ Line 73: / Line 73: @@
 </table>
-<div>
      <h1>Zircon - A user-friendly Text GUI &amp; Tile Engine <a
              href="https://twitter.com/intent/tweet?text=Do%20you%20plan%20to%20make%20a%20roguelike%3F%20Look%20no%20further.%20Zircon%20is%20the%20right%20tool%20for%20the%20job.&amp;url=https://github.com/Hexworks/zircon&amp;hashtags=games,roguelikes"
@@ Line 1,011: / Line 1,010: @@
               width="168" height="40" style="max-width:100%;">
      </a>
-</div>

Difference between revisions of "Zircon"

Revision as of 10:54, 14 October 2018

Contents

>Table of Contents

Navigation menu

Search