DeltaLima/pixelfloot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

change help text , README

Browse source
This commit is contained in:
Marcus 2024-01-02 03:34:25 +01:00
parent 9ee1945b76
commit 504c795e02
1 changed files with 16 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -5,28 +5,30 @@ Origin: https://git.la10cy.net/DeltaLima/pixelfloot
an very simple and dirty pixelflut client to draw images, written in bash. an very simple and dirty pixelflut client to draw images, written in bash.
pixelfloot was built during the 37c3. in its actual state, its just a mess. I hope i will find time to put it in a more usable and readable format. pixelfloot was built during the 37c3. in its actual state, its just a mess. I hope i will find time to put it in a more usable and readable format.
## image format
you need an uncompress ppm image at first. it is not allowed to be larger then 200px.
convert it like so: `convert lol.jpg -compress none -resize 200x200 lol.ppm`
after you have converted it to ppm, you need to convert it to a "pixel-list".
do it with `./pixelfloot_bash.sh convertimg lol`
Have a look to the example .pixlist files
## examples ## examples
Display image: `./pixelfloot_bash.sh floot lol` Display image: `./pixelfloot_bash.sh floot images/lucky-cat.jpg`
image random position: `./pixelfloot_bash.sh floot images/lucky-cat.jpg chaos` image random position: `./pixelfloot_bash.sh floot images/lucky-cat.jpg chaos`
wider "chaos-radio": `W=1000 H=600 ./pixelfloot_bash.sh floot images/lucky-cat.jpg chaos`
image shake position: `SHUFMODE=shake ./pixelfloot_bash.sh floot images/lucky-cat.jpg shake` image shake position: `./pixelfloot_bash.sh floot images/lucky-cat.jpg shake`
set the position : `W=420 H=420 ./pixelfloot_bash.sh floot images/lucky-cat.jpg shake`
move image with your cursor (needs `xdotool`): `./pixelfloot_bash.sh floot images/lucky-cat.jpg cursor` move image with your cursor (needs `xdotool`): `./pixelfloot_bash.sh floot images/lucky-cat.jpg cursor`
Use a color as "alpha" (remove background): `ALPHACOLOR=FF00FF ./pixelfloot_bash.sh floot images/cursor.ppm cursor` Use a color as "alpha" (remove background): `ALPHACOLOR=FF00FF ./pixelfloot_bash.sh floot images/cursor.ppm cursor`
increase No of cuncurrent connections: `FLOOTFORKS=8 ./pixelfloot_bash.sh floot images/lucky-cat.jpg`
```shell
$ ./pixelfloot_bash.sh help
./pixelfloot_bash.sh [floot|convertimg] [FILENAME|fill] ([MODE])
MODE: static (env $H and $W for position)
chaos (env $H and $W for position range)
shake (env $H and $W for position range)
cursor
available env vars to configure:
RESIZE(int), ALPHACOLOR(hex), FLOOTFORKS(int), H(int), W(int)
```