README.md

Kixelflut

A Pixelflut interface for Java and Kotlin written in Kotlin.

Installation

Kixelflut is available via Maven Central, so copy one of the snippets below into your maven or gradle project and it will be installed.

dependencies {
    implementation 'xyz.poeschl:Kixelflut:{version}'
}

To use it in a maven project add this in the pom.xml:

</project>
    ...    
    <dependencies> 
        <dependency>
          <groupId>xyz.poeschl</groupId>
          <artifactId>Kixelflut</artifactId>
          <version>{version}</version>
          <type>pom</type>
        </dependency>
    </dependencies>
</project>

Usage

The Pixelflut interface is located in the Pixelflut class. There are the basic commands of the protocol.

Additional utils for drawing lines or areas can be found in DrawUtils.

To get yourself going fast the Painter class is a nice way to inherit. For examples take a look at the Mazedrawer classes.

The interface uses KotlinLogging for logging output and will put it to any slf4j logger available.