https://github.com/poeschl/pixel-recorder

A snapshot recorder operating on the Pixelflut protocol.
https://github.com/poeschl/pixel-recorder

dumper image-processing kotlin pixelflut pixelflut-client

Last synced: about 2 months ago
JSON representation

A snapshot recorder operating on the Pixelflut protocol.

• Host: GitHub
• URL: https://github.com/poeschl/pixel-recorder
• Owner: Poeschl
• License: apache-2.0
• Created: 2019-04-16T06:32:40.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-06-12T13:58:42.000Z (over 1 year ago)
• Last Synced: 2023-08-22T00:46:34.825Z (over 1 year ago)
• Topics: dumper, image-processing, kotlin, pixelflut, pixelflut-client
• Language: Kotlin
• Homepage:
• Size: 255 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Pixel-Recorder

A [PixelFlut](https://github.com/defnull/pixelflut) canvas dumper written in Kotlin.

It connects to a running Pixelflut server and takes a one-time or periodic snapshot of the canvas. This way snapshots can be made on a event

for example (as done on rC3).

## Commandline parameters

Example:

```shell

java -jar /app/pixel-recorder.jar --host 123.456.789.123 single

docker run ghcr.io/poeschl/pixel-recorder --host 123.456.789.123 single

```

To get a programmatic argument help use `--help` as parameter.

### Mode

The mode must be one of `single` or `record`. (Default: `single`)

`Single` takes one full snapshot and exits.

`Record` will make continious snapshots every 10 seconds (period can be changes with `--period`).

### `--host `

Specify the host of the targeted Pixelflut server. (Default: `localhost`)

### `-p`, `--port `

Specify the port of the targeted Pixelflut server. (Default: `1234`)

### `-c`, `--connections `

Specify number of used connections. (Default: `3`)

### `--period`

Sets the period in seconds for snapshots on `record` mode. (Default: `10`)

### `-d`, `--debug`

Enables the debugging log output

## Docker

The application can also be run as docker container.

To execute the docker container run `docker run ghcr.io/poeschl/pixel-recorder `. All the generated files are

created in the `/app/output` folder. To access it, create a volume mapping. A sample docker-compose is available in the repository.