https://github.com/poeschl/kixelflut

A Pixelflut wrapper for Kotlin and Java
https://github.com/poeschl/kixelflut

java kotlin pixelflut

Last synced: about 8 hours ago
JSON representation

A Pixelflut wrapper for Kotlin and Java

• Host: GitHub
• URL: https://github.com/poeschl/kixelflut
• Owner: Poeschl
• License: apache-2.0
• Created: 2020-02-23T18:30:23.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-05-01T10:38:42.000Z (over 1 year ago)
• Last Synced: 2024-11-24T01:12:11.199Z (2 months ago)
• Topics: java, kotlin, pixelflut
• Language: Kotlin
• Homepage:
• Size: 121 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Kixelflut [![Push tests](https://img.shields.io/github/actions/workflow/status/Poeschl/Kixelflut/master-check.yaml?branch=master)](https://github.com/Poeschl/Kixelflut/actions)

A [Pixelflut](https://github.com/defnull/pixelflut) interface for Java and Kotlin written in Kotlin.

## Installation

[![Latest version](https://img.shields.io/maven-central/v/xyz.poeschl/Kixelflut)](https://search.maven.org/artifact/xyz.poeschl/Kixelflut)

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

```groovy

dependencies {

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

}

```

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

```xml

    ...    

     

        

          xyz.poeschl

          Kixelflut

          {version}

          pom

        

    

```

## 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](https://github.com/Poeschl/PixelMaze/blob/master/src/main/kotlin/io/github/poeschl/pixelflutmaze/labyrinth/LabyrinthDrawer.kt).

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