https://github.com/poeschl/pixelflut-challenge-playground

A Pixelflut client which divides the screen into several smaller areas. It is used to solve smaller challenges in those areas.
https://github.com/poeschl/pixelflut-challenge-playground

challenges client pixelflut

Last synced: about 2 months ago
JSON representation

A Pixelflut client which divides the screen into several smaller areas. It is used to solve smaller challenges in those areas.

• Host: GitHub
• URL: https://github.com/poeschl/pixelflut-challenge-playground
• Owner: Poeschl
• License: apache-2.0
• Created: 2020-02-25T07:51:12.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-08-29T07:52:20.000Z (4 months ago)
• Last Synced: 2024-08-29T09:22:20.508Z (4 months ago)
• Topics: challenges, client, pixelflut
• Language: Kotlin
• Size: 115 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Pixelflut Challenge Playground 

This application draws a grid on a [Pixelflut server](https://github.com/defnull/pixelflut) intended to solve several challenges.

It has been used on last years [Hacky Easter](https://github.com/HacktoberfestMunich/Hacky-Easter-2019) and will be reused for following events.

![Challenge Playground](https://raw.githubusercontent.com/Poeschl/Pixelflut-Challenge-Playground/master/docs/grid.png)

## Usage

First download the latest runnable jar from the [release page](https://github.com/Poeschl/Pixelflut-Challenge-Playground/releases).

It can also build on your machine, for that see the [section below](#build).

Execute the jar like the snippet below to start it up.

```shell script

java -jar Pixelflut Challenge Playground-1.0.0.jar --host 127.0.0.1

```

There are some parameters which configure the application:

`--host`: The host of the pixelflut server.

`--port` or `-p`: The port of the pixelflut server (default: `1234`)

`--controlport` or `-c`: The port for the rest commands for clearing areas. (default: `4321`)

### CLI Interface

The CLI gives you following options for interaction.

```shell script

Available commands:

quit -> Quit application

blank -> Wipes the whole screen

blank center-> Wipes the centered challenge area

blank  -> Wipes one playground (left to right starting at 0 from top left)

blank   -> Wipes one playground sector (sector are counted clockwise, starting top left)

```

### Rest Interface

The application can also be controlled via GET calls. Following endpoints are available:

`/ping`: Just a ping

`/blank/center`: Wipes out the center area.

`/blank/`: Wipes out a playground (same as `blank ` from CLI) 

`/blank//`: Wipes out one playground sector (same as `blank  ` from CLI) 

## Build

To build the application yourself, clone it to your machine first.

To create the executable jar execute this command inside the repository folder `./gradlew shadowJar` and the artifact will be build.

It can be found under `build/libs/*.jar`.