https://github.com/poeschl/slowwave

A Pixelflut server with several things to make Pixelflut interesting again.
https://github.com/poeschl/slowwave

pixelflut-server

Last synced: about 2 months ago
JSON representation

A Pixelflut server with several things to make Pixelflut interesting again.

• Host: GitHub
• URL: https://github.com/poeschl/slowwave
• Owner: Poeschl
• Created: 2023-04-18T08:28:18.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-28T21:00:53.000Z (4 months ago)
• Last Synced: 2024-08-28T22:20:55.469Z (4 months ago)
• Topics: pixelflut-server
• Language: Kotlin
• Homepage:
• Size: 196 KB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Slowwave

```text

       _.====.._

     ,:._       ~-_

         `\        ~-_

           |          `.

         ,/             ~-_

-..__..-''                ~~--..__...-

```

A slow Pixelflut server with some other benefits.

## Features

* Not high-performance

* Default [Pixelflut](https://github.com/defnull/pixelflut) commands (`HELP`, `SIZE`, `PX`)

* `OFFSET` command for setting an offset for all `PX` commands on this connection.

* Website at http://localhost:8080 for image output and some stats

* The `TOKEN` command. For more see below.

More coming soon...

### The `TOKEN` command

When the `TOKEN` command is enabled with commandline flag `--token` every `PX` command requires a token to paint.

One token is valid for the ip the request is sent from and will last a specific amount of `PX` calls.

The usage count can be changed with the `--useCountPerToken ` commandline parameter, per default its `100` calls.

To retrieve a token the `TOKEN` command can be called. This command is rate-limited to 1 call per second!

In combination with the use count a rate limit for painting actions per host is established.

All `PX` painting commands must specify an additional parameter, which is the token.

An example flow:

```text

-> PX 1 1 ff0000

<- ERR Invalid Token

-> TOKEN

<- TOKEN a466bb98-492e-4770-a772-b0b477bf26a7 100

#         /\                                   /\

#         ||                                   ||        

#      The token                      Remaining usage count

-> PX 1 1 ff0000 a466bb98-492e-4770-a772-b0b477bf26a7

<- 

```

## Running

The recommended way to run slowwave is a containerized deployment.

Pre-build images can be found in the packages of this project.

For an easy start there is a `docker-compose.yaml` in the repository.

The docker images have versioned tags.

But the `latest` tag points to the latest dev version (this will be the bloody edge)!

## Development

To test the local dev build of slowwave a pixelpawner docker-compose can be found in the `test` folder.

### Release

For a release execute `./gradlew release` locally, it will create a release with version number.