lavat/README.md

63 lines
2.1 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-18 02:51:50 +00:00
![demo](https://github.com/AngelJumbo/lavat/blob/demo/demo/3.gif?raw=true)
2022-10-17 02:07:11 +00:00
## Installation
2022-10-17 01:06:46 +00:00
2022-10-17 16:41:09 +00:00
Requirements: A Unix-like system, a C compiler and make.
2022-10-17 07:21:49 +00:00
2022-10-17 02:07:11 +00:00
```
git clone https://github.com/AngelJumbo/lavat
cd lavat
2022-10-17 21:14:26 +00:00
make install
2022-10-17 02:07:11 +00:00
```
2022-10-17 09:13:39 +00:00
### Arch Linux
2022-10-17 12:20:49 +00:00
Lavat is also available on the AUR [here](https://aur.archlinux.org/packages/lavat-git). Install it with your favourite AUR-helper or manually.
2022-10-17 09:13:39 +00:00
```
$ paru -S lavat-git
```
2022-10-17 01:06:46 +00:00
## Usage
```
2022-10-18 03:53:24 +00:00
Usage: lavat [OPTIONS]
2022-10-17 01:06:46 +00:00
OPTIONS:
2022-10-21 22:53:39 +00:00
-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)
-R <RIM> Set a rim for each metaball, sizes from 1 to 5.(default: none)
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)
-F <CHARS> Allows for a custom set of chars to be used
Only ascii symbols are supported for now, wide/unicode chars may appear broken.
-C Retain the entire lava inside the terminal.
2022-10-21 22:56:21 +00:00
It may not work well with a lot of balls or with a bigger radius than the default one.
2022-10-21 22:53:39 +00:00
-h Print help.
2022-10-17 01:06:46 +00:00
```
2022-10-18 02:36:34 +00:00
2022-10-17 01:06:46 +00:00
## Demo
`lavat -c red -R 1`
2022-10-17 01:10:00 +00:00
2022-10-18 02:51:50 +00:00
![demo 1](https://github.com/AngelJumbo/lavat/blob/demo/demo/1.gif?raw=true)
2022-10-17 01:06:46 +00:00
`lavat -c cyan -R 4 -b 20 -r 2`
2022-10-18 02:51:50 +00:00
![demo 2](https://github.com/AngelJumbo/lavat/blob/demo/demo/2.gif?raw=true)
2022-10-17 01:06:46 +00:00
2022-10-18 02:36:34 +00:00
If you send more than one character to the -F option you can have 3d-ish effect.
`lavat -c blue -R2 -F @@:::::: -r10`
2022-10-18 02:36:34 +00:00
2022-10-18 02:51:50 +00:00
![demo 2](https://github.com/AngelJumbo/lavat/blob/demo/demo/4.gif?raw=true)
2022-10-18 02:36:34 +00:00
2022-10-18 02:58:59 +00:00
(The colors depend on your color scheme.)
2022-10-17 03:55:25 +00:00
2022-10-17 04:14:24 +00:00
## Credits
2022-10-17 01:06:46 +00:00
2022-10-17 16:33:34 +00:00
- This program is made with [Termbox2](https://github.com/termbox/termbox2).
2022-10-17 01:06:46 +00:00
- [Metaballs](https://en.wikipedia.org/wiki/Metaballs).
2022-10-18 02:36:34 +00:00
- [Lava lamp in JavaScript](https://codeguppy.com/site/tutorials/lava-lamp.html)