lavat

Un fork de lavat pour pouvoir y ajouter des titres - retour accueil

git clone git://bebou.netlib.re/lavat
Log | Files | Refs | README | LICENSE |

README.md (3486B)


      1 # lavat
      2 
      3 Little program that simulates a lava lamp in the terminal.
      4 ![demo](https://github.com/AngelJumbo/demos/blob/main/lavat/3.gif?raw=true)
      5 ## Installation
      6 
      7 Requirements: A Unix-like system, a C compiler and make.
      8 
      9 ```
     10 git clone https://github.com/AngelJumbo/lavat
     11 cd lavat
     12 make install
     13 ```
     14 
     15 ### Arch Linux
     16 Lavat is also available on the AUR [here](https://aur.archlinux.org/packages/lavat-git). Install it with your favourite AUR-helper or manually.
     17 ```
     18 $ paru -S lavat-git
     19 ```
     20 ## Usage
     21 
     22 ```
     23 Usage: lavat [OPTIONS]
     24 OPTIONS:
     25   -c <COLOR>          Set color. Available colours: red, blue, yellow, green, cyan, magenta, white and black.
     26   -s <SPEED>          Set the speed, from 1 to 10. (default 5)
     27   -r <RADIUS>         Set the radius of the metaballs, from 1 to 10. (default: 5)
     28   -R <RIM>            Set a rim for each metaball, sizes from 1 to 5.(default: none)
     29                       This option does not work with the default color
     30                       If you use Kitty or Alacritty you must use it with the -k option to see the rim.
     31   -k <COLOR>          Set the color of the rim if there is one. Available colours: red, blue, yellow, green, cyan, magenta, white and black.
     32   -b <NBALLS>         Set the number of metaballs in the simulation, from 5 to 20. (default: 10)
     33   -F <CHARS>          Allows for a custom set of chars to be used
     34                       Only ascii symbols are supported for now, wide/unicode chars may appear broken.
     35   -C                  Retain the entire lava inside the terminal.
     36                       It may not work well with a lot of balls or with a bigger radius than the default one.
     37   -p <MODE>           PARTY!! THREE MODES AVAILABLE (p1, p2 and p3).
     38   -h                  Print help.
     39 RUNTIME CONTROLS:
     40   i                   Increase radius of the metaballs.
     41   d                   Decrease radius of the metaballs.
     42   shift i             Increase rim of the metaballs.
     43   shift d             Decrease rim of the metaballs.
     44   m                   Increase the number of metaballs.
     45   l                   Decrease the number metaballs.
     46   c                   Change the color of the metaballs.
     47   k                   Change the rim color of the metaballs.
     48   +                   Increase speed.
     49   -                   Decrease speed.
     50   p                   TURN ON THE PARTY AND CYCLE THROUGH THE PARTY MODES (it can also turns off the party).
     51 (Tip: Zoom out in your terminal before running the program to get a better resolution of the lava).
     52 ```
     53 
     54 ## Demo
     55 
     56 `lavat -p3`
     57 
     58 ![demo 1](https://github.com/AngelJumbo/demos/blob/main/lavat/6.gif?raw=true)
     59 
     60 PARTY MODE!!!
     61 
     62 `lavat -c red -R 1`
     63 
     64 ![demo 1](https://github.com/AngelJumbo/demos/blob/main/lavat/1.gif?raw=true)
     65 
     66 
     67 `lavat -c cyan -R 4 -b 20 -r 2`
     68 
     69 ![demo 2](https://github.com/AngelJumbo/demos/blob/main/lavat/2.gif?raw=true)
     70 
     71 If you send more than one character to the -F option you can have 3d-ish effect.
     72 
     73 `lavat -c blue -R2 -F @@:::::: -r10`
     74 
     75 ![demo 2](https://github.com/AngelJumbo/demos/blob/main/lavat/4.gif?raw=true)
     76 
     77 For the Alacritty and Kitty users I know that the -R option haven't been working for you, but now you can set the color of the rim independently. Try:
     78 
     79 `lavat -c yellow -R1 -k red`
     80 
     81 ![demo 2](https://github.com/AngelJumbo/demos/blob/main/lavat/5.gif?raw=true)
     82 
     83 (The colors depend on your color scheme.)
     84 
     85 ## Credits
     86 
     87   - This program is made with [Termbox2](https://github.com/termbox/termbox2).
     88   - [Lava lamp in JavaScript](https://codeguppy.com/site/tutorials/lava-lamp.html)