lavat/README.md

48 lines
1.4 KiB
Markdown
Raw Normal View History

2022-10-17 01:06:46 +00:00
# lavat
Little program that simulates a lava lamp in the terminal.
2022-10-17 02:07:11 +00:00
## Installation
2022-10-17 01:06:46 +00:00
2022-10-17 07:21:49 +00:00
Requirements:
A Unix-like system, a C compiler and make.
2022-10-17 02:07:11 +00:00
```
git clone https://github.com/AngelJumbo/lavat
cd lavat
sudo make install
```
2022-10-17 01:06:46 +00:00
## Usage
```
2022-10-17 01:11:32 +00:00
Usage: lavat [OPTIONS]
2022-10-17 01:06:46 +00:00
OPTIONS:
-c COLOR Set color. Available colours: red, blue, yellow, green, cyan and magenta.
Besides those colors the default one is the normal foreground of your terminal.
-s SPEED Set the speed, from 1 to 5. (default 1)
-r RADIUS Set the radius of the metaballs, from 1 to 10. (default: 5)
2022-10-17 02:22:34 +00:00
-R RIM Set a "rim" for each metaball, size from 1 to 5. (default: none)
2022-10-17 01:06:46 +00:00
This option does not work with the default color
-b NBALLS Set the number of metaballs in the simulation, from 2 to 20. (default: 10)
-h Print help.
```
## Demo
`lavat -c red -R 1`
2022-10-17 01:10:00 +00:00
2022-10-17 01:10:37 +00:00
![demo 1](https://github.com/AngelJumbo/lavat/blob/main/demo/1.gif?raw=true)
2022-10-17 01:06:46 +00:00
`lavat -c cyan -R 4 -b 20 -r 2`
2022-10-17 01:10:37 +00:00
![demo 2](https://github.com/AngelJumbo/lavat/blob/main/demo/2.gif?raw=true)
2022-10-17 01:06:46 +00:00
2022-10-17 03:55:25 +00:00
(The cyan isn't quite right because of my color scheme.)
2022-10-17 04:14:24 +00:00
## Credits
2022-10-17 01:06:46 +00:00
- This program was made with [Termbox2](https://github.com/termbox/termbox2).
- [Metaballs](https://en.wikipedia.org/wiki/Metaballs).
2022-10-17 03:52:10 +00:00
- [Lava lamp in JS](https://codeguppy.com/site/tutorials/lava-lamp.html)